Once you have configured the Salesforce user permissions, you can establish a connection between Atlan and Salesforce.
To crawl metadata from Salesforce, complete the following steps.
Select the source
To select Salesforce as your source:
- In the top right of any screen in Atlan, navigate to New and click New Workflow.
- From the list of packages, click Salesforce Assets.
- In the right panel, click Setup Workflow.
Provide credentials
Use the OAuth 2.0 username-password flow
To enter your Salesforce credentials:
- For Host Name, enter the full URL for your Salesforce instance, including the
https://
. - For Authentication, keep the default option Resource Owner.
- For Username, enter the integration user's email address.
- For Password, enter the concatenation of the user's password and the user's personal security token.
π¨ Careful! Entering either password or personal security token alone will be insufficient. For example, if your user password is
xyz
and your security token is123
then enterxyz123
for the Password. - For Consumer Key, enter the consumer key for the connected app.
- For Consumer Secret, enter the consumer secret for the connected app.
- At the bottom of the form, click the Test Authentication button to confirm connectivity to Salesforce using these details.
- When successful, at the bottom of the screen click the Next button.
Use the OAuth 2.0 JWT bearer flow
To enter your Salesforce credentials:
- For Host Name, enter the full URL for your Salesforce instance, including the
https://
. - For Authentication, click OAuth 2.0 JWT Bearer.
- For Username, enter the new user's email address.
- For Consumer Key, enter the consumer key for the connected app.
- For Encrypted Private Key, enter the private key in the
server.key
file. - At the bottom of the form, click the Test Authentication button to confirm connectivity to Salesforce using these details.
- When successful, at the bottom of the screen click the Next button.
Configure the connection
To complete the Salesforce connection configuration:
- Provide a Connection Name that represents your source environment. For example, you might want to use values like
production
,development
,gold
, oranalytics
. - (Optional) To change the users able to manage this connection, change the users or groups listed under Connection Admins.
π¨ Careful! If you do not specify any user or group, nobody will be able to manage the connection β not even admins.
Configure the crawler
Before running the Salesforce crawler, you can further configure it.
On the Metadata page:
- For Extract reports, click Yes if you'd like to extract report metadata or click No.
Run the crawler
To run the Salesforce crawler, after completing the steps above:
- You can either:
- To run the crawler once immediately, at the bottom of the screen, click the Run button.
- To schedule the crawler to run hourly, daily, weekly, or monthly, at the bottom of the screen, click the Schedule & Run button.
Once the crawler has completed running, you will see the assets in Atlan's asset page! π