Skip to end of metadata
Go to start of metadata

To call or trigger a Jitterbit operation from a command line or from a batch script, you can call an operation using either its name or its GUID using this syntax:

On a Jitterbit Windows Private Agent:

  > JitterbitUtils --add-operation-to-queue <operation> [--project <project_name> --environment <environment_name>]

On a Jitterbit Linux Private Agent:

  $ sudo /opt/jitterbit/bin/jitterbit-utils --add-operation-to-queue <operation> [--project <project_name> --environment <environment_name>]

Where:

  • <operation>: An operation name or an operation GUID
  • <project_name>: A project name (optional)
  • <environment_name>: An environment name (optional)

Notes:

  • On Windows, the JitterbitUtils executable is located in the <Jitterbit_Home>\bin directory. Substitute the directory in which Jitterbit is installed on your system for <Jitterbit_Home>
  • On Linux, the jitterbit-utils executable is located in the <Jitterbit_Home>/bin directory. Substitute the directory in which Jitterbit is installed on your system for <Jitterbit_Home>
  • The Jitterbit_Home environment variable is (by default) set to:
    • Windows agent: C:\Program Files (x86)\Jitterbit Agent
    • Linux agent: /opt/jitterbit
  • Substitute the name or GUID of the operation for <operation>.
  • To obtain the GUID of an operation in Design Studio, clicking the white triangle menu item in the upper right corner of the operation panel, then clicking "Additional Details" on the menu that pops up:


    "Additional Details" displays a dialog with the GUID in it.
  • To obtain the GUID of an operation in Cloud Studio, see the instructions in Cloud Studio Operation Deployment and Execution.
  • The operation will not start right away, but will be queued to be processed by the Jitterbit Harmony Process Engine.
  • If the operation is passed by name instead of by GUID, Jitterbit searches for the operation in the current organization. The first matching operation found will be used. You can use additional flags to the command (--project and --environment) to pass in a project or environment by name and constrain the searches appropriately so that duplicate names are resolved correctly.

Last updated:  Oct 31, 2019