Run Jobs in a Batch

To run multiple jobs in a batch, you first need to create the batch, and then create the jobs that will be added to the batch. Once all of the jobs have been added, you can start the batch.

This workflow can be automated with the command-line interface (CLI). The relevant CLI commands for each task are noted below.

Create a Batch

Follow these steps to create a new batch:

  1. Go to Batches and click Create Batch in the upper right.

  2. Enter a name for the batch.

  3. Click Create Batch.

When the batch is created, the Batch Details page will open. This page is mostly empty, because you haven’t added any jobs yet. Note that some details, such as Mode and Stop on Failure, initially display default values. You will have an opportunity to change those settings when you start the batch.

To create a batch with the CLI instead of in the web interface, use the batch:create command.

Add Jobs to a Batch

Once you have created a batch, you can create new jobs to add to the batch. You cannot add jobs that are already created.

Follow the usual process for creating jobs. Make sure you select your batch in the Details > Optional Batch field—this is how the job is added to the batch. You can add up to 100 jobs per batch. Each job will be assigned an order in the batch based on when it was created (1 for the first job created, 2 for the second job created, and so forth). If you plan to run the jobs sequentially (i.e., in serial), create the jobs in the order you want them to run.

Each job you add to the batch will be created with an initial status of Batched. CONVERGE Horizon will not request hardware for Batched jobs until you start the batch.

To add jobs to the batch with the CLI instead of in the web interface, use the job:create command with the --batch_id option.

Start a Batch

When you are done adding jobs to a batch, follow the steps below to start the batch. You will not be able to add more jobs to the batch after it has started.

  1. Go to Batches and click on the name of the batch to open the Batch Details page.

  2. Review the list of jobs in the batch to confirm that jobs have been added correctly. If you plan to run the jobs in serial, make sure the order of the jobs is correct.

  3. Click Start Batch in the lower right.

    • By default, the jobs will run in parallel, meaning they will be added to the queue at the same time (the actual start times may differ depending on how long it takes to acquire hardware for each job). Check Run jobs in serial if you want to run jobs in the order in which they were created. In serial mode, each job is added to the queue only after the previous job has stopped.

    • By default, the failure of one job does not affect other jobs in the batch. Check Stop batch on first failure if you want to stop all jobs in the batch if one job fails.

To start batches with the CLI instead of in the web interface, use the batch:start command.