Querying Records in Salesforce

This task will execute a Read query against the Salesforce system and return the data in XML format. The query must be written in Salesforce Object Query Language (SOQL). Documentation on the Salesforce Object Query Language (SOQL) is provided by Salesforce.

Settings

Connection

Required
The Salesforce connection to use, see Connecting to Salesforce

Output File

Required
The file name or variable to send the results of the query e.g. Output.xml

Date Created

Required
This setting will be automatically set to the highest CreatedDate value seen so far in the results produced by the query. The value can be referenced within your query, by using @CreatedDate. This allows you to filter the export so that it only returns new records.

Note

Your query must select the CreatedDate field for this to work.

Date Modified

Required
This setting will be automatically set to the highest LastModifiedDate value seen so far in the results produced by the query. The value can be referenced within your query, by using @LastModifiedDate. This allows you to filter the export so that it only returns modified records.

Note

Your query must select the LastModifiedDate field for this to work.

Ignore Child Record Dates

Required
Set to true to only consider the CreatedDate and LastModifiedDate fields at the parent record level when determining the values for the 'Date Created' and 'Date Modified' settings. When set to false, the CreatedDate and LastModifiedDate on all child records will also be considered.

Query

Required
The Salesforce Object Query (SOQL) to be executed, supports nested queries and custom objects. e.g. SELECT Id, Name FROM Account

Zynk Settings

See Common Task Settings

Examples

Sample SOQL query, to download modified closed won opportunities and their related account and item lines:

SELECT Opportunity.Id, 
  Opportunity.Name,
  Opportunity.Owner.Name,
  Opportunity.CloseDate,
  Opportunity.HasOpportunityLineItem,
  Opportunity.Amount,
  Opportunity.CreatedDate,
  Opportunity.LastModifiedDate,
  Account.Id, 
  Account.AccountNumber, 
  Account.Name,
  Account.Website,
  Account.Phone,
  Account.Fax,
  Account.BillingAddress,
  (
    SELECT Quantity, 
      ListPrice, 
      UnitPrice,
      Product2.Name,
      Product2.ProductCode
    FROM OpportunityLineItems
  )
FROM Opportunity
WHERE StageName = 'Closed Won' AND Opportunity.Account.Id != null AND LastModifiedDate > @LastModifiedDate

Sample output file:

<?xml version="1.0" encoding="utf-8"?>
<QueryResult>
  <done>true</done>
  <records type="Opportunity" url="/services/data/v58.0/sobjects/Opportunity/0068000000SvrwHAAR">
    <Id>0068000000SvrwHAAR</Id>
    <Name>Test Opp</Name>
    <Owner type="User" url="/services/data/v58.0/sobjects/User/00580000001nhfBAAQ">
      <Name>Andrew Snape</Name>
    </Owner>
    <CloseDate>2023-06-01</CloseDate>
    <HasOpportunityLineItem>true</HasOpportunityLineItem>
    <Amount>1860000.0</Amount>
    <CreatedDate>2023-04-08T13:52:34.000Z</CreatedDate>
    <LastModifiedDate>2023-06-01T11:50:58.000Z</LastModifiedDate>
    <Account type="Account" rl="/services/data/v58.0/sobjects/Account/0018000000cGzpgAAC">
      <Id>0018000000cGzpgAAC</Id>
      <AccountNumber>000010</AccountNumber>
      <Name>Dura Limited</Name>
      <Website>http://www.duraltd.com</Website>
      <Phone>01112100100</Phone>
      <Fax>02222200200</Fax>
      <BillingAddress xsi:type="address">
        <latitude xsi:nil="true" />
        <longitude xsi:nil="true" />
        <city>Dura</city>
        <country>England</country>
        <countryCode xsi:nil="true" />
        <geocodeAccuracy xsi:nil="true" />
        <postalCode>DU1 7TD</postalCode>
        <state>County Dura</state>
        <stateCode xsi:nil="true" />
        <street>123 Industrial Est.</street>
      </BillingAddress>
    </Account>
    <OpportunityLineItems>
      <done>true</done>
      <records type="OpportunityLineItem" url="/services/data/v58.0/sobjects/OpportunityLineItem/00k8000000Dh12BAAR">
        <Quantity>12.0</Quantity>
        <ListPrice>150000.0</ListPrice>
        <UnitPrice>150000.0</UnitPrice>
        <Product2 type="Product2" url="/services/data/v58.0/sobjects/Product2/01t80000001LdRuAAK">
          <Name>GenWatt Gasoline 2000kW</Name>
          <ProductCode>GC5060</ProductCode>
        </Product2>
      </records>
      <records type="OpportunityLineItem" url="/services/data/v58.0/sobjects/OpportunityLineItem/00k8000000Dh12AAAR">
        <Quantity>12.0</Quantity>
        <ListPrice>5000.0</ListPrice>
        <UnitPrice>5000.0</UnitPrice>
        <Product2 type="Product2" url="/services/data/v58.0/sobjects/Product2/01t80000001LdRgAAK">
          <Name>GenWatt Diesel 10kW</Name>
          <ProductCode>GC1020</ProductCode>
        </Product2>
      </records>
      <totalSize>2</totalSize>
    </OpportunityLineItems>
  </records>
  <totalSize>1</totalSize>
</QueryResult>