Operations are used to collect all the information needed to define exactly what a particular integration process does and when it should start. This page walks through the process of creating, configuring, validating, and saving a new operation.
NOTE: Before you can create an operation, you must have completed the following:
- Set up an Environment through the Web Management Console.
- Set up a project through Jitterbit Studio (Getting Started > New Project) that uses your Environment.
Begin a New Operation
Within your project within Jitterbit Studio, there are several ways to start a new operation:
In the Getting Started tab, click the Create a New Integration button.
In the Project Explorer on the left, right-click on Operations and select New Operation.
In the top toolbar, click the Operation gear icon.
Go to File > New > New Operation.
Select an Operation Activity
After you begin a new operation, in the popup you will need to select the type of Operation Activity you want to create.
Core Activity Types
The first four activity types are the core activities available within Jitterbit:
Transformation - Manipulate or change data as it passes from a source to a target system. Transformation is the default operation type. See Transformations for steps to create different kinds of transformations.
Script - Run a sequence of scripts without sources, targets, or transformations. See Scripting for more information.
Archive - Move files from one location to another. No transformation or manipulation of the file occurs between the source and target systems. You only need to select a file source and a file target.
Web Service Call - Used to simplify SOAP-based web service calls, with the option to use a request transformation between the source and web service call, and/or a response transformation between the web service call and the target. See Calling a Web Service for more details.
Other Activity Types
Beyond the core activity types, other available activity types include:
Hosted Web Service - Used in addition to a web service call with one transformation to process the web service request and another to process the response. See Creating a Hosted Web Service for more information.
API Entity Operation - Set up a Jitterbit Entity from a database or SAP, with the option to set up custom mappings using request and response transformations. See Harmony LIVE API Platform for more on API configuration.
XSLT Operation - Set up an operation using the XSLT plugin.
Finally, all of Jitterbit's Connectors have associated operation activities using those connectors. Click on the connector below for Jitterbit Success resources on each.
Configure the Operation
Your new empty operation should now appear in its own New Operation tab in the right pane of the window. You can double-click on the words "New Operation" within the operation to rename the operation.
The following show the default components of the operation for each core activity type: Transformation, Script, Archive, and Web Service Call.
You will need to further configure each component in your operation. To do this, you can either double-click each component in the operation, or click and drag components that are already set up from the Project Explorer onto the specific component in the Operations tab.
For more information on setting up the operation components for the core activity types, refer to the following:
Operation Actions and Configuration
You can also access a menu from the Operations tab by either clicking the down arrow next to your operation name, or by right-clicking anywhere on the background of the operation. The menu includes the following operation actions and configurable options.
- Deploy - Deploys the operation to your Environment.
- Run Operation - Places the operation in the queue for execution.
- Run With Source Data - This option is currently disabled.
- Rename - Opens edit mode to change the title of the operation.
- View Dependencies - Shows other components in your project that your operation is dependent on, or that are dependent on your operation. This option is useful to check if you need to delete a component from an operation but are unable to because it has dependencies.
- Locate In Tree - Highlights the operation in the Project Explorer. May be useful as a reference point if you have a large project with many items.
- On Success - Sets up a new operation or email to trigger upon successful execution of the operation.
- On Failure - Sets up a new operation or email to trigger upon failed execution of the operation.
- Schedule - Sets up a schedule for when your operation runs. See Creating a Schedule for configuration options.
- Operation Log - Shows logs for your operation. May be useful for troubleshooting efforts. See Reviewing an Operation Log for more details.
- Operation Queue - Allows management of the operations currently in the execution queue. For more detail see Checking Pending Operations.
- View Validation Messages - Shows any messages for invalid operations. This option will be disabled if your operation is valid. Otherwise, check here for any messages about why the operation could not validate.
- View Description - Opens a box to view or add a description for your operation.
- Options - Opens a window where you can specify further configuration options such as timeout, what to log, debug mode, and chunking. See Operation Options for detailed information on each parameter.
- Layout - Resets the operation graph layout or allows you to change the node coordinates to have more control over the layout.
- Remove From Graph - Removes a selected node from the operation graph.
- Collapse - Collapses the operation by hiding the operation components.
Validate the Operation
If the status in the upper right of your Operations tab reads Valid then your operation has already been validated.
If the status reads Invalid, you can check any validation errors under View > Project Validation. This will bring up the Validation tab below your operation screen. From there you can select items in the tree to see any validation problems.
Save the Operation
Finally, click the Save button in the top right of the Operations tab. The name of your newly saved operation will appear under the Operations part of the Project Explorer.