Property | Description |
|---|---|
Connection Name | Name of the connection. Each connection name must be unique within the organization. Connection names can contain alphanumeric characters, spaces, and the following special characters: _ . + -, Maximum length is 255 characters. |
Description | Description of the connection. Maximum length is 4000 characters. |
Use Secret Vault | Stores sensitive credentials for this connection in the secrets manager that is configured for your organization. This property appears only if secrets manager is set up for your organization. When you enable the secret vault in the connection, you can select the credentials that the Secure Agent retrieves from the secrets manager. If you don't enable this option, the credentials are stored in the repository or on a local Secure Agent, depending on how your organization is configured. Note: If you’re using this connection to apply data access policies through pushdown or proxy services, you cannot use the Secret Vault configuration option. For information about how to configure and use a secrets manager, see Secrets manager configuration. |
Runtime Environment | The name of the runtime environment where you want to run tasks. Select a Secure Agent, Hosted Agent, serverless, or elastic runtime environment. Don't use a Hosted Agent if you use the connection in mappings in advanced mode or if you configure the OAuth - JWT connection type to connect to Salesforce. |
Property | Description |
|---|---|
User Name | The user name to connect to the Salesforce account. |
Password | The password to connect to the Salesforce account. |
Service URL | URL of the Salesforce service. By default, Salesforce connections for new organizations use version 67.0 of the Salesforce API. To configure the Standard connection type, edit the Salesforce API version to 64.0. For example: https://login.salesforce.com/services/Soap/u/64.0 Note: You can use the Salesforce API version up to 64.0, except versions 58.0 and 61.0. The maximum length is 100 characters. If you edit the service URL for an existing standard connection, re-enter the password and security token. |
Property | Description |
|---|---|
Security Token | Security token generated from the Salesforce application. Note: If you don't enter the Salesforce security token in this field, you need to add the Data Integration IP addresses to the trusted IP ranges in your Salesforce account. Otherwise, the connection might fail. For more information about the list of IP address ranges, see Standard. |
Bypass proxy server settings defined for the Secure Agent | Bypasses the proxy server settings defined for the Secure Agent in the Secure Agent Manager and directly connects to Salesforce. If you do not select this option, the Salesforce connection uses the proxy server setting defined for the Secure Agent to connect to Salesforce. |
Property | Description |
|---|---|
OAuth Consumer Key | The consumer key to generate a refresh token. |
OAuth Consumer Secret | The consumer secret to generate a refresh token. |
OAuth Refresh Token | The refresh token that you generated using the SFDC OAuth 2.0 tool. For more information about how to generate the OAuth refresh token, see the Before you begin section. |
Service URL | URL of the Salesforce service endpoint. For example: https://login.salesforce.com/services/Soap/u/67.0 You can use any Salesforce API version up to 67.0, except versions 58.0 and 61.0. The maximum length is 100 characters. When you edit the service URL for an existing OAuth connection, re-enter the consumer key, consumer secret, and refresh token. |
Property | Description |
|---|---|
Service URL | URL of the Salesforce service endpoint. For example: https://login.salesforce.com/services/Soap/u/67.0 You can use any Salesforce API version up to 67.0, except versions 58.0 and 61.0. The maximum length is 100 characters. When you edit the service URL for an existing OAuth - JWT connection, re-enter the connection properties. |
OAuth JWT Access Token | The access token granted by the authorization server to access Salesforce data. Click Generate Access Token to populate the access token value. |
OAuth JWT Payload | The JSON object that contains the claims transferred in the JWT. Enter the JWT payload in the following JSON format: { "iss":"<client ID>", "sub":"<user name>", "aud":"https://login.salesforce.com", "exp":"300" } The exp value represents the expiry time as a relative time in seconds. The connection calculates the expiry time in Coordinated Universal Time (UTC) format from the token issuer time (iat). When the payload defines iat and the expiry time passes, the connection fails to generate an access token. To generate a new access token, provide a valid iat in the payload. If the payload doesn't define iat, the connection calculates the expiry time from the current time stamp. |
OAuth JWT Header | The JSON object that contains the cryptographic operations applied to the JWT. Enter the following JWT header value: { "alg":"RS256" } |
OAuth KeyStore FilePath | The absolute path and file name of the keystore file. The keystore file contains the keys and certificates that establish a secure connection with Salesforce. Enter the path and file name in the following format: /root/<directory name>/<keystore file name>.jks |
OAuth Private Key Password | The password for the private key entry in the keystore file. |
OAuth Authorization Server | The Salesforce OAuth authorization server endpoint that authorizes the user request. Enter the authorization server endpoint in the following format: https://<host name>.salesforce.com/services/oauth2/token |
OAuth KeyStore Password | The password for the keystore file. |
OAuth Private Key Alias | The unique alias of the private key that signs the JWT payload. |