Before you begin: The Salesforce SOQL Smart Connector enables you to integrate data from Salesforce SOQL into the TapClicks platform. For specific information about how to use this type of data architecture and storage, refer to the Salesforce developer community articles here.
How to Create a Salesforce SOQL Smart Connector
A Smart Connector is way of pulling data into TapClicks that doesn't already have an existing integration into the TapClicks platform. One of the delivery types available for Smart Connectors is Salesforce SOQL.
1] On the left side menu, under Administration, click Smart Connector.
2] The Smart Connector page appears. Click the "+".
3] The New Smart Connector modal appears.
4] Enter a name for the Smart Connector in the Name field.
5] Enter a drilldown name for the Smart Connector in the Drilldown field. Think of the Drilldown as the top-level way of organizing your Smart Connectors.
6] Select the Is active? checkbox to make the Smart Connector active.
7] From the Origin of Data dropdown, optionally select either Internal System or Third-party Software.
8] Optionally choose an icon and icon color to represent your Smart Connector.
9] From the Delivery type dropdown, select Salesforce SOQL .
| NOTE: The Salesforce Object Query Language (SOQL) can be used to search an 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. |
10] The Authenticate button appears.
11] Click the Authenticate button.
12] You will be redirected to the Salesforce login page.
13] Enter your Salesforce Username and Password and click Log In.
14] You'll be redirected back to TapClicks. Click the Save Changes button at the bottom of the screen.
15] The field to create a query request appears.
16] To retrieve the desired data from the remote Salesforce SOQL database, enter a query into the Request to Salesforce SOQL textbox.
| NOTE: Salesforce SOQL Smart Connectors support only READ queries, like queries with SELECT.
In order to achieve memory optimization , the system will automatically paginate the data in batches of rows. Adding a LIMIT at the end of your query will prompt the system to have that many number of rows in the batch. However, because the order in which the rows are fetched from the database could vary from query to query, it’s best to add in your query statement an ORDER BY command to ensure the data integrity. Example: Select Name FROM Account WHERE Industry = Media ORDER BY Account.Name LIMIT10000. |
| NOTE: Only columns selected in the query will be retrieved by the Salesforce SOQL Smart Connector so you need to make sure that you're including all necessary columns in the query. |
17] Click the Load Sample button.
|
NOTE: Data types of all columns are detected automatically. It is recommended that you should check all the data types before saving the configuration to avoid incorrect data types. See the Field Type column in the image below. Auto detection may select a column with a number based on what is in that first row of data, but that might not be how you intend the field to be used. For example, Id is data type Number since it comes through as a 3 in the sample file, but it should be stored as Text since no mathematical operations (such as Sum/Average) are expected on an Id. |
18] Sample file data appear.
NOTE:The frequency of historic and daily fetches is as follows:
|
| NOTE:If certain fields in the query need to be modified (unique fields, dates, and assigning configurations), you will need to delete the data loaded to date through the Smart Connector before making the modifications. This is done through the Delete, which is placed next to the Smart Connector names in the Smart Connector list.
However, you can include additional fields in the query similar to if you were to add a new field from a .csv file to a Smart Connector. You can do this without deleting the previously loaded data. Standard partial/full fetch applies to existing and new assigning in regards to filling the database with these new fields. This functionality is in line with all other Connection Type/Delivery Type options in the system today. After creating the Smart Connector, you will have to map your Smart Connector data to clients in TapAnalytics and click Update Dashboard before the data starts pouring into the system. |