Salesforce Data 360 Pipeline Hybrid Runner | Collate Pipeline Integration

• Data Streams
• Calculated Insights
• Data Transforms

• Requirements
  • Requirements for Lineage
• Metadata Ingestion
• Troubleshooting

​

Requirements

• Configure a Salesforce connected app for the OAuth 2.0 client credentials flow. This gives you the Consumer Key and Consumer Secret that Collate uses to authenticate. See the Salesforce documentation on creating a connected app for the setup steps.
• Grant the connected app the Manage Data Cloud and Access Data Cloud APIs scopes so it can list Data Streams, Calculated Insights, and Data Transforms and read their run history.
• Give the integration user permission to view these objects. The connection test verifies this by listing each object type.

​

Requirements for Lineage

​

Metadata Ingestion

​

Step 1: Add New Service

1. Navigate to Settings > Services and select the Pipelines service.
2. 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 Data 360 services you are ingesting metadata from.
• Optional: Enter a Description for the service.

​

Step 4: Configure Connection Options

​

Select Ingestion Runner

​

Enter Connection Details

• Salesforce API Version: The Salesforce REST API version to call. Defaults to 63.0. Change this only if your Salesforce org requires a different version.
• Salesforce Domain: The domain of your Salesforce instance, used to build the login URL. Defaults to login. Use test for a sandbox, or your My Domain subdomain for a custom domain.
• Data 360 Database Service Name: The name of the Salesforce Data 360 database service in Collate to use for lineage resolution. Set this to the service you created with the Data 360 database connector so pipeline lineage can link to the right tables.
• Service Mapping: A JSON object mapping a Data 360 connector or data source name to the Collate service that holds it, used to resolve the upstream table of a Data Stream. For example: {"S3_Connector": "my-s3-service"}. Defaults to {}.
• Pagination Limit: How many Data 360 objects to request per page when listing pipeline objects. Defaults to 10. Valid values are 1–200.
• Include Bulk Lineage: When enabled, Collate also ingests lineage from Data Lake Objects to Data Model Objects for every data space. This walks all Data Model Objects in the configured Data 360 database service, so it is off by default.
• Consumer Key: The consumer key from your Salesforce connected app. This is the client identifier used for OAuth authentication.
• Consumer Secret: The consumer secret from your Salesforce connected app. This is the client secret used for OAuth authentication.

password: secret:/my/database/password

​

Test Connection

1. Click Test Connection to verify the credentials.
2. After the test succeeds, click Save.

​

Step 5: Configure Ingestion Options

​

How Filter Rules Work

• 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.

​

Filter Options

• Scan Mode: Choose between the following scan modes:
  • Scan all: Ingests every pipeline the connector can access. This is the default.
  • Only specific: Enables include rules so only pipelines matching at least one rule are ingested.
• Always exclude: Add permanent exclusion rules (shown in red). Pipelines 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: In Only specific mode, click + Add to define a rule. Added rules appear as chips. A pipeline is included if it matches any rule.

​

Step 6: Create & Deploy

​

Configure Metadata Agent and Schedule Ingestion

1. Navigate to Settings > Services and select the Pipelines service.
2. Select your service and 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 the core parameters for this agent. The following fields are available:

     Field	Default	Description
     Ownership Update Mode	replace	Set how owners from source metadata update Pipeline owners. In replace mode, resolved owners from the current source replace existing owners. In append mode, resolved owners are appended to active existing Pipeline owners.
     Db Service Names	—	List of database service names used for lineage resolution.
     Storage Service Names	—	List of storage service names used for lineage resolution.
     Messaging Service Names	—	List of messaging service names used for lineage resolution.
     Status Lookback Days	1	Number of days of pipeline run status history to ingest. Only runs within the last N days will be fetched.
     Include Lineage	On	Turn off to stop fetching lineage from pipelines.
     Mark Deleted Pipeline	On	Soft-delete pipelines in Collate when they are removed from the source. Associated entities like lineage are also deleted.
     Include UnDeployed Pipelines	On	Toggle whether un-deployed pipelines should be ingested. If set to false, only deployed pipelines will be ingested.

     
   • Filter Patterns: Apply include or exclude rules to scope which pipelines this agent ingests. These follow the same filter options described in Step 5.
   • Scope & Behaviour: Control what metadata to include and how to handle deletions. Toggle each option on or off based on your needs:

     Toggle	Default	Description
     Enable Debug Log	Off	Sets the ingestion log level to DEBUG. Useful for troubleshooting.
     Override Metadata	Off	When on, source values overwrite existing descriptions, tags, owners, and display names in Collate. A description or display name that the source doesn’t send never replaces an existing value. When off, Collate only updates fields that have no existing value.
     Override Lineage	Off	When on, existing lineage is replaced with newly extracted lineage on each run.

     
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.

​

Configure the Lineage Agent

1. Open the pipeline service and select the Agents tab.
2. Click Add Agent, then select Add Lineage Agent.
3. Configure its schedule.
4. Click Add & Deploy.

​

Configure the Usage Agent for Pipeline Status

1. Open the pipeline service and select the Agents tab.
2. Click Add Agent, then select Add Usage Agent.
3. Set Status Lookback Days to the run-history window you want to ingest.
4. Configure its schedule.
5. Click Add & Deploy.

​

Troubleshooting