This page was recently updated. What do you think about it? Let us know!.

Connect Salesforce to your preprocessing pipeline, and use the Unstructured Ingest CLI or the Unstructured Ingest Python library to batch process all your documents and store structured outputs locally on your filesystem.

You will need:

The Salesforce prerequisites:

  • A Salesforce account. Create an account.
  • The Salesforce categories (objects) that you want to access, specified as a comma-separated list. Available categories include Account, Case, Campaign, EmailMessage, and Lead.
  • The OAuth consumer key (client ID) and private key (PEM) for the Salesforce connected app. The PEM is a string that begins with —–BEGIN RSA PRIVATE KEY—– and ends with —–END RSA PRIVATE KEY—–. Create a connected app. Get the consumer key. Get the private key.

The Salesforce connector dependencies:

CLI, Python
pip install "unstructured-ingest[salesforce]"

You might also need to install additional dependencies, depending on your needs. Learn more.

The following environment variables:

  • SALESFORCE_USERNAME - The Salesforce username that has access to the required Salesforce categories, represented by --username (CLI) or username (Python).
  • SALESFORCE_CONSUMER_KEY - The consumer key (client ID) for the Salesforce connected app, represented by --consumer-key (CLI) or consumer_key (Python).
  • SALESFORCE_PRIVATE_KEY - The contents of the private key (PEM) associated with the consumer key for the Salesforce connected app, represented by --private-key (CLI) or private_key (Python), or
  • SALESFORCE_PRIVATE_KEY_PATH - The local path to the (PEM) associated with the consumer key for the Salesforce connected app, represented by --private-key-path (CLI) or private_key_path (Python).

These environment variables:

  • UNSTRUCTURED_API_KEY - Your Unstructured API key value.
  • UNSTRUCTURED_API_URL - Your Unstructured API URL.

Now call the Unstructured Ingest CLI or the Unstructured Ingest Python library. The destination connector can be any of the ones supported. This example uses the local destination connector:

Was this page helpful?