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.

The requirements are as follows.

  • A Salesforce account.

  • Your Salesforce username. To get this username, do the following:

    1. Log in to your Salesforce account.
    2. In the top navigation bar, click the Quick Settings (gear) icon, and then click Open Advanced Setup.
    3. In the Home tab, under Administration, expand Users, and then click Users.
    4. Note the User Name value (not the Name value) for your user.

  • The names of the Salesforce categories (objects) that you want to access, specified as a comma-separated list. Available categories include Account, Campaign, Case, EmailMessage, and Lead.

  • A Salesforce connected app in your Salesforce account.

    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 files, you can use the openssl utility on 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:

    openssl genrsa -out MyPrivateKey.pem -traditional
openssl req -new -key MyPrivateKey.pem -out MyCertificateSigningRequest.csr
openssl x509 -req -in MyCertificateSigningRequest.csr -signkey MyPrivateKey.pem -out MyCertificate.crt -days 365

    Of course, you can change these preceding example filenames as needed. Be sure to store these generated files in a secure location.

    To create a Salesforce connected app, do the following:

    1. Log in to your Salesforce account.

    2. In the top navigation bar, click the Quick Settings (gear) icon, and then click Open Advanced Setup.

    3. In the Home tab, under Platform Tools, expand Apps, and then click App Manager.

    4. Click New Connected App.

    5. With Create a Connected App selected, click Continue.

    6. At a minimum, fill in the following, and then click Save:

      • Connected App Name

      • API Name (can be the same as Connected App Name, but do not use spaces or punctuation)

      • Contact Email

      • Under API (Enable OAuth Settings), check Enable OAuth Settings.

      • For Callback URL, entering https://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, move the following entries from the Available OAuth Scopes list to the Selected OAuth Scopes list:

        • Manage user data via APIs (api)
        • Perform requests on your behalf at any time (refresh_token, offline_access)

      • Uncheck Require Proof Key for Code Exchange (PKCE) Extension for Supported Authorization Flows.

      • Leave Require Secret for Web Server Flow checked.

      • Leave Require Secret for Refresh Token Flow checked.

      • Check Enable Authorization Code and Credentials Flow.

    7. On the connected app’s details page, click Manage, click Edit Policies, set the following under OAuth Policies, and then click Save:

      • Set Permitted Users to All users may self-authorize.
      • Set IP Relaxation to Relax IP restrictions.
      • Set Refresh Token Policy to Refresh token is valid until revoked.

  • The OAuth consumer key (client ID) for the Salesforce connected app.

    To get the Salesforce connected app’s consumer key, do the following:

    1. Log in to your Salesforce account.
    2. In the top navigation bar, click the Quick Settings (gear) icon, and then click Open Advanced Setup.
    3. In the Home tab, under Platform Tools, expand Apps, and then click App Manager.
    4. In the list of apps, click the arrow next to the target connected app, and click View.
    5. Click Manage Consumer Details.
    6. Complete the on-screen security verification.
    7. Note the Consumer Key value.

  • You must use your Salesforce account to do a one-time approval of the Salesforce connected app by using its consumer key and callback URL. To do this, while you are logged in to your Salesforce account, browse to the following URL, replacing <client-id> with the consumer key value. This URL assumes that the callback URL is https://localhost:

    https://login.salesforce.com/services/oauth2/authorize?response_type=code&client_id=<client-id>&redirect_uri=https%3A%2F%2Flocalhost

  • To ensure maximum compatibility across Unstructured service offerings, you should give the contents of the private key (.pem) file to Unstructured as a string that contains the contents of the file (not the private key file itself).
    To print this string 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 private key file.

    • For macOS or Linux:

      cat <path-to-private-key-file>

    • For Windows:

      Get-Content <path-to-private-key-file>

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).

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.

This example sends data to Unstructured for processing by default. To process data locally instead, see the instructions at the end of this page.

#!/usr/bin/env bash

unstructured-ingest \
  salesforce \
    --username $SALESFORCE_USERNAME \
    --consumer-key $SALESFORCE_CONSUMER_KEY \
    --private-key $SALESFORCE_PRIVATE_KEY \
    --categories "EmailMessage,Account,Lead,Case,Campaign" \
    --output-dir $LOCAL_FILE_OUTPUT_DIR \
    --num-processes 2 \
    --recursive \
    --verbose \
    --partition-by-api \
    --api-key $UNSTRUCTURED_API_KEY \
    --partition-endpoint $UNSTRUCTURED_API_URL \
    --strategy hi_res \
    --additional-partition-args="{\"split_pdf_page\":\"true\", \"split_pdf_allow_failed\":\"true\", \"split_pdf_concurrency_level\": 15}"

For the Unstructured Ingest CLI and the Unstructured Ingest Python library, you can use the --partition-by-api option (CLI) or partition_by_api (Python) parameter to specify where files are processed:

  • To do local file processing, omit --partition-by-api (CLI) or partition_by_api (Python), or explicitly specify partition_by_api=False (Python).

    Local file processing does not use an Unstructured API key or API URL, so you can also omit the following, if they appear:

    • --api-key $UNSTRUCTURED_API_KEY (CLI) or api_key=os.getenv("UNSTRUCTURED_API_KEY") (Python)
    • --partition-endpoint $UNSTRUCTURED_API_URL (CLI) or partition_endpoint=os.getenv("UNSTRUCTURED_API_URL") (Python)
    • The environment variables UNSTRUCTURED_API_KEY and UNSTRUCTURED_API_URL

  • To send files to the Unstructured Partition Endpoint for processing, specify --partition-by-api (CLI) or partition_by_api=True (Python).

    Unstructured also requires an Unstructured API key and API URL, by adding the following:

    • --api-key $UNSTRUCTURED_API_KEY (CLI) or api_key=os.getenv("UNSTRUCTURED_API_KEY") (Python)
    • --partition-endpoint $UNSTRUCTURED_API_URL (CLI) or partition_endpoint=os.getenv("UNSTRUCTURED_API_URL") (Python)
    • The environment variables UNSTRUCTURED_API_KEY and UNSTRUCTURED_API_URL, representing your API key and API URL, respectively.

    You must specify the API URL only if you are not using the default API URL for Unstructured Ingest, for example, if you are using a self-hosted instance of the Unstructured API.

    The default API URL for Unstructured Ingest is https://api.unstructuredapp.io/general/v0/general, which is the API URL for the Unstructured Partition Endpoint. However, you should always use the URL that was provided to you when your Unstructured account was created. If you do not have this URL, contact Unstructured Sales at sales@unstructured.io.

    If you do not have an API key, get one now.

    If the Unstructured API is self-hosted, the process for generating Unstructured API keys, and the Unstructured API URL that you use, are different. For details, contact Unstructured Sales at sales@unstructured.io.