This article describes how to configure client mappings for custom datasets. Client mappings ensure that data is pulled correctly from a datasource into the dataset. If you create custom datasets for client-facing reports, you must map the appropriate field to use for filtering. The field must be of the same field type (e.g., number, text) across the datasource. Datasets with different field types break the client mapping and may lead to data leakage in client reports. Please note that only Admin users may view and edit datasets and client mappings.
Note: Selecting different field types (e.g., numbers in one dataset and text in another) breaks the client mapping and may lead to data leakage in client reports.
Pulling in the Correct Client Field in Your Dataset (Specific for Your Datasource)
If you’re creating a custom dataset from a featured integration, here are the specific fields and their table that we’re pulling so that you can add it into your own as well.
When you create a custom dataset, you’ll be prompted to select the field name in your dataset that you want to use for the client mapping.
Select a Client Column for Mapping on a New Dataset
Step 1 - Create the dataset
You must first create your SQL dataset and ensure it follows the requirements set forth in the Dataset Requirements article.
To create your custom dataset:
- Navigate to DATA > Datasets.
- Click Create Dataset.
- Select the Datasource
- Enter a Name for the dataset.
- Select the Dashboard Sync Frequency.
- Enter a Decription, if desired.
- Enter your SQL query.
- Test your query and ensure there are no errors.
- Click Save (the Save button only appears after all errors are removed).
Step 2 - Choose the Client Column
After you click save, a modal appears asking you to either select a client column or skip and save the dataset. If you’re in this document, you’ll want to select a column. However, you can skip and save and select the client column later if desired (see the Select a Column section below).
Make sure the client column you select is the appropriate column otherwise the mapping will not work or could potentially cause gauges to show the wrong data.
Step 3 - Save the Dataset
After selecting the client column, click on the Save button.
Select a Client Column for Mapping on an Existing Dataset
Step 1 - Find the custom dataset you created
Navigate to DATA > Datasets and click on the name of the dataset you just created.
Step 2 - Select the client name field
From the dataset editor, look below the dataset settings fields, but just above the SQL editor, and you’ll see a Client Column drop-down box. This box pulls the column names from your dataset. Click on the dropdown and select your field.
Step 3 - Test and save your dataset
After you select your column, test the query and re-save your dataset. Make sure to address any errors that may pop up. After you click Save, you’re all done!