Salesforce Standard Integration Documentation
The SF Integration is part of the Standard Integrations Set and is maintained by the Standard Integration Team.
What we can do with this integration:
- CRUD for SF Objects (read and write data available in the sObject)
- Get Object by Name
- Get Object (Task and Opportunity) by ID
- Delete Object after selecting from datasource
- Update Object after selecting from datasource
- Create Task after selecting Opportunity from datasource
- Get Object's Child Relatives
- Search records
The integration covers Objects and can handle the following user stories/ use cases:
- Use cases, where the information from Objects (eg Opportunities) available in SFDC needs to be shown and used in BRYTER.
- Use cases, where the information collected in BRYTER needs to be added to SFDC as a Object (eg Opportunities)
- Use cases, where the information collected in BRYTER is used to update information in SFDC existing Objects (eg Opportunities)
Please do not use this integration for SF Quotes (like CPQ) - this integration is not able to handle Quotes. There is a separate Salesforce- CPQ Quotes Integration available.
Salesforce Object Standard Integration
The integration is built with Lightning Platform REST API for SF sObjects.(https://developer.salesforce.com/docs/apis).
Version 1.1.3 Standard-beta available 2022.
This integration allows CRUD Operations with a Salesforce Object (sObject) as well as function to search an object by name. It should work on all Objects as it uses Salesforce Metadata to determine their structure. More generic (SQL) queries for Salesforce can be easily implemented.
- The four CRUD actions: create-sobject, read-sobject, update-sobject, delete-sobject
- get-sobject-by-name will take a name as a parameter and search records having a similar name (Using LIKE). If several results are returned by Salesforce, only the first result is returned by the integration.
- search-record allows to search records using a SOQL search query. Only the part after the WHERE has to be entered as a query. A valid value would look like "Name LIKE 'Write%'"
- read-record-relatives with inputs Id and Relation retrieves all related records to that one with particular Id. Relation names are constructed as plural forms of SObject names, such as "Contacts", "Opportunities" etc. Proper understanding of naming strategy of relations is described here.
There are three datasource defined:
- sobject-metadata-read will return the metadata of the Salesforce object the integration if configured for
- sobject-records-read will return the ids and lables of actual salesforce records
- sobjects-list will list all Salesforce objects that are defined in the salesforce instance used
- The salesforce object has to be defined with an environment variable and cannot be changed during runtime.
- For the `Upload Attachment`action, no user ID other than the one in Connected App can ever be used as file owner
Before you start using BRYTER Standard Salesforce Integrations (handling Objects or Quotes) you will need to set up a Connected App within the Salesforce Sandbox or Admin Console. This Connected App provides the required parameters for both currently available SF integrations.
These parameters are used in the configuration steps within the BRYTER Admin console to set up a new integration.
Each Integration is configured in a step-by-step process, that requires Admin and Developer level access to the 3rd party tool, in this case - Salesforce.
- Creation of the Connected app. Aims to grant access to BRYTER, and support the authentication process between the tools - should be done by the customer’s SF Admin in the SF Console. The right to give permission to new users/ allow new apps to read and write is required.
- Collecting the required parameters to configure the integration within the BRYTER admin console. This step might take longer hours to finish and requires Admin level access to SF.
- Configuring the integration within BRYTER using the parameters. This step requires BRYTER Admin access rights.
- Adding the integration in the module via action nodes and setting up the module according to your use case.
Please refer to the Salesforce - Getting Started Guide to set up the Connected App and Configure the Integration within BRYTER Admin Console.
The Module Author Guide will be available soon.