How to 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 the 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

Use the OAuth 2.0 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 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 is 123 then enter xyz123 for the Password.
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. At the bottom of the form, click the Test Authentication button to confirm connectivity to Salesforce using these details.
9. 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:

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, click OAuth 2.0 JWT Bearer.
3. For Username, enter the new 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. The private key encrypted with the RSA256 algorithm will have the following format:

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

7. At the bottom of the form, click the Test Authentication button to confirm connectivity to Salesforce using these details.
8. When successful, at the bottom of the screen click the Next button.

Configure the 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.
   🚨 Careful! If you do not specify any user or group, nobody will be able to manage the connection — not even admins.
3. At the bottom of the screen, click Next to proceed.

Configure the 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 the crawler

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

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 will see the assets in Atlan's asset page! 🎉