How to use Collaborations
Before you read this article, we recommend looking at Introducing Collaborations, for an introduction to Collaborations as a command center for your clean room operations and the different members and uses.
This article describes how to create and use collaborations.
Table of Contents
Step 1: Pre-collaboration preparation & company ID sharing
Existing the Collaboration view
How to end your involvement in a Collaboration
Viewing the Collaboration activity log
Tutorial video
How to create a Collaboration
There are three distinct steps to set up the Collaboration
- Agree on scope, use case, and who will manage the clean room ops (off-platform)
- The owner sets up the Collaboration, invites the members, and assigns roles (operator or contributor)
- Each member adds their resources (Datasets and/or destinations)
Once this is ready, the use case is executed by the members who have ‘operator’ roles using the rest of the platform as usual.
Step 1: Pre-collaboration preparation & company ID sharing
Every collaboration project starts with commercial and use case discussions happening off-platform. To successfully leverage collaborations, the parties need to agree on:
- Who is involved in the collaboration
- What is the use case (as this will dictate the assets required)
- Who will be the operators (The company/ies that will manage clean rooms operations)
- What shared resources are necessary: Datasets and Destinations
Once this is agreed, parties that will just be members need to share their Company ID with one of the parties who will create the collaboration.
To find your company ID, navigate to the Collaborations main page, and click the “My Company ID” button will display your specific Company’s ID:
Step 2: Collaboration setup
Navigate to Collaborations, and client on the “New Collaboration” button to open the Create Collaboration form:
On the form you will see that your company is the owner of the collaboration has been assigned by default all roles and settings:
- Operator: can leverage the assets shared in the collaboration to enable the use case
- Contributor: can add and remove their own assets to the collaboration
- Detailed log: can see detailed information on the event tracker incl query syntax (leaving this unticked will still provide an event log for this member but it won’t expose details)
Clicking on the “+ Add Members” button will open a new panel where you can add a Company ID for the company you want to collaborate with. You will need to decide which roles and settings are required for each company.
You can add multiple company IDs if you need to. Valid Company IDs will display the Company Name:
Clicking the bin icon will allow you to remove a member panel if you no longer need it.
Clicking the “Next” button will navigate you to the second step in the Create Process, where you can confirm the creation of the collaboration by giving a name.
Click the “Submit” button to create your Collaboration. You will be redirected back to the main Collaborations screen. Successfully created Collaborations are displayed by default, at the top of the table:
Email notifications
Creating a new collaboration will send an email to the members, notifying them that they’ve been added to a Collaboration and to ask them to add their assets.
Users within a company can manage their email notification preferences by clicking on Notifications on the left hand menu bar, and opting in/out of the Collaborations email.
Step 3: Add shared resources
Adding shared resources allows the operators of the collaboration to use the resources in the context of this project. Within each Collaboration, each member with the contributor role can add:
- Owned Datasets
- Owned destinations
Resources can be removed by their owners from a Collaboration at any time.
Adding a Dataset
- Click on add Datasets and, select the Datasets that you wish to add.
- Click on continue with selection.
- You will be presented with a screen where you can choose which attributes you wish to share. By default all existing and future attributes are selected. Once you’ve made your selection click ‘continue with selection’
-
Then give your Dataset a public name in the ‘Collaboration Dataset Name’ field. Everyone in the collaboration will see your Dataset with this name.
-
You will be presented with permission settings that allows you to set the right scope for your use case:
- Allow Querying the Intersection: This will restrict the insights generated to just the users taht are in common across all Datasets
- Query the whole Dataset: This allows the collaboration to generate insights about users in the whole Dataset, which is useful to generate comparisons between the matched users and the general population or modeling exercises.
-
You can also allow this Dataset to be used in Activation queries
- This does not mean that data will be exported from your Dataset. This setting allows activations queries to include your Dataset where the export happens from another Dataset. You will need to turn this on if your use case includes activation.
-
Additional activation settings if you wish to export data from your Dataset
- You can select whose destinations can be used (none, only your own, or which member)
- You can restrict which destination types are allowed to export data from your Dataset
- Once you are happy with your setting click ‘add Dataset to collaboration’
All Dataset added by you and your partners will show in the Collaboration details page alongside all other shared resources.
If you wish to change these settings you will need to remove the Dataset and re-add it with the right configuration.
Adding a Destination
- Click on add a Destination. This will display the list of destinations that your company owns.
- Select the Destination that you want to add to this Collaboration
- Your Destination will be displayed on the list of Destinations in the main Collaboration screen. These Destinations can only be used if the permissions listed above permit it
How to remove an asset
To remove an asset you’ve added to the collaboration - simply select the asset and click on ‘remove from Collaboration’:
Use case enablement
Once all the required assets have been added to the Collaboration, the coordinator can use them according to the rules that have been provided to enable the use case in the platform as usual.
Audiences, segments, and queries that happen in the context of a Collaboration are available for all users within the company - to increase the usability across internal teams.
From each Collaboration screen, if you are the Operator of a collaboration, you can navigate directly to the query tool and the audience builder using the buttons on the top right corner.
When you navigate to the rest of the platform, you’ll be able to select the Collaboration project you are working on using the dropdown next to the Query tool, Audience Builder, Segment Builder, and Activations:
If you are not the Operator of any Collaboration, you will see a box showing that there are no Collaborations that you can create Audiences, Segments or Queries with like below:
You will only be able to use the assets permissioned in the context of a Collaboration by selecting the right Collaboration on the list.
Existing the Collaboration view
If you wish to see assets that are available outside of a collaboration, please deselect the correct collaboration from the list, and that will take you to a view of your company Datasets (and Datasets permissioned using the legacy permissions).
How to end your involvement in a Collaboration
Clicking the Action Menu button will provide you with either a Close or Leave option.
Only Organisers can close a collaboration fully, but members can leave at any time. Leaving a collaboration removes all previously provided assets from the shared workspace.
As owners:
As members:
Viewing the Collaboration activity log
This screen provides a list of events related to this Collaboration, relating to actions taken by members.
You can also download the event log as a csv to keep for your records. If you leave a collaboration you are added to, you will lose access to the log, so please download it prior to existing if you wish you retain a copy for your records.
Here's the list of event types:
- Collaboration created/closed/left: lists the collaboration status and changes to the membership
- Dataset added/removed: lists the datasets that were added or removed and metadata about the dataset
- Dataset published: lists if a Dataset included in a collaboration was republished whilst being part of this collaboration
- Destination added/removed: Lists the name of the destinations added/removed
- Activation query started/completed/failed/cancelled: Lists the status of the activation queries run
- Activation results exported: Lists the exports from this collaboration including audience size
- Insight query started/completed/failed/cancelled: Lists the status of the insight queries run
- Audience created/deleted: List the audiences that have been created or deleted and metadata
- Segment created/deleted: List the segments that have been created or deleted and metadata
- Private Path ID rotated: Only available if you are in a Private Path enabled collaboration. Lists the times that the Private Path ID has been updated. This creates new synthetic IDs and renders previous one unusable