Batch Runner

Sliderule's Batch Runner is a great way to run many executions at a time, to test out your workflows or for making large numbers of decisions in asynchronous "batches".

Through the Batch Runner tab in Sliderule, you can create a Job to run a CSV of inputs through your workflow. The CSV should be organized with column headers that match the expected input fields for your workflow. Each row will then be used as the input for an execution.

For example, you could upload a csv like input.csv below:

user_idamountip_address
130011.111.1111
240011.111.1111
375011.111.1111

The job would run your workflow 3 times, and the result would be an updated csv including the output from the specified workflow and version.

Running a job

From the Batch Runner tab in Sliderule, click Create Job and specify a Workflow and Version. Upload your CSV of inputs here, and notice any warnings on missing columns. When you're ready, kick off your new job.

Once a job is added to the queue, you'll see it listing as Pending or Running in the table. When the Status changes to Done, you'll see a download link to download your results spreadsheet.

Note: the Batch Runner is designed to run in the background, so jobs won't affect the performance of your live workflows. This means they won't run as quickly as the production versions of your workflows, and shouldn't be used for high speed situations or testing.

Running Batches via API

🚧

Beta Feature

Document and Job APIs are both in Beta. Contact your Support team if you run into any issues

You can also create batch jobs using our APIs. This process requires 4 API calls:

  1. Documents API to upload a CSV

    • POST request to /v1/document
    • Set Content-Type to application/octet-stream, and include your CSV in the Body
    • Documents API will return a documentId for the uploaded CSV file
  2. Jobs API to create a new job

    • POST request to /api/user_job
    • Include the documentId from Step 1, as well as configuration for the job
  3. Jobs API to check status (optional)

    • GET request to /v1/runner_job/{id} using the id returning in step 2
  4. Documents API to download results from finished job (optional)

    • Once calls from step 3 return a STATUS of "done", then grab the outputDocumentId
    • GET request to /v1/document/{id}/download to retrieve the output CSV

Did this page help you?