Connect with Saleforce object using SOQL

When defining the Salesforce (SFDC) objects to extract on the Connect page, you can use the Create query based object feature to edit the Salesforce Object Query Language (SOQL) query for an object in order to select the specific columns you want to extract from the object.

To connect to SFDC sources using SOQL, do the following:

  1. Navigate to Modeler Connect.
  2. Select the SFDC connector from the SFDC section or click the existing Jira connection from the Connections panel.
  3. Click the Ellipses icon, and then select Add query-based object.


  4. Specify the Source Name.
    Note: Verify that the name is unique. If you use the same name as an already saved object, the existing object is overwritten. Alphanumeric characters, spaces, and underscores can be used in the name.


  5. Select Connector Object Name from the list of your available Salesforce objects.
  6. Click Get Query.
    Note: Birst does not support extracting columns from multiple SFDC sources in a single SOQL query.
  7. A Birst variable can be used to filter the data being extracted from the source.

    For example, in order to extract data from Salesforce incrementally, you could extract only the records that have changed on or after a certain date/time.

    To extract all the Opportunities with SystemModstamp on or after the LastLoadLastExtractDate, where LastLoadLastExtractDate is a Birst variable containing the date and time, you could use the following SOQL query: SELECT Id,CreatedDate,StageName,Amount,ExpectedRevenue,CloseDate,Probability,ForecastCategory FROM Opportunity WHERE SystemModstamp >= V{LastLoadLastExtractDate}

  8. Click More Options.
    If you want the extraction to include records that have been deleted or archived in Salesforce, select Include deleted and archived records. The extraction may take longer when this option is selected.
  9. Click Save. After saving the object, it is added to the list of objects to be extracted in the Data Sources table.
  10. To edit your SOQL object after it's created, click More Options, and then click Edit.