elastic.io iPaaS component that connects to Salesforce API
Salesforse-component Completeness Matrix
The component uses Salesforce - API Version 46.0 by defaults but can be overwritten by the environment variable SALESFORCE_API_VERSION
| Name | Mandatory | Description | Values |
|---|---|---|---|
| SALESFORCE_API_VERSION | false | Determines API version of Salesforce to use | Default: 46.0 |
| REFRESH_TOKEN_RETRIES | false | Determines how many retries to refresh token should be done before throwing an error | Default: 10 |
| HASH_LIMIT_TIME | false | Hash expiration time in ms | Default: 600000 |
| HASH_LIMIT_ELEMENTS | false | Hash size number limit | Default: 10 |
Authentication occurs via OAuth 2.0.
In order to make OAuth work, you need a new App in your Salesforce. During app creation process you will be asked to specify
the callback URL, to process OAuth authentication via elastic.io platform your callback URL should be https://your-tenant.elastic.io/callback/oauth2.
More information you can find here.
During credentials creation you would need to:
- select existing Auth Client from drop-down list
Choose Auth Clientor create the new one. For creating Auth Client you should specify following fields:
| Field name | Mandatory | Description |
|---|---|---|
| Name | true | your Auth Client's name |
| Client ID | true | your OAuth client key |
| Client Secret | true | your OAuth client secret |
| Authorization Endpoint | true | your OAuth authorization endpoint. For production use https://login.salesforce.com/services/oauth2/authorize, for sandbox - https://test.salesforce.com/services/oauth2/authorize |
| Token Endpoint | true | your OAuth Token endpoint for refreshing access token. For production use https://login.salesforce.com/services/oauth2/token, for sandbox - https://test.salesforce.com/services/oauth2/token |
- fill field
Name Your Credential - click on
Authenticatebutton - if you have not logged in Salesforce before then log in by entering data in the login window that appears - click on
Verifybutton for verifying your credentials - click on
Savebutton for saving your credentials
Polls existing and updated objects. You can select any custom or built-in object for your Salesforce instance.
- Object - Input field where you should select the type of object which updates you want to get. E.g.
Account; - Start Time - Indicates the beginning time to start polling from. Defaults to
1970-01-01T00:00:00.000Z; - End Time - If provided, don’t fetch records modified after this time;
- Size of Polling Page - Indicates the size of pages to be fetched. You can set positive integer, max
10 000, defaults to1000; - Process single page per execution - You can select on of options (defaults to
yes):yes- if the number of changed records exceeds the maximum number of results in a page, wait until the next flow start to fetch the next page;no- if the number of changed records exceeds the maximum number of results in a page, the next pages will fetching in the same execution.
- 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. Please see the Limitations section below for use case advisories. - Output method - dropdown list with options:
Emit all- all found records will be emitted in one arrayrecords, andEmit individually- each found object will be emitted individual. Optional field, defaults to:Emit individually. - 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.
For example, you have 234 “Contact” objects, 213 of them were changed from 2019-01-01.
You want to select all “Contacts” that were changed from 2019-01-01, set the page size to 100 and process single page per execution.
For you purpose you need to specify following fields:
- Object:
Contact - Start Time:
2019-01-01T00:00:00.000Z - Size of Polling Page:
100 - Process single page per execution:
yes(or leave this empty)
- Object:
As a result, all contacts will be fetched in three calls of the trigger: two of them by 100 items, and the last one by 13.
If you select no in Process single page per execution, all 213 contacts will be fetched in one call of the trigger.
When a binary field (primitive type base64, e.g. Documents, Attachments, etc) is selected on Include linked objects, an error will be thrown: 'MALFORMED_QUERY: Binary fields cannot be selected in join queries. Instead of querying objects with binary fields as linked objects (such as children Attachments), try querying them directly.' There is also a limit to the number of linked objects that you can query at once - beyond two or three, depending on the number of fields in the linked objects, Salesforce could potentially return a Status Code 431 or 414 error, meaning the query is too long. Finally, due to a bug with multiselect dropdowns, it is recommended to deselect all of the elements in this field before you change your selection in the Object dropdown list.
Continuously runs the same SOQL Query and emits results according to Output method configuration field.
Use the Salesforce Object Query Language (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.
This trigger allows you to interact with your data using SOQL.
- SOQL Query - Input field for your SOQL Query
- Output method - dropdown list with options:
Emit all- all found records will be emitted in one arrayrecords, andEmit individually- each found object will be emitted individual. Optional field, defaults to:Emit individually.
This trigger will subscribe for any platform Event using Salesforce streaming API.
- Event object name - Input field where you should select the type of platform event which you want to subscribe E.g.
My platform event
Setup --> Integrations --> Platform Events --> New Platform Event
You can find more detail information in the Platform Events Intro Documentation.
At the moment this trigger can be used only for "Realtime" flows.
Bulk API provides a simple interface for quickly loading large amounts of data from CSV file into Salesforce (up to 10'000 records). Action takes a CSV file from the attachment as an input. CSV file format is described in the Salesforce documentatio
- Operation - dropdown list with 4 supported operations:
Create,Update,UpsertandDelete. - Object - dropdown list where you should choose the object type to perform bulk operation. E.g.
Case. - Timeout - maximum time to wait until the server completes a bulk operation (default:
600sec).
- External ID Field - a name of the External ID field for
Upsertoperation. E.g.my_external_id__c
Result is an object with a property result: array. It contains objects with 3 fields.
- id -
string, salesforce object id - success -
boolean, if operation was successfultrue - errors -
array, if operation failed contains description of errors
- No errors thrown in case of failed Object Create/Update/Delete/Upsert (
"success": "false"). - Object ID is needed for Update and Delete.
- External ID is needed for Upsert.
- Salesforce processes up to 10'000 records from the input CSV file.
Fetches records to a CSV file.
- 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.
Creates a new Selected Object. Action creates a single object.
Note:
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.
- Object - Input field where you should choose the object type, which you want to find. E.g.
Account - Utilize data attachment from previous step (for objects with a binary field) - a checkbox, if it is checked and an input message contains an attachment and specified object has a binary field (type of base64) then the input data is put into object's binary field. In this case any data specified for the binary field in the data mapper is discarded.
This action will automatically retrieve all existing fields of chosen object type that available on your Salesforce organization
Input metadata is fetched dynamically from your Salesforce account.
Output metadata is the same as input metadata, so you may expect all fields that you mapped as input to be returned as output.
When Utilize data attachment from previous step (for objects with a binary field) is checked and this action is used with Local Agent error would be thrown: 'getaddrinfo ENOTFOUND steward-service.platform.svc.cluster.local steward-service.platform.svc.cluster.local:8200'
Deletes an object by a selected field. One can filter by either unique fields or all fields of that sobject.
- Object - dropdown list where you should choose the object type, which you want to find. E.g.
Account. - Type Of Search - dropdown list with two values:
Unique FieldsandAll Fields. - Lookup by field - dropdown list with all fields on the selected object, if on Type Of Search is chosen
All Fields, or with all fields on the selected object wheretypeisidoruniqueistrue, if on Type Of Search is chosenUnique Fieldsthen all searchable fields both custom and standard will be available for selection.
Input metadata is fetched dynamically from your Salesforce account and depends on field Lookup by field.
Result is an object with 3 fields.
- id -
string, salesforce object id - success -
boolean, if operation was successfultrue - errors -
array, if operation fails, it will contain description of errors
Lookup an object by a selected field. Action creates a single object.
- 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 FieldsandAll 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 isUnique Fields, the dropdown lists instead all fields on the selected object wheretypeisidoruniqueistrue. - Include referenced 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. Please see the Limitations section below for use case advisories. - Allow criteria to be omitted - Checkbox. If checked and nothing is specified in criteria, an empty object will be returned. If not checked and nothing is found, the action will throw an error.
- Allow zero results - Checkbox. If checked and nothing is found in your Salesforce Organization, an empty object will be returned. If not checked and nothing is found, the action will throw an error.
- Pass binary data to the next component (if found object has it) - Checkbox. If it is checked and the found object record has a binary field (primitive type
base64), then its data will be passed to the next component as a binary attachment. - Enable Cache Usage - Flag to enable cache usage.
Input metadata is fetched dynamically from your Salesforce account. Metadata contains one field whose name, type and mandatoriness are generated according to the value of the configuration fields Lookup by field and Allow criteria to be omitted.
Output metadata is the same as input metadata, so you may expect all fields that you mapped as input to be returned as output.
-
When a binary field (primitive type
base64, e.g. Documents, Attachments, etc) is selected on Include linked objects, an error will be thrown:MALFORMED_QUERY: Binary fields cannot be selected in join queries. Instead of querying objects with binary fields as linked objects (such as children Attachments), try querying them directly.There is also a limit to the number of linked objects that you can query at once - beyond two or three, depending on the number of fields in the linked objects, Salesforce could potentially return a Status Code 431 or 414 error, meaning the query is too long. Finally, due to a bug with multiselect dropdowns, it is recommended to deselect all of the elements in this field before you change your selection in the Object dropdown list. -
Not supported object lookup when selected field value is
null -
When Pass binary data to the next component (if found object has it) is checked and this action is used with Local Agent, an error will be thrown: 'getaddrinfo ENOTFOUND steward-service.platform.svc.cluster.local steward-service.platform.svc.cluster.local:8200'
Action has caching mechanism. By default action stores last 10 request-response pairs for 10 min duration. This parameters can be changed by setting environment variables:
- HASH_LIMIT_TIME - Hash expiration time in milis
- HASH_LIMIT_ELEMENTS - Hash size number limit
Lookup a list of objects satisfying specified criteria.
- Object - dropdown list where you should choose the object type, which you want to find. E.g.
Account. - Include deleted - checkbox, if checked - deleted records will be included into the result list.
- Output method - 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.
Depending on the the configuration field Output method 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);
Note that the number of records the component emits may affect the performance of the platform/component.
Groups of fields for each search term go next:
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";
Output data is an object, with a field "results" that is an array of objects.
Action has caching mechanism. By default action stores last 10 request-response pairs for 10 min duration. This parameters can be changed by setting environment variables:
- HASH_LIMIT_TIME - Hash expiration time in milis
- HASH_LIMIT_ELEMENTS - Hash size number limit
Executing a SOQL Query that may return many objects. Use the Salesforce Object Query Language (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. This action allows you to interact with your data using SOQL. Empty object will be returned, if query doesn't find any data.
- Optional batch size - A positive integer specifying batch size. If no batch size is specified then results of the query will be emitted one-by-one, otherwise, query results will be emitted in an array of maximum batch size.
- Allow all results to be returned in a set (overwrites 'Optional batch size feature') - checkbox which allows emitting query results in a single array.
Optional batch sizeoption is ignored in this case. - Include deleted - checkbox, if checked - deleted records will be included into the result list.
- 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.
- SOQL Query - Input field where you should type the SOQL query. E.g.
"SELECT ID, Name from Contact where Name like 'John Smi%'"
Creates or Updates Selected Object. Action creates a single object.
- Object - Input field where you should choose the object type, which you want to find. E.g.
Account - Optional Upsert field - Input field where you should specify the ExternalID name field. E.g.
ExtId__c. - Utilize data attachment from previous step (for objects with a binary field) - a checkbox, if it is checked and an input message contains an attachment and specified object has a binary field (type of base64) then the input data is put 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 for making some updates in salesforce object. If you want to create new Object you should always specify Optional Upsert field and value of ExternalId in input body structure.
Input metadata is fetched dynamically from your Salesforce account.
Output metadata is the same as input metadata, so you may expect all fields that you mapped as input to be returned as output.
When Utilize data attachment from previous step (for objects with a binary field) is checked and this action is used with Local Agent error would be thrown: 'getaddrinfo ENOTFOUND steward-service.platform.svc.cluster.local steward-service.platform.svc.cluster.local:8200'
Attachments mechanism does not work with Local Agent Installation