Crawl Salesforce

Once you have configured the Salesforce user permissions, you can establish a connection between Atlan and Salesforce.

To crawl metadata from Salesforce, review the order of operations and then complete the following steps.

Select source

To select Salesforce as your source:

1. In the top right of any screen in Atlan, navigate to New and click New Workflow.
2. From the list of packages, click Salesforce Assets.
3. In the right panel, click Setup Workflow.

Provide credentials

Enter credentials for your Salesforce integration in Atlan. The required fields vary depending on the authentication flow you choose.

JWT bearer flow

To enter your Salesforce credentials:

1. For Host Name, enter the full URL for your Salesforce instance, including the https://. For example, https://MyDomainName.my.salesforce.com.
2. For Authentication, select OAuth 2.0 JWT Bearer.
3. For Username, enter the integration user's email address.
4. For Is this a Sandbox Org account?, change to Yes if your org is a copy of your production org.
5. For Consumer Key, enter the consumer key for the connected app.
6. For Encrypted Private Key, enter the private key from the server.key file in RSA256 format:

   -----BEGIN PRIVATE KEY-----
   MIIEvgIBADANBgkqhkiG.......
   -----END PRIVATE KEY-----

7. Click Test Authentication at the bottom of the form to confirm connectivity.
8. When successful, click Next at the bottom of the screen.

Client credentials flow

To enter your Salesforce credentials:

1. For Host Name, enter the full URL for your Salesforce instance, including the https://. For example, https://MyDomainName.my.salesforce.com.
2. For Authentication, select OAuth 2.0 Client Credentials.
3. For Consumer Key (Client ID), enter the Consumer Key from the external client app.
4. For Consumer Secret (Client Secret), enter the Consumer Secret from the external client app.
5. Click Test Authentication at the bottom of the form to confirm connectivity.
6. When successful, click Next at the bottom of the screen.

Username-password flow

To enter your Salesforce credentials:

1. For Host Name, enter the full URL for your Salesforce instance, including the https://. For example, https://MyDomainName.my.salesforce.com.
2. For Authentication, keep the default option Resource Owner.
3. For Username, enter the integration user's email address.
4. For Password, enter the concatenation of the user's password and the personal security token. Entering either password or personal security token alone is insufficient. For example, password xyz + token 123 → enter xyz123.
5. For Is this a Sandbox Org account?, change to Yes if your org is a copy of your production org.
6. For Consumer Key, enter the consumer key for the connected app.
7. For Consumer Secret, enter the consumer secret for the connected app.
8. Click Test Authentication at the bottom of the form to confirm connectivity.
9. When successful, click Next at the bottom of the screen.

Configure connection

To complete the Salesforce connection configuration:

1. Provide a Connection Name that represents your source environment. For example, you might want to use values like production, development, gold, or analytics.
2. (Optional) To change the users able to manage this connection, change the users or groups listed under Connection Admins. If you don't specify any user or group, nobody can manage the connection - not even admins.
3. At the bottom of the screen, click Next to proceed.

Configure crawler

Before running the Salesforce crawler, you can further configure it.

On the Metadata page:

1. For Extract reports, click Yes if you'd like to extract report metadata or click No.
2. For Extract dashboards, click Yes if you'd like to extract dashboard metadata or click No.

Run crawler

To run the Salesforce crawler, after completing the previous steps:

1. To check for any permissions or other configuration issues before running the crawler, click Preflight checks.
2. 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 can see the assets in Atlan's asset page! 🎉