--- sourceDocument: Brazil Workflow Data Fabric sourceDocumentLink: https://www.servicenow.com/docs/r/integrate-applications Release : - brazil ft:locale : - en-US ft:publication_title : - Brazil Workflow Data Fabric ft:clusterId : - crint bundleId : - crint workflow : - Creator --- # Create a Salesforce metadata collector # Create a Salesforce metadata collector {#ariaid-title1} Release version: Brazil Updated July 28, 2026 ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 minutes to read Create a collector to import metadata from Salesforce. ## Before you begin Before you begin, verify the following: * All per-requisite tasks are completed. For more information, see [Prepare to run the Salesforce collector](https://www.servicenow.com/docs/SKSYSr0nJ22dZmDEmCWlyw "Set up access for cataloging Salesforce resources by configuring user credentials, security tokens, and connected applications."). * If you plan to run the collector on-premise, a MID Server is setup for the collector. For more information, see [MID Server for metadata collectors](https://www.servicenow.com/docs/2l_oawHD8jDgqUJN6Gaorw "When your source is behind a firewall or requires on-premises handling, deploy metadata collectors on a MID Server you host to harvest metadata from on-premises and privately networked data sources."). * Role required: connection-admin {#create-salesforce-metadata-collector__ul_pvj_mz5_bjc} ## Procedure 1. Navigate to AllWorkflow Data FabricWorkflow Data Fabric Home. 2. Select the Connect Hub ![Connect Hub icon]() icon in the left sidebar. 3. Select CreateMetadata collector. 4. From the System list, select Salesforce. 5. From the Connection type list, select one of the following: 1. Select New connection to configure a new connection. 2. Select Existing connection to reuse an existing connection and select an existing connection from the Connections list. The configuration form is filled with details from the existing connection. The name is appended with the word Copy and sensitive details like password aren't copied. {#create-salesforce-metadata-collector__substeps_lgh_q4y_jjc} 6. Complete the form. {#create-salesforce-metadata-collector__table_axw_2j2_h3c__entry__2} | Field | Description | |-|-| | Connection name | Unique identifier for the connection. This field can't be modified once the connection is established. | | Short description | Purpose and details of the connection. | [Table 1. Salesforce metadata collector form] {#create-salesforce-metadata-collector__table_axw_2j2_h3c} 7. Configure the connection options. {#create-salesforce-metadata-collector__table_s3_collector_props__entry__2} | Field | Description | |-|-| | Use MID server | Option to connect to the source system through a MID Server. When selected, the MID selection options appear. | | MID selection | MID Server routing option for the collector job. This field appears only when Use MID server is selected. * Auto-Select MID Server --- The system selects an available MID Server at job execution time. Default selection. * Specific MID Server --- The collector job runs on the selected MID Server. If the MID Server is offline at job execution time, the job fails with an error identifying the MID Server by name. * Specific MID Cluster --- The collector job runs on any available MID Server within the selected cluster. | | MID Server | MID Server to use for the collector job. This field appears only when Specific MID Server is selected. The selected MID Server is saved on the collector record and used for all subsequent collection runs until changed. | | MID Cluster | MID cluster to use for the collector job. This field appears only when Specific MID Cluster is selected. The selected cluster is saved on the collector record; any available MID Server within the cluster may serve the job. | | Capabilities | One or more capability labels that restrict auto-selection to MID Servers advertising those capabilities. This field appears only when Auto-Select MID Server is selected. | | MID application | MID Server application to use for the collector job. This field appears only when Auto-Select MID Server is selected. | | Salesforce Hostname | The host name of the Salesforce instance using the following format: \\<--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 | [Table 2. Connection options] {#create-salesforce-metadata-collector__table_s3_collector_props} 8. Configure the authentication options. {#create-salesforce-metadata-collector__table_ynn_hy1_gkc__entry__2} | Field | Description | |-|-| | Authenticate using OAuth refresh token || | Salesforce OAuth refresh token | The Salesforce OAuth refresh token to use in authenticating the collector via the Authorization Code flow. | | Authenticate using username and password || | Username | The username to use to make the JDBC connection. | | Password | The password of the user. | | Security Token | Personal security token for the provided [Salesforce credentials](https://www.servicenow.com/docs/SKSYSr0nJ22dZmDEmCWlyw "Set up access for cataloging Salesforce resources by configuring user credentials, security tokens, and connected applications."). | | OAuth client ID and secret || | Salesforce OAuth client ID | OAuth client ID for the Salesforce connected app on the instance. | | Salesforce OAuth client secret | OAuth client secret for the Salesforce connected app on the instance. | [Table 3. Authentication options] {#create-salesforce-metadata-collector__table_ynn_hy1_gkc} 9. Configure the connection and reliability options. {#create-salesforce-metadata-collector__table_njt_klb_gkc__entry__2} | Field | Description | |-|-| | Query batch size | Number of Salesforce objects to query as a batch. Default: 20 | | Related object depth | Number of related (parent-child) object relationships to navigate. Default is to navigate all relationships. | | Include objects | Specify one or more regular expressions to match Salesforce objects that should be included. Default is to include all objects. | | Max retries | Number of times the system retries a failed API call. Default: 5 | | Retry delay | Number of seconds to wait between retry attempts for a failed API call. Default: 2 seconds | [Table 4. Connection and reliability options] {#create-salesforce-metadata-collector__table_njt_klb_gkc} 10. Select Save. ## Result The metadata collector is created and appears on the Connectors page with a Configured status. It is now ready to connect to the source system and harvest metadata. ## What to do next After creating the collector, you can perform any of the following tasks: * Run the collector manually to harvest metadata immediately. See [Run metadata collectors manually](https://www.servicenow.com/docs/aQKuJd5j3lCXk75ya17e~A "Execute a metadata collector on-demand to import metadata immediately."). * Automate metadata collection by scheduling regular collector runs. See [Schedule metadata collector runs](https://www.servicenow.com/docs/asZ0rH6fgXYHaoh9wK~UWw "Schedule a metadata collector to run automatically at a specified frequency."). * Monitor execution status and troubleshoot issues by viewing the runtime logs. See [View runtime logs for collector runs](https://www.servicenow.com/docs/k1TsyTx6kPU1XTWQB9VJdA "Access execution logs and download detailed log files for metadata collector runs."). * Discover and evaluate the harvested data assets in the Data Catalog. See [Governing the Data Catalog](https://www.servicenow.com/docs/0K_ULy_QruQwo4Xz2_VT8w "Data stewards add business context to catalog assets, making them more discoverable for catalog consumers. Governance tools include glossary terms, tags, domains, and direct asset updates."). {#create-salesforce-metadata-collector__ul_glx_vk3_bkc} *[\>]: and then