Salesforce
Ingest your files into Unstructured from Salesforce.
The requirements are as follows.
-
A Salesforce account. Create an account.
-
Your Salesforce username.
-
The Salesforce categories (objects) that you want to access, specified as a comma-separated list. Available categories include
Account
,Campaign
,Case
,EmailMessage
, andLead
. -
The OAuth consumer key (client ID) for the target Salesforce connected app in the account.
-
The contents of the private key (PEM) for the certificate that is associated for the Salesforce connected app. The PEM must be expressed as a single-line string without line breaks. To print this single-line string without line breaks, suitable for copying, you can run one of the following commands from your Terminal or Command Prompt. In this command, replace
<path-to-private-key-file>
with the path to the.pem
file.For macOS or Linux:
For Windows:
To get your Salesforce username, do the following:
- Log in to your Salesforce account.
- In the top navigation bar, click the Quick Settings (gear) icon, and then click Open Advanced Setup.
- In the search box, search for and go to Users.
- Note the Name value (not the User Name value) for your user.
If you do not already have a Salesforce connected app, to create one, start by creating or getting the certificate (.crt
) and private key (.pem
) files
that you will associate with the connected app. If you do not have the certificate and private key, you can use your local machine to create your own
private key and self-signed certificate, if your organization allows, by running the following commands, one command at a time:
Be sure to store these generated files in a secure location.
To create a Salesforce connected app, do the following:
-
Log in to your Salesforce account.
-
In the top navigation bar, click the Quick Settings (gear) icon, and then click Open Advanced Setup.
-
In the search box, search for and go to App Manager.
-
Click New Connected App.
-
With Create a Connected App selected, click Continue.
-
At a minimum, fill in the following, and then click Save:
- Connected App Name
- API Name (can be same as Connected App Name, but do not use spaces or punctuation)
- Contact Email
- Check Enable OAuth Settings.
- For Callback URL, entering
http://localhost
is okay if you won’t be using this connected app for other special authentication scenarios. - Check Use Digital Signatures. Click Choose File, and browse to and select your certificate (
.crt
) file. - For Selected OAuth Scopes, add Manage user data via APIs (api) (recommended) or Full access (full).
To get the Salesforce connected app’s consumer key, do the following:
- Log in to your Salesforce account.
- In the top navigation bar, click the Quick Settings (gear) icon, and then click Open Advanced Setup.
- In the search box, search for and go to App Manager.
- In the list of apps, click the arrow next to the target connected app, and click View.
- Click Manage Consumer Details.
- Complete the on-screen security verification.
- Note the Consumer Key value.
To create the source connector:
- On the sidebar, click Connectors.
- Click Sources.
- Cick New or Create Connector.
- Give the connector some unique Name.
- In the Provider area, click Salesforce.
- Click Continue.
- Follow the on-screen instructions to fill in the fields as described later on this page.
- Click Save and Test.
Fill in the following fields:
- Name (required): A unique name for this connector.
- Username (required): The Salesforce username that has access to the target Salesforce categories (objects).
- Salesforce categories: A comma-separated list of the Salesforce categories to access. Available categories include
Account
,Campaign
,Case
,EmailMessage
, andLead
. - Consumer key (required): The consumer key (client ID) for the target Salesforce connected app.
- Private key (PEM) (required): The private key (PEM) associated with the consumer key for the Salesforce connected app. The PEM is a string that begins with
—–BEGIN RSA PRIVATE KEY—–
and ends with—–END RSA PRIVATE KEY—–
.
Was this page helpful?