Common Integration Procedure Action Properties (Managed Package)

For the managed package runtime, to compose an Integration Procedure, you add a sequence of actions. To configure an action, you set the action's properties. Standard properties that exist in most or all actions are listed here. All properties are of the String data type unless otherwise noted.

Managed Package app icon This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.

For details about the properties of specific actions, see the topics for the actions.

Property

Description

Element Name

Label of script element

Send JSON Path

Trims the incoming JSON to the specified path before the action is executed. See Manipulate JSON with the Send/Response Transformations Properties (Managed Package).

Send JSON Node

Reparents the incoming JSON under the specified node. See Manipulate JSON with the Send/Response Transformations Properties (Managed Package).

Response JSON Path

After the action is executed, trims the output JSON to the specified path. See Manipulate JSON with the Send/Response Transformations Properties (Managed Package).

Response JSON Node

Reparents the output JSON under the specified node. To delimit the path, use colons; for example, level1:level2:level3. See Manipulate JSON with the Send/Response Transformations Properties (Managed Package).

Send Only Additional Input

If checked, accepts only the data in the Additional Input property.

Additional Input

Additional key-value pairs to be included in the input JSON data. Values can include formulas and merge fields.

Return Only Additional Output

If checked, returns only the data in the Additional Output property.

Additional Output

Additional key-value pairs to be returned in the output JSON data. Values can include formulas and merge fields.

Send Only Failure Response

If checked, returns only the Failure Response if the action fails.

Failure Response

Key-value pairs to be returned in the output JSON data if the action fails. Values can include formulas and merge fields.

Execution Conditional Formula

Specifies a formula that runs before the step is executed. If the formula returns TRUE, the step is executed. If the formula returns FALSE, the step isn't executed. If no formula is specified, the step is executed.

Failure Conditional Formula

Specifies a custom failure condition that runs after the step is executed.

For example, the Omnistudio Data Mapper Extract Action failing to find any records isn't normally considered an error. But you can use a Failure Conditional Formula to specify this condition. See the second example under Handle Errors Using Try-Catch Blocks (Managed Package).

If the formula returns TRUE, execution of the step has failed and any key-value pairs configured in the Failure Response list are added to the JSON data. For example, if this JSON is returned:

{
  "Result": {
    "ErrorCode": "ERR-123",
    "Success": "FALSE"
    }
}

These settings identify the error and add the error code to the JSON data:

  • Failure Conditional Formula: Result:Success == 'FALSE'

  • Failure Response:

    • Key: ErrorCode

    • Value: %StepName:Result:ErrorCode%

Fail On Step Error

If set to TRUE, the Integration Procedure ends if this step fails.

Chain On Step

Allows the action to run in its own Salesforce transaction. This property can slow performance but decreases the likelihood of exceeding the Salesforce governor limits. For more information, see Settings for Long-Running Integration Procedures (Managed Package).

Additional Chainable Response

Specifies a key-value pair that is sent in the response. The value field accepts merge field syntax.

Action Message

Sends a message to the user if this Action Message is the first in the Integration Procedure or if this action is chained. Useful for long-running actions.

Internal Notes

Descriptive text that's visible only to designers of the Integration Procedure.