Salesforce actions

Query action

A query action executes a Salesforce Object Query Language (SOQL) query that may return many objects. Each resulting object is generated one-by-one. Use SOQL to search your organization’s Salesforce data for specific information. SOQL is similar to the SELECT statement in the widely used Structured Query Language (SQL) but is designed specifically for Salesforce data. An action allows you to interact with your data using SOQL. If the query does not find any data, an empty object is returned.

Query action

Input fields description

  • Include deleted - A checkbox, which if selected, includes deleted records in the result list.

  • Optional batch size - A positive integer specifying batch size. If no batch size is specified then results of the query will be generated one-by-one. Otherwise, query results are generated in an array of maximum batch size.

  • Allow all results to be returned in a set - A checkbox, which if selected, allows query results to be generated in a single array. The Optional batch size option is ignored in this case.

  • SOQL Query - Input field where the SOQL query should be entered. E.g. "SELECT ID, Name from Contact where Name like 'John Smi%'"

  • Max Fetch Count - Limit for a number of messages that can be fetched. When the variable is not set, the default value is 1,000.

Create Object action

Creates a new Selected Object. This action creates a single object.

  • The input metadata is fetched dynamically from your Salesforce account.

  • The output metadata is the same as the input metadata, so you may expect all fields that you mapped as input to be returned as output.

Create Object action
In case of an Attachment object type you should specify Body in base64 encoding. ParentId is a Salesforce ID of an object (Account, Lead, Contact) which an attachment is going to be attached to.

Input fields description

  • Object - Input field to choose the object type you want to find. E.g. Account

  • Utilize data attachment from previous step (for objects with a binary field) - A checkbox, which if selected, and the input message contains an attachment and the specified object has a binary field (type of base64), then the input data is placed into object’s binary field. In this case, any data specified for the binary field in the data mapper is discarded.

This action automatically retrieves all existing fields of the chosen object type available in your Salesforce organization.

Delete Object action (at most 1)

Deletes an object by a selected field. You can filter by either unique fields or all fields of that object. The input metadata is fetched dynamically from your Salesforce account.

Delete Object action (at most 1)

Input field description

  • Object - choose the object type you want to find from this dropdown list. E.g. Account.

  • Type Of Search - dropdown list with two values: Unique Fields and All Fields.

  • Lookup by field - dropdown list with all fields on the selected object. If:

    • All Fields is chosen for Type Of Search , or with all fields on the selected object where type is id or unique is true, and/or

    • Unique Fields is chosen for Type Of Search,

    then all searchable fields (both custom and standard) are available for selection.

  • id - string, salesforce object id.

  • success - boolean, if operation was successful true.

  • errors - array, if operation fails, it will contain description of errors.

Metadata description

Metadata for each particular Object type + Lookup by field is generated dynamically.

Upsert Object action

Creates or Updates Selected Object. This action creates a single object. The input metadata is fetched dynamically from your Salesforce account. The output metadata is the same as input metadata, so you may expect all fields that you mapped as input to be returned as output.

Upsert Object action

Input field description

  • Object - choose the object type you want to find from this input field. E.g. Account

  • Optional Upsert field - specify the ExternalID name field from this input field. E.g. ExtId__c.

  • Utilize data attachment from previous step (for objects with a binary field) - a checkbox, if selected, and the input message contains an attachment and specified object has a binary field (type of base64), then the input data is placed into object’s binary field. In this case, any data specified for the binary field in the data mapper is discarded.

You should specify external or internal Id when making updates to the Salesforce object. If you want to create a new Object, you should always specify Optional Upsert field and value of ExternalId in input body structure.

Lookup Object action (at most 1)

Look up an object by a selected field. This action creates a single object. The input metadata is fetched dynamically from your Salesforce account. The output metadata is the same as input metadata, so you may expect all fields that you mapped as input to be returned as output.

Lookup Object action (at most 1)

Input field description

  • Object - Dropdown list displaying all searchable object types. Select one type to query, e.g. Account.

  • Type Of Search - Dropdown list with two values: Unique Fields and All Fields.

  • Lookup by field - Dropdown list with all fields on the selected object if the Type Of Search is All Fields. If the Type Of Search is Unique Fields, the dropdown instead lists all fields on the selected object where type is id or unique is true.

  • Include linked objects - Multiselect dropdown list with all the related child and parent objects of the selected object type. List entries are given as Object Name/Reference To (Relationship Name). Select one or more related objects, which will be join-queried and included in the response from your Salesforce Organization.

  • Allow zero results - Checkbox. If this checkbox is selected and nothing is found in your Salesforce Organization, an empty object is returned. If this checkbox is cleared and nothing is found, the action will throw an error.

  • Pass binary data to the next component (if found object has it) - Checkbox. If this checkbox is selected and the found object record has a binary field (primitive type base64), then the data is passed to the next component as a binary attachment.

Metadata description

Metadata contains one field whose name, type and requirement are generated according to the value of the Lookup by field and Allow criteria to be omitted configuration fields.

Limitations

This action has a caching mechanism. By default, this action stores the last 10 request-response pairs for a duration of 10 min. These parameters can be changed by setting environment variables:
  • HASH_LIMIT_TIME - Hash expiration time in millis

  • HASH_LIMIT_ELEMENTS - Hash size number limit

Lookup Objects action

Look up a list of objects satisfying specified criteria.

Lookup Object actions

Input field description

  • Object - choose the object type you want to find from this dropdown list. E.g. Account.

  • Include deleted - a checkbox which if selected, then deleted records will be included into the result list.

  • Output method - a dropdown list with following values: "Emit all", "Emit page", "Emit individually".

  • Number of search terms - text field to specify a number of search terms (positive integer number [1-99] or 0).

  • Enable Cache Usage - flag to enable cache usage.

  • Max Fetch Count - limit for a number of messages that can be fetched.

1,000 is the default value when the variable is not set.

Action has caching mechanism. By default, this action stores last 10 request-response pairs for a duration of 10 min. These parameters can be changed by setting environment variables:
  • HASH_LIMIT_TIME - Hash expiration time in millis

  • HASH_LIMIT_ELEMENTS - Hash size number limit

Metadata description

Depending on the Output method configuration field, the input metadata can contain different fields:

  • Output method - "Emit page":

    • Field "Page size" - optional positive integer that defaults to 1000;

    • Field "Page number" - required non-negative integer (starts with 0, default value 0);

  • Output method - "Emit all":

    • Field "Maximum number of records" - optional positive integer (default value 1000);

    • Output method - "Emit individually":

  • Field "Maximum number of records" - optional positive integer (default value 10000);

that the number of records this component generates may affect the performance of the platform/component.

Next are groups of fields for each search term:

  • Field "Field name" - string represents object’s field (a list of allowed values is available);

  • Field "Field value" - string represents value for selected field;

  • Field "Condition" - one of the following: "=", "!=", "<", "<=", ">", ">=", "LIKE", "IN", "NOT IN";

Between each two term’s group of fields:

  • Field "Logical operator" - one of the following: "AND", "OR";

The output data is an object, with a field "results" that is an array of objects.

Bulk Create/Update/Delete action

Bulk API provides a simple interface for quickly loading large amounts of data from a CSV file into Salesforce (up to 10,000 records).

This action takes a CSV file from the attachment as an input.

The CSV file format is described in the Salesforce documentation

Bulk Create/Update/Delete action

Input field description

  • Operation - dropdown list with 3 supported operations: Create, Update and Delete.

  • Object - choose the object type from this dropdown list to perform the bulk operation. E.g. Case.

  • Timeout - maximum time to wait until the server completes a bulk operation (default: 600 sec).

The result is an object with a property result: array.

Each object contains the following 3 fields:

  • id - string, salesforce object id

  • success - boolean, if operation was successful true

  • errors - array, if operation failed contains description of errors

Limitations

  • No errors thrown in case of failed Object Create/Update/Delete ("success": "false").

  • Object ID is needed for Update and Delete.

  • Salesforce processes up to 10'000 records from the input CSV file.

Bulk Query action

Fetches records to a CSV file.

Bulk Query action

Input field description

  • SOQL Query - Input field where you should type the SOQL query. E.g. "SELECT ID, Name from Contact where Name like 'John Smi%'"

Result is a CSV file in the attachment.