Salesforce Hybrid Runner

• Requirements
• Metadata Ingestion
• Enable Security
• Troubleshooting

​

Requirements

• API Access: You must have the API Enabled permission in your Salesforce organization.
• Object Permissions: You must have read access to the Salesforce objects that you want to ingest.

​

Metadata Ingestion

​

Step 1: Add New Service

1. In the left navigation, click Connections.
2. On the Connections page, click Add New Service.

​

Step 2: Select a Service and Connector

​

Step 3: Add Service Name and Description

• Enter a unique, descriptive Service Name. Collate identifies services by their service name. Enter a name that distinguishes this deployment from other Salesforce services you are ingesting metadata from.
• Optional: Enter a Description for the service.

​

Step 4: Configure Connection Options

​

Select Ingestion Runner

​

Enter Connection Details

password: secret:/my/database/password

• OAuth 2.0 client credentials flow: Use Consumer Key and Consumer Secret without Username or Password. This requires a Salesforce My Domain value in the Salesforce Domain field, such as mycompany.my. It does not work with the default login or test domains.
• OAuth 2.0 password flow: Use Consumer Key and Consumer Secret together with Username and Password. Use this flow when Salesforce Domain is login or test.
  • Consumer Key: Salesforce Consumer Key (Client ID) for OAuth 2.0 authentication.
  • Consumer Secret: Salesforce Consumer Secret (Client Secret) for OAuth 2.0 authentication.
• Username / Password (Legacy)
  Important: Salesforce is deprecating direct username/password API access. Migrate to OAuth 2.0 using a Connected App (External Client App) to avoid future disruption. See Salesforce OAuth documentation.
  • Username: Username to connect to Salesforce. This user should have the access defined in the requirements.
  • Password: Password to connect to Salesforce.
  • Security Token: Salesforce Security Token for legacy username/password authentication. Use this only when you are not using Consumer Key and Consumer Secret. You can check this doc to get the token.

• Organization ID: Salesforce Organization ID is the unique identifier for your Salesforce identity. You can check out this doc on how to get your Salesforce Organization ID.
  Note: You need to provide the 15 digit organization ID in this section, for example 00DIB000004nDEq, which you can find by following the steps in the doc above (Salesforce dashboard -> Setup -> Company Profile -> Company Information -> Salesforce.com Organization Id).
  Note: If you want to access Salesforce metadata without a token and only use the organization ID, you need to set up your IP in trusted IP ranges. Go to Salesforce dashboard -> Setup -> Security -> Network Access -> Trusted IP Ranges to configure this. You can check here for details.
• Salesforce Object Names: List the Salesforce object names to ingest. If you leave this blank, Collate ingests all available objects that pass the filter pattern.
• Database Name: Optional name to use for the database in Collate. If left blank, the connector uses the default database name.
• Salesforce API Version: Follow the steps mentioned here to get the API version. Enter the numeric value in the field, for example 62.0. The connector defaults to 42.0. Use a version supported by your Salesforce org and update it when Salesforce retires older API versions. The constraint depends on your authentication method:
  • OAuth 2.0: Any supported Salesforce API version works, including the default 42.0.
  • Username / Password (Legacy): Use version 64.0 or lower. Salesforce removed SOAP API login support in version 65.0 and later — using 65.0 or higher with username/password authentication will cause authentication to fail.
• Salesforce Domain: Specify the Salesforce domain (subdomain only) to use for authentication. This field accepts only the domain prefix, not the full URL. Common values:
  • login (default) - For production instances (resolves to https://login.salesforce.com)
  • test - For sandbox instances (resolves to https://test.salesforce.com)
  For Salesforce My Domain: Enter your custom domain prefix, including all subdomain components such as .my or .sandbox.my, but without .salesforce.com. Examples:
  • If your My Domain URL is https://mycompany.my.salesforce.com, enter: mycompany.my
  • If your sandbox My Domain URL is https://mycompany--uat.sandbox.my.salesforce.com, enter: mycompany--uat.sandbox.my
  • If your URL is https://example-dot-com--uat.sandbox.my.salesforce.com, enter: example-dot-com--uat.sandbox.my
  Note: Important: Do NOT enter the full URL or include .salesforce.com. Only enter the subdomain prefix as shown in the examples above.

​

Advanced Configuration

• Connection Options (Optional): Enter the details for any additional connection options that can be sent to database during the connection. These details must be added as Key-Value pairs.
• Connection Arguments (Optional): Enter the details for any additional connection arguments such as security or protocol configs that can be sent during the connection. These details must be added as Key-Value pairs.

​

Test Connection

​

Step 5: Configure Ingestion Options

​

How Filter Patterns Work

• Include: Add one or more comma-separated regular expressions. Collate ingests only assets whose names match at least one expression. Leave blank to include all assets.
• Exclude: Add one or more comma-separated regular expressions. Collate skips any asset whose name matches an expression. Leave blank to exclude nothing.

• contains: matches any name containing the value. For example, sales matches my_sales_data and sales_2024.
• starts with: matches names beginning with the value. For example, prod_ matches prod_db and prod_schema.
• ends with: matches names ending with the value. For example, _raw matches events_raw and logs_raw.
• is exactly: matches the exact name only. For example, analytics matches only analytics.
• matches regex: matches names using a regular expression. For example, ^prod_.*_v\d+$ matches prod_events_v1.

• Database: Controls which databases Collate ingests from the source.
• Schema: Controls which schemas within the ingested databases are included.
• Table: Controls which tables and views within the ingested schemas are included.
• Stored Procedure: Controls which stored procedures are included in metadata ingestion.

• Scan Mode: You can choose between the following scan modes:
  • Scan all: Ingests every asset of that type the connector can access. This is the default.
  • Only specific: Enables include rules so only assets matching at least one rule are ingested.
• Exclude system toggle: Use this toggle to automatically filter out system-reserved names defined by the connector — for example, Exclude system databases for the Databases section.
• Always exclude: Add permanent exclusion rules (shown in red). Assets matching these rules are never ingested, regardless of include rules.
• Preview: Shows a real-time summary of what will be in scope based on your current rules.
• Include rules (available only in Only specific mode): Click + Add to define a rule. Added rules appear as chips; an asset is included if it matches any rule.

​

Step 6: Create & Deploy

​

Configure Metadata Agent and Schedule Ingestion

1. In the left navigation, click Connections and select your service.
2. Click the Agents tab.
3. Click Add Agent and select Metadata from the dropdown. For some services, the dropdown is not available and clicking Add Agent takes you directly to the agent configuration page.
4. On the Configure Ingestion page, do the following and click Next.
   • Name this Ingestion: Enter a unique recognizable name for this ingestion pipeline.
   • Agent Setup: Configure core parameters for metadata extraction. The following fields are available:

     Field	Default	Description
     Default Owner	—	Owner applied to all entities when no specific level owner is configured. Accepts a user or team name/email.
     Service Owner	—	Owner assigned to the service entity.
     Database Owner	—	Owner assigned to all ingested databases. Accepts a single owner or a per-database name mapping.
     Database Schema Owner	—	Owner assigned to all ingested schemas. Accepts a single owner or a per-schema name mapping.
     Table Owner	—	Owner assigned to all ingested tables. Accepts a single owner or a per-table name mapping.
     Enable Inheritance	On	When on, child entities inherit the owner from their parent when they have no owner configured.
     Query Log Duration	1	Number of days to look back in query logs when processing stored procedure results.
     Query Parsing Timeout Limit	300	Timeout in seconds for parsing a single query.
     Number of Threads	1	Number of threads to use for parallel table ingestion.
     Incremental Extraction	Off	When enabled, subsequent runs only extract entities changed since the last successful run.
     Successful Pipeline Run Lookback Days	7	Number of days to search back for a prior successful run to use as a baseline for incremental extraction.
     Safety Margin Days	1	Additional days added to the baseline timestamp as a buffer for incremental extraction.
     JSON Schema Sample Size	10	Number of rows sampled to infer JSON column schema. Only applies when Extract JSON Schema is enabled in Advanced Config.

     
   • Filter Patterns: Apply include or exclude rules to scope which databases, schemas, tables, and stored procedures this agent ingests. For more information about various filter options, see Step 5: Configure Ingestion Options.
   • Scope & Behaviour: Control how the agent handles metadata during ingestion. Toggle each option on or off based on your needs:

     Toggle	Default	Description
     Include Tables	On	Ingest table metadata from the source. Turn off to skip tables entirely.
     Include Tags	On	Ingest tags from the source.
     Include Stored Procedures	On	Ingest stored procedure metadata.
     Include DDL Statements	Off	Ingest DDL statements alongside table metadata.
     Include Owners	Off	Assign owners to ingested entities when the source owner’s email matches a user in Collate. Does not overwrite an existing owner.
     Include Custom Properties	Off	Ingest connector-specific custom properties onto entities.
     Mark Deleted Tables	On	Soft-delete tables in Collate when they are removed from the source. Applies only within the currently ingested schema.
     Mark Deleted Stored Procedures	On	Soft-delete stored procedures in Collate when they are removed from the source.
     Mark Deleted Schemas	Off	Soft-delete schemas and all their child assets when removed from the source.
     Mark Deleted Databases	Off	Soft-delete databases and all their child assets when removed from the source.
     Override Metadata	Off	When on, source values overwrite existing descriptions, tags, owners, and display names in Collate. When off, Collate only updates fields that have no existing value.
     Enable Debug Log	Off	Sets the ingestion log level to DEBUG. Useful for troubleshooting.

     Note: Available toggles vary by connector. Stored procedure options only appear for connectors that support stored procedures.
     
   • Advanced Config: Optional connector-specific settings such as Include Views and Extract JSON Schema.
5. On the Schedule Interval page, set when the agent runs:
   • Schedule: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression.
   • On-Demand: No automatic schedule; trigger the agent manually when needed.
   
6. Click Add to deploy the agent.

​

Securing Salesforce Connection with SSL in Collate

​

Troubleshooting