Configure error handling in operations in Jitterbit Studio
Introduction
Every production integration should have a defined response to failure. Studio operations support this through the Actions tab in operation settings, where you configure what happens when an operation succeeds, fails, or encounters a SOAP fault (for example, triggering a cleanup operation, chaining downstream processing, or notifying a team by email).
This guide covers three common error-handling patterns using the Actions tab:
- Running a fallback or cleanup operation when an operation fails.
- Chaining a downstream operation when an operation succeeds.
- Sending an email notification on failure.
It also covers the On SOAP Fault condition, which applies to operations using SOAP or Salesforce-based connectors.
For a complete description of all available conditions and action types, see Operation actions.
For configuring actions in a script rather than through the UI (for example, to use RunOperation with GetLastError to capture and accumulate error details), see Chain and control operations.
Part 1: Run a cleanup or fallback operation on failure
Use the On Fail condition to trigger a secondary operation when the primary operation fails. This is typically used to undo partial writes, alert a downstream system, or run a compensating transaction.
Before starting, create the fallback or cleanup operation in your project. It does not need to be deployed.
-
On the design canvas, right-click the operation and select Settings to open the operation settings.
-
Select the Actions tab.
-
Condition: Select On Fail.
-
Action: Select Run Operation.
-
Operation: Select the fallback operation from the dropdown. The dropdown lists all operations in the project that are not already associated with an action for this condition.
-
Click Add Action.
The fallback operation appears as a linked operation on the design canvas connected to the primary operation by a line.
Note
You can add at most one Run Operation action and one Send Email Notification action per condition. To trigger multiple downstream operations, chain them together: configure the first fallback operation to run a second operation on its own success or failure.
Part 2: Chain a downstream operation on success
Use the On Success condition to trigger a downstream operation after the primary operation completes successfully. This is the standard way to build an operation chain where each step depends on the one before it.
-
On the design canvas, right-click the operation and select Settings to open the operation settings.
-
Select the Actions tab.
-
Condition: Select On Success.
-
Action: Select Run Operation.
-
Operation: Select the downstream operation from the dropdown.
-
Click Add Action.
The downstream operation appears as a linked component on the design canvas.
Tip
If the primary operation may not find any source files to process (for example, when reading from an FTP server that sometimes has no new files), the On Success action will not fire by default. To force the downstream operation to run regardless, enable Run success Operation even if there are no matching source files on the operation's Options tab. See Operation options for details.
Part 3: Send an email notification on failure
An On Fail action can send an email notification to alert a team when an operation fails. This requires an email notification component to be configured in the project.
For the complete walkthrough (including creating the email notification component and attaching it as an operation action), see Send an email notification from a Studio operation, Part 2.
To attach an existing email notification as an On Fail action:
-
Open the operation's Actions tab.
-
Condition: Select On Fail.
-
Action: Select Send Email Notification.
-
Email Notification: Select the notification from the dropdown, or click Create New Email Notification to configure one now.
-
Click Add Action.
You can combine an On Fail / Run Operation action and an On Fail / Send Email Notification action on the same operation. Both fire when the operation fails.
Part 4: Handle SOAP faults
The On SOAP Fault condition fires when a SOAP fault is returned (that is, an error in the structure or processing of a SOAP message, distinct from a general operation failure). This condition is available only for operations that include a SOAP activity or an activity from the Salesforce, Salesforce Service Cloud, or ServiceMax connectors.
For all other operation types, On Fail covers failure conditions. If the On SOAP Fault condition is not configured, SOAP faults are treated as general failures and trigger any configured On Fail action instead.
To configure an action for SOAP faults:
-
Open the operation's Actions tab.
-
Condition: Select On SOAP Fault.
-
Action: Select Run Operation or Send Email Notification.
-
Complete the remaining dropdowns and click Add Action.
Tip
Configure both On Fail and On SOAP Fault actions on Salesforce operations when you want distinct handling for each failure type (for example, a notification with different messaging, or a different remediation operation).
Verify the integration
Deploy and run the operation, then trigger each condition you have configured. To verify an On Fail action, introduce a deliberate failure on the first run (for example, by pointing the operation at a non-existent endpoint or providing invalid credentials temporarily). To verify an On Success action, confirm the downstream operation appears in the operation logs immediately after the primary operation completes. Check the logs to confirm that each configured action executed and that no additional errors were raised by the triggered operations. Remove any deliberate failures before deploying to production.