By configuring the Salesforce input widget, you can import data from the Salesforce data source into Dataphin for data integration and development. This topic describes the steps to configure the Salesforce input widget.
Prerequisites
Ensure the following prerequisites are met before beginning:
A Salesforce data source is created. For more information, see create a Salesforce data source.
To configure the Salesforce input widget properties, the account must have read-through permission for the data source. If you lack this permission, you need to request it. For more information, see requesting data source permission.
Procedure
Select Development > Data Integration from the top menu bar on the Dataphin home page.
Choose a Project from the top menu bar on the integration page (the Dev-Prod pattern requires selecting an environment).
In the navigation pane on the left, click on the Batch Pipeline icon. From the Batch Pipeline list, select the offline pipeline you want to develop to access its configuration page.
To open the Component Library panel, click the Component Library icon in the upper right corner of the page.
In the Component Library panel's left-side navigation pane, select Input. Then, drag the Salesforce widget from the input widget list to the canvas.
To configure the widget, click the
icon on the Salesforce input widget card, which opens the Salesforce Input Configuration dialog box.Set the parameters in the Salesforce Input Configuration dialog box.
Parameter
Description
Step Name
The name of the Salesforce input widget. Dataphin automatically generates the step name, but you can modify it according to the business scenario. The name must meet the following requirements:
Can only contain Chinese characters, letters, underscores (_), and numbers.
Cannot exceed 64 characters.
Datasource
The drop-down list displays all Salesforce-type data sources in Dataphin. Click the
icon to copy the current data source name.For data sources you do not have read-through permission for, you can click Request after the data source to request read permission for the corresponding data source. For more information on requesting data source read permission, see request data source permission.
If you do not have a Salesforce-type data source yet, click Create Data Source to create a data source. For more information, see create a Salesforce data source.
Object
Select the object in the Salesforce instance from which you need to read data. You can enter a keyword for the object name to search or enter the exact object name and click Exact Search. After selecting an object, the system will automatically perform object status detection. Click the
icon to copy the name of the currently selected object.Bulk read
Turn on this switch to use the Bulk API to read data in batches.
NoteBatch mode does not support reading composite field types.
Input Filter (optional)
Fill in the filter information for the input field, such as
ds=${bizdate}. Input Filter is applicable to the following two scenarios:A fixed part of the data.
Parameter filtering.
NoteThe supported comparison operators include =, !=, <, >, IN, NOT IN, etc.
Output Fields
The output fields area displays all fields in the selected object. If you do not need to output certain fields to downstream widgets, you can delete the corresponding fields:
To delete a small number of fields, you can click the Actions column's
icon to delete the extra fields.To delete many fields, you can click Field Management. On the Field Management page, select multiple fields and click the
icon to move the Selected Input Fields to Unselected Input Fields.
Finalize the property configuration of the Salesforce input widget by clicking Confirm.