Properties and commands

This chapter provides a detailed description of the adapter properties.

Instance URL
Specifies a server instance of organization. User can view their instance URL when they open their Salesforce Org screen. This is a mandatory property. The corresponding adapter command is -IURL (or -INSTANCEURL).
Access token
Specifies an access token to access the Salesforce REST APIs using OAuth 2.0 Authentication. Refer to Generate an Initial Access Token to generate initial access token.
Version
Endpoint
Specifies the endpoint entry in the configuration. This is a mandatory property. The corresponding adapter command is-E (or -ENDPOINT).
Access Token Expiry Action
This property specifies the action to be taken by Salesforce Adapter if the access token provided is either expired or invalid.
Consumer key
Specifies the consumer key value to use when performing Refresh Token or Request New Token expiry action.
Consumer secret
Specifies the consumer secret value to use when performing Request New Token expiry action. It is enabled when the user sets up an application under the Connected Apps in Salesforce.
Refresh token
Specifies the refresh token to provide when performing Refresh Token expiry action.
Security Token
Specifies the security token value to perform when performing Request New Token expiry action.
Token Storage File
Specifies the location of the file in the local file system in which to store the access token retrieved after performing Refresh Token or Request New Token expiry action.
Encryption key
Specifies the key to use for encrypting the access token with AES-256 encryption method when saving the token in the token storage file.
Object Name
This property specifies the object name to be acted upon when action Get Record, Insert Record, Update Record or Delete Record is selected.
Id
Specifies the record ID that is used for fetching, updating or deleting any record.
SOQL Query
SOQL Query is enabled, when you select the Execute Query, Execute QueryAll, or Query Performance action.
Search string
Specifies the search parameter that is used for simplified searching in Salesforce data instead of a SOQL clause.
Logging
Specifies the level of logging to use for the log (trace) file produced by the adapter.
Append Log
The Append Log is a flag that indicates what to do if the specified log file already exists.
Log File Path
Name of the log file to which to write log messages.

Parent topic: Salesforce Adapter