Writer Directives
The suffixes shown are prefixed by the current <WriterKeyword> in a mapping file. By default, the <WriterKeyword> for the Salesforce Writer is SALESFORCE_OUT.
DATASET
This parameter specifies the host through which to log in to Salesforce. Upon successful login, the Salesforce Writer will automatically switch to a different host if necessary.
Required/Optional
Required
Mapping File Syntax
<WriterKeyword>_DATASET login.salesforce.com
USER
This parameter specifies the user that accesses Salesforce.
Required/Optional
Required
Mapping File Syntax
<WriterKeyword>_USER user@example.com
Workbench Parameter
User
PASSWORD
This parameter specifies the password for the user that accesses Salesforce.
Required/Optional
Required
Mapping File Syntax
<WriterKeyword>_PASSWORD password
Workbench Parameter
Password
SECURITY_TOKEN
This parameter specifies the security token for accessing Salesforce. If Salesforce is being accessed outside of a trusted network, a security token is needed to log in.
Required/Optional
Optional
Mapping File Syntax
<WriterKeyword>_SECURITY_TOKEN TiIeyLhXxGYDnshhctimJvSzz
Workbench Parameter
Security Token
DEF
Each Salesforce object must have fields defined for records to be written. All field names on the def line must exist on the object. The syntax of the definition is:
SALESFORCE_DEF <objectName> \
[salesforce_mode (INSERT|UPDATE|UPSERT|DELETE|HARDDELETE)] \
[Salesforce_external_id_field_name <fieldName>] \
[<fieldName> <fieldType>] +
Parameter |
Contents |
---|---|
objectName |
The name of the object to be written.
|
salesforce_mode |
The type of write command to perform. Refer to the Writer Mode Specification section for details. Default: UPSERT |
salesforce_external_id_field_name |
The external ID field name to use as the key for UPSERT operations. This parameter is required if salesforce_mode is UPSERT, and ignored otherwise. |