Skip to main content

Salesforce

Extract Salesforce metadata into Catalog using the castor-extractor package.

Prerequisites​

Installation Required

Follow the castor-extractor installation instructions before running the extraction.

We strongly recommend creating a dedicated user to extract your metadata.

Follow the instructions for creating the Catalog user on Salesforce to create the catalog user.

Run Extraction Script​

Once the package has been installed, you should be able to run the following command in your terminal:

castor-extract-salesforce [arguments]

Credentials​

  • -u, --username: Salesforce username
  • -p, --password: Salesforce password
  • -c, --client-id: Salesforce client ID
  • -s, --client-secret: Salesforce client secret
  • -t, --security-token: Salesforce security token
  • -b, --base-url: Salesforce instance URL

Other Arguments​

  • -o, --output: target folder to store the extracted files

Optional Arguments​

  • --skip-existing: Skip files already extracted instead of replacing them
Help

You can also get help with the --help argument.