Salesforce

Connect Salesforce to your preprocessing pipeline, and batch process Salesforce data using unstructured-ingest to store structured outputs locally on your filesystem.

First you’ll need to install the Salesforce dependencies as shown here.

pip install "unstructured[salesforce]"

Run Locally

Shell

#!/usr/bin/env bash

unstructured-ingest \
  salesforce \
  --username "$SALESFORCE_USERNAME" \
  --consumer-key "$SALESFORCE_CONSUMER_KEY" \
  --private-key "$SALESFORCE_PRIVATE_KEY_PATH" \
  --categories "EmailMessage,Account,Lead,Case,Campaign" \
  --output-dir salesforce-output \
  --num-processes 2 \
  --recursive \
  --verbose

import os

from unstructured.ingest.connector.salesforce import SalesforceAccessConfig, SimpleSalesforceConfig
from unstructured.ingest.interfaces import PartitionConfig, ProcessorConfig, ReadConfig
from unstructured.ingest.runner import SalesforceRunner

if __name__ == "__main__":
    runner = SalesforceRunner(
        processor_config=ProcessorConfig(
            verbose=True,
            output_dir="salesforce-output",
            num_processes=2,
        ),
        read_config=ReadConfig(),
        partition_config=PartitionConfig(),
        connector_config=SimpleSalesforceConfig(
            access_config=SalesforceAccessConfig(
                consumer_key=os.getenv("SALESFORCE_CONSUMER_KEY"),
            ),
            username=os.getenv("SALESFORCE_USERNAME"),
            private_key_path=os.getenv("SALESFORCE_PRIVATE_KEY_PATH"),
            categories=["EmailMessage", "Account", "Lead", "Case", "Campaign"],
            recursive=True,
        ),
    )
    runner.run()

Run via the API

You can also use upstream connectors with the unstructured API. For this you’ll need to use the --partition-by-api flag and pass in your API key with --api-key.

Shell

#!/usr/bin/env bash

unstructured-ingest \
  salesforce \
  --username "$SALESFORCE_USERNAME" \
  --consumer-key "$SALESFORCE_CONSUMER_KEY" \
  --private-key "$SALESFORCE_PRIVATE_KEY_PATH" \
  --categories "EmailMessage,Account,Lead,Case,Campaign" \
  --output-dir salesforce-output \
  --num-processes 2 \
  --recursive \
  --verbose \
  --partition-by-api \
  --api-key "$UNSTRUCTURED_API_KEY"

import os

from unstructured.ingest.connector.salesforce import SalesforceAccessConfig, SimpleSalesforceConfig
from unstructured.ingest.interfaces import PartitionConfig, ProcessorConfig, ReadConfig
from unstructured.ingest.runner import SalesforceRunner

if __name__ == "__main__":
    runner = SalesforceRunner(
        processor_config=ProcessorConfig(
            verbose=True,
            output_dir="salesforce-output",
            num_processes=2,
        ),
        read_config=ReadConfig(),
        partition_config=PartitionConfig(
            partition_by_api=True,
            api_key=os.getenv("UNSTRUCTURED_API_KEY"),
        ),
        connector_config=SimpleSalesforceConfig(
            access_config=SalesforceAccessConfig(
                consumer_key=os.getenv("SALESFORCE_CONSUMER_KEY"),
            ),
            username=os.getenv("SALESFORCE_USERNAME"),
            private_key=os.getenv("SALESFORCE_PRIVATE_KEY_PATH"),
            categories=["EmailMessage", "Account", "Lead", "Case", "Campaign"],
            recursive=True,
        ),
    )
    runner.run()

Additionally, you will need to pass the --partition-endpoint if you’re running the API locally. You can find more information about the unstructured API here.

For a full list of the options the CLI accepts check unstructured-ingest salesforce --help.

NOTE: Keep in mind that you will need to have all the appropriate extras and dependencies for the file types of the documents contained in your data storage platform if you’re running this locally. You can find more information about this in the installation guide.