Salesforce Docs Portal

Custom Collaboration Templates

Custom collaboration templates are JSON files that providers can create to specify the required metadata attributes and the terms of the collaboration. Custom templates can support multiple use cases and multiple queries under each use case. To create a custom template, copy the sample JSON, specify the field values, and upload the template while creating a package. You can also download the sample JSON from Data 360 Setup when you’re creating the clean room package. 

Template Overview

A custom collaboration template includes these fields.

Field Name data type Requirement Accepted values Description
name string Required N/A The name of the collaboration template.
description string Optional N/A A short description of the collaboration template.
tables object Required N/A The input tables used in a collaboration query.
queries object Required N/A The queries to be run in the clean room collaboration to support a use case.

Table Configurations

Each input table used by the query must be defined as a tables field. Each table definition must include the tableConfigs property.

  • tableConfigs (array, required) – A list of table definitions. Each entry represents one table configuration and must include these fields.
Field Name data type Requirement Accepted values Description
name string Required N/A The name of the table.
description string Optional N/A A short description of the table definitions.
role string Required Provider or Consumer The role that is sharing the table in the collaboration.
columns array Required N/A The schema of the table. Each column object defines a field in the table and must include a name, a type, an optional description and a defaultvalue, if any.

Query Configurations

The queries section defines all the queries that you want to allow on the combined dataset in a clean room. Each query must include the queryConfigs property.

  • queryConfigs (array, required) – A list of query configurations. Each entry defines a single query and must include these fields.
Field Name data type Requirement Accepted values Description
name string Required N/A The name of the query.
description string Optional N/A A short description of the query configurations.
useCase string Required Overlap or Custom The use case that this query supports.
type string Required SQL The type of query.
source string Required N/A

The actual SQL query text.

Use explicit aliases for SELECT columns.
referencedTables array of strings Required N/A A list of all tables that the query references. This field must contain at least one table name.
queryParameters object Optional N/A The dynamic parameters used in the query. Each queryParameter must contain a queryParamConfigs with a name, a type and an optional description field.
analysisConfigs object Optional N/A The output options, such as outputPath.
Note
Note Values for enum fields such as role, useCase, and type are case-sensitive.
  • Custom Collaboration Template Sample JSON
    Copy the template code below or download it directly in Data 360 to begin creating your custom template. Fill in the required and optional fields with appropriate values.
  • Identity Boost Custom Collaboration Template
    The identity boost custom collaboration template is a JSON configuration that supports identity enrichment use cases in Data 360 Clean Rooms. Use this template to enrich your first-party individual data with third-party identity attributes, such as real IDs from identity resolution providers, in a privacy-safe environment.
  • Supported Data Types for Custom Templates
    The data types supported in custom templates vary based on the clean rooms platform. Adhere to supported data types for successful query execution.