Salesforce API for DataStage connector

Use the Salesforce API for DataStage connector in DataStage® to read and write data from Salesforce.com.

Prerequisite

Create the connection. For instructions, see Connecting to a data source in DataStage and the Salesforce API for DataStage connection.

Writing data to the Salesforce API for DataStage connector as a target

If you want to configure Salesforce API for DataStage connector for DataStage as a target:
  1. Double-click the Salesforce API for DataStage connector icon in the project canvas.
  2. In the Stage tab, in Properties section set your connection details (if you did not create the connection earlier).
  3. In General target properties choose the write operation method.
    Table 1. Write operation methods
    Write operation method Procedure
    Create/ Update In the Access method choose:
    • Real-time mode, which gives you the access to Enable load or extract large object via flat file option and Additional properties in which you need to provide the business object and data batch size.
    • Bulk mode, which gives you the access to Job ID in file and Keep temporary files option. Choose the Salesforce.com concurrency mode.
    Delete In the Access method choose:
    • Real-time mode, which gives you the access to Additional properties in which you need to provide the business object and data batch size.
    • Bulk mode, which gives you the access to Job ID in file, Empty recycle bin and Keep temporary files option. Choose the Salesforce.com concurrency mode.
    Upsert In the Access method choose:
    • Real-time mode, which gives you the access to Additional properties in which you need to provide the business object and data batch size.
    • Bulk mode, which gives you the access to Job ID in file, and Keep temporary files option. Choose the Salesforce.com concurrency mode.
  4. In the Advanced section, set the execution and combinability mode.
  5. In the Input tab, choose the Input name. Under the Columns section, edit input columns. Under the Partitioning section, choose the Partition type option. Under the Advanced section, choose the Buffering mode option.

Reading data from the Salesforce API for DataStage connector as a source

If you want to configure Salesforce API for DataStage connector for DataStage as a source:
  1. Double-click the Salesforce API for DataStage connector icon in the project canvas.
  2. In the Stage tab, in Properties section set your connection details (if you did not create the connection earlier).
  3. In General target properties choose the read operation method.
    Table 2. Read operation methods
    Read operation method Procedure
    Get deleted delta/ Get updated delta In Additional properties provide the business object, delta start time, delta end time, delta extract ID, and data batch size.
    Get the bulk load status In Bulk mode operation you can choose Job ID in file option. You need to provide Job ID, Sleep, and Tenacity.
    Query/ Query all In the Access method choose:
    • Real-time mode, which gives you the access to Enable load or extract large object via flat file option and Additional properties in which you need to provide SOQL query to Salesforce.com and program-generated reference SOQL query.
    • Bulk mode, which gives you the access to Job ID in file and Enable PK Chunking options and the same features as in real-time mode.
  4. In the Advanced section, set the execution and combinability mode. Moreover, select the option for preserving the data partitioning.
  5. In the Output tab, choose the Output name. Under the Columns section, edit input columns. Under the Advanced section, choose the Buffering mode option.