Connection String for Salesforce


This page describes how to specify a connection string for Salesforce to create a Salesforce Job connection string, or connect to another Salesforce organization.

Entries into the Sensitive Part field will be stored encrypted in Salesforce. If you want to secure the username also, include it in the field separated by a semi-colon. The key is maintained in-package, and cannot be accessed by Salesforce system administrators.

 

Overcast uses two connection types for Salesforce.

  1. Salesforce Job
  2. Salesforce

Salesforce Job Connection Type

A Salesforce Job connection string is for connecting back to the host organization where Overcast for Salesforce is installed. Overcast will use the SOAP API, Metadata API, REST API, or Bulk API, according to the operation.

The Salesforce user added to this connection string is known as the Technical User.

Use a system administrator level profile with the Overcast Design-Time User permission set assigned.

Do not reuse the Technical User's credentials with other tools. 

Salesforce Connection Type

A Salesforce connection string is for connecting to other Salesforce organizations (backend systems). Overcast will use the SOAP API and the Metadata API for these systems.


Format

Enter the following text into the Connection String field

Username=<salesforce username>; 

Enter the following text into the Sensitive Part field

Password=<password>;


Sample for a Salesforce Production Organization

Enter the following text into the Connection String field

Username=auser@company.com

Enter the following text into the Sensitive Part field

Password=mypassword


Sample for a Salesforce Sandbox Organization

Enter the following text into the Connection String field

Username=auser@company.com; Sandbox=true;

Enter the following text into the Sensitive Part field

Password=mypassword
When entering any password that uses whitespace or special characters, it should be enclosed in double quotes, i.e., Password="my password!";
Each time you create or modify a connection string in Overcast, validate your connection by clicking the Check button. This ensures that the connection string is correct and a connection can be established. This does not validate that the user has sufficient permissions to perform all the actions. Check the permission sets for different roles.

 

Parameter Keys

Key Description
Username Username
Password Password
Sandbox True if connecting to a Sandbox org
URL The scheme + domain of the backend Salesforce. Only required when connecting to another Salesforce org. 

 

Tutorial

1. Go to the Connection Strings tab and select the New button.

 

 

2. Enter a Connection String Name and select "Salesforce" for Connection Type. Note that for this connection string, you are using Salesforce as your backend system, and thus, "Salesforce" must be the Connection Type. This is different in that when you create a connection string to connect to Salesforce as your user interface, you would choose "Salesforce Job" as the Connection Type. Enter your Connection String and its Sensitive Part as described above, and select Save. Description and Named Credential are optional. 

 

3. Select Check to validate your connection. A green checked circle will appear once a successful connection is established.

Troubleshooting

OC-SFA-223 LOGIN_MUST_USE_SECURITY_TOKEN

 

Solution

Append your security token to the password in the Sensitive Part field, without any whitespace between the two.

For example, when the password is mypassword and the security token is XYZ the Sensitive Part field would be

Password=mypasswordXYZ

To get a security token, click your user image, go to Settings > My Personal Information > Reset My Security Token, and select Reset Security Token. You will receive an email.

 

Malformed Connection String

A connection check returns "Malformed Connection String. User details not found..." 

 

Solution

1) You didn't enter a username or password properly. Use user= and password= before each username and password, respectively. Add a ; (semi-colon) to terminate the username only.

 

2)  Your password has whitespace or special characters. Enclose the password in " (quotes), for example, password="xyz-!".