Running the Salesforce collector on-premise
Note
The latest version of the Collector is 2.251. To view the release notes for this version and all previous versions, please go here.
Generating the command or YAML file
This section walks you through the process of generating the command or YAML file for running the collector from Windows or Linux or MAC OS.
To generate the command or YAML file:
On the Organization profile page, go to the Settings tab > Metadata collectors section.
Click the Add a collector button.
On the Choose metadata collector screen, select the correct metadata source. Click Next.
On the Choose where the collector will run screen, in the On-premise section, select if you will be running the collector on Windows or Mac OS or Linux. This will determine the format of the YAML and CLI that is generated in the end. Click Next.
On the On-prem collector setup prerequisites screen, read the pre-requisites and click Next.
On the Salesforce Collector requires an additional driver file screen, set the JDBC driver directory. Click Next.
On the Configure an on-premises Salesforce Collector screen, set the following properties and click Next.
On the next screen set the following properties and click Next.
Table 2.Field name
Corresponding parameter name
Description
Required?
Salesforce Hostname
--host=<host_name>
Specify the host name of the Salesforce instance using the following format:
<organization_domain><--optional-sandbox_name.sandbox>.my.salesforce.com. Do not include the protocol https
For example, for a production environment, it might look like acme.my.salesforce.com, and for a sandbox environment, it could be acme--dev.sandbox.my.salesforce.com
Yes
Username
-u= <user>
--username= <user>
The username to use to make the JDBC connection.
Yes
Password
-P= <password>
--password= <password>
The password of the user.
Yes
Security Token
-T= <securityToken>
--DW_SALESFORCE_TOKEN= <securityToken>
Personal security token for the provided Salesforce credentials.
No
Salesforce OAuth Client ID
--client-id=<DW_SALESFORCE_CLIENT_ID>
Specify the OAuth client ID for the Salesforce connected app on the instance.
Yes
Salesforce OAuth Client Secret
--client-secret=<DW_SALESFORCE_SECRET>
Specify the OAuth client secret for the Salesforce connected app on the instance.
Yes
Ignore the parameters on the next screen as they are not in use. Click Next.
Table 3.Field name
Corresponding parameter name
Description
Required?
Regex to Match Objects
--include-object=<includedObjects>
Specify one or more regular expressions to match Salesforce objects that should be included. Default is to include all objects.
No
Number of Related Objects to Navigate
--related-object-depth=<relatedObjectDepth>
Specify the number of related (parent-child) object relationships to navigate. Default is to navigate all relationships.
No
Number of Objects to Batch Query
--query-batch-size=<objectQueryBatchSize>
Specify the number of Salesforce objects to query as a batch. Default is 20.
No
Max retries
--api-max-retries=<maxRetries>
Specify the amount of times to retry an API call which has failed. The default value is 5.
No
Retry delay
--api-retry-delay=<retryDelay>
Specify the amount of time in seconds to wait between retries of an API call which has failed. The default is to try increasing intervals starting at 2 seconds.
No
On the next screen, provide the Collector configuration name. This is the name used to save the configuration details. The configuration is saved and made available on the Metadata collectors summary page from where you can edit or delete the configuration at a later point. Click Save and Continue.
On the Finalize your Salesforce Collector configuration screen, you are notified about the environment variables and directories you need to setup for running the collector. Select if you want to generate a Configuration file( YAML) or Command line arguments (CLI). Click Next.
Important
You must ensure that you have set up these environment variables and directories before you run the collector.
The next screen gives you an option to download the YAML configuration file or copy the CLI command. Click Done. If you are generating a YAML file, click Next.
The Salesforce command screen gives you the command to use for running the collector using the YAML file.
You will notice that the YAML/CLI has following additional parameters that are automatically set for you.
Important
Except for the collector version, you should not change the values of any of the parameter listed here.
Table 4.Parameter name
Details
Required?
-a= <agent>
--agent= <agent>
--account= <agent>
The ID for the data.world account into which you will load this catalog - this is used to generate the namespace for any URIs generated.
Yes
--site= <site>
This parameter should be set only for Private instances. Do not set it for public instances and single-tenant installations. Required for private instance installations.
Yes (required for private instance installations)
-U
--upload
Whether to upload the generated catalog to the organization account's catalogs dataset.
Yes
dwcc: <CollectorVersion>
The version of the collector you want to use (For example,
datadotworld/dwcc:2.168)Yes
Add the following additional parameter to test run the collector.
--dry-run: If specified, the collector does not actually harvest any metadata, but just checks the connection parameters provided by the user and reports success or failure at connecting.
We recommend enabling debug level logs when running the collector for the first time. This approach aids in swiftly troubleshooting any configuration and connection issues that might arise during collector runs. Add the following parameter to your collector command:
-e log_level=DEBUG: Enables debug level logging for collectors.
Verifying environment variables and directories
Verify that you have set up all the required environment variables that were identified by the Collector Wizard before running the collector. Alternatively, you can set these credentials in a credential vault and use a script to retrieve those credentials.
Verify that you have set up all the required directories that were identified by the Collector Wizard.
Running the collector
Important
Before you begin running the collector make sure you have completed the pre-requisite tasks.
Running collector using YAML file
Go to the machine where you have setup docker to run the collector.
Place the YAML file generated from the Collector wizard to the correct directory.
From the command line, run the command generated from the application for executing the YAML file.
Caution
Note that is just a sample command for showing the syntax. You must generate the command specific to your setup from the application UI.
docker run -it --rm --mount type=bind,source=${HOME}/dwcc,target=/dwcc-output \ --mount type=bind,source=${HOME}/dwcc,target=/app/log --mount type=bind,source=${HOME}/dwcc-drivers,target=/usr/src/dwcc-config/lib \ -e DW_AUTH_TOKEN=${DW_AUTH_TOKEN} -e DW_SALESFORCE_PASSWORD=${DW_SALESFORCE_PASSWORD} \ -e DW_SALESFORCE_TOKEN=${DW_SALESFORCE_TOKEN} datadotworld/dwcc:2.230 \ --config-file=/dwcc-output/config-salesforce.ymlIf you are running the collector using Jar files, be sure to edit the command as instructed on this page.
The collector automatically uploads the file to the specified dataset and you can also find the output at the location you specified while running the collector. Similarly, the log files are uploaded to the specified dataset and can be found in the directory mounted to target=/app/log specified in the command.
If you decide in the future that you want to run the collector using an updated version, simply modify the collector version in the provided command. This will allow you to run the collector with the latest version.
Running collector without the YAML file
Go to the machine where you have setup docker to run the collector.
From the command line, run the command generated from the application. Here is a sample command.
Caution
Note that is just a sample command for showing the syntax. You must generate the command specific to your setup from the application UI.
docker run -it --rm --mount type=bind,source=${HOME}/dwcc,target=/dwcc-output \ --mount type=bind,source=${HOME}/dwcc,target=/app/log --mount type=bind,source=${HOME}/dwcc-drivers,target=/usr/src/dwcc-config/lib \ datadotworld/dwcc:2.230 catalog-salesforce --agent=8bank-catalog-sources \ --site=solutions --no-log-upload=false --upload=true --api-token=${DW_AUTH_TOKEN} \ --name=8bank-catalog-sources-collection --output=/dwcc-output \ --upload-location=ddw-catalogs --host=host_name --username=8bank-user --password=${DW_SALESFORCE_PASSWORD} \ --security-token=${DW_SALESFORCE_TOKEN} --client-id=${DW_SALESFORCE_CLIENT_ID} --client-secret=${DW_SALESFORCE_SECRET}If you are running the collector using Jar files, be sure to edit the command as instructed on this page.
The collector automatically uploads the file to the specified dataset and you can also find the output at the location you specified while running the collector. Similarly, the log files are uploaded to the specified dataset and can be found in the directory mounted to target=/app/log specified in the command.
If you decide in the future that you want to run the collector using an updated version, simply modify the collector version in the provided command. This will allow you to run the collector with the latest version.
Collector runtime and troubleshooting
The catalog collector may run in several seconds to many minutes depending on the size and complexity of the system being crawled.
If the catalog collector runs without issues, you should see no output on the terminal, but a new file that matching *.dwec.ttl should be in the directory you specified for the output.
If there was an issue connecting or running the catalog collector, there will be either a stack trace or a *.log file. Both of those can be sent to support to investigate if the errors are not clear.
A list of common issues and problems encountered when running the collectors is available here.
Automating updates to your metadata catalog
Maintaining an up-to-date metadata catalog is crucial and can be achieved by employing Azure Pipelines, CircleCI, or any automation tool of your preference to execute the catalog collector regularly.
There are two primary strategies for setting up the collector run times:
Scheduled: You can configure the collector according to the anticipated frequency of metadata changes in your data source and the business need to access updated metadata. It's necessary to account for the completion time of the collector run (which depends on the size of the source) and the time required to load the collector's output into your catalog. This could be for instance daily or weekly. We recommend scheduling the collector run during off-peak times for optimal performance.
Event-triggered: If you have set up automations that refresh the data in a source technology, you can set up the collector to execute whenever the upstream jobs are completed successfully. For example, if you're using Airflow, Github actions, dbt, etc., you can configure the collector to automatically run and keep your catalog updated following modifications to your data sources.
Managing collector runs and configuration details
From the Metadata collectors summary page, view the collectors runs to ensure they are running successfully,
From the same Metadata collectors summary page you can view, edit, or delete the configuration details for the collectors.