Our platform, The Data Standards Cloud, connects with Google’s analytics, monitoring, visualization, and reporting tool, making it easy to:
- Generate and define key values and UTM parameters for more accurate, granular tracking
- Audit and validate data, including tag placement and configuration, to ensure it is consistently captured
- Enrich data for improved dimensionality and segmentation
Quickly generate and define key values in The Data Standards Cloud. Using the data import feature, standards can be applied to most dimensions and expand to other dimensional data points within the same scope (hit, session, product, user).
All of this data can be pushed to the appropriate Property and Data Import setup via the Google Analytics connector to further enrich measurement and activation. You can also simultaneously push data to parallel analytics instances or cloud storage solutions to further enable insights.
Learn more:
- Claravine website: Claravine & GA (UA) Updated Integration
- Claravine blog: 3 ways GA4 turns to gold by using data standards
-
Set Up Data Import with Google Analytics
Google Analytics (GA) offers several Data Import options to expand your data within the GA platform. Claravine offers the ability to send data import files directly to GA for two Data Import Types: Campaign Data and Custom Data.
This section details your options when choosing which Data Import type works best for your organization and how to connect with Claravine. Note that these options are for Google Universal Analytics and do not include GA4.
Campaign Data Import
Follow these steps to expand data using the Campaign Code (
utm_id
) as the key.Callouts
For GA360 customers, if you have Google Ads and/or Campaign Manager 360 (Doubleclick) integrated with your GA Property, you must select Processing Time Import because of GA’s last non-direct session attribution (refer to this callout from Google).
For GA “Free” customers, Processing Time Import is the default and cannot be changed.
Session metadata is expanded at processing time of data only and is permanent. Data cannot be applied to historical hits.
In Google Analytics:
- Define/map out Custom Dimensions to use with your data import key:
- GA Path: Admin → Property → Custom Definitions → Custom Dimensions.
- We recommend leaving UTM parameters source, medium, campaign within your URL query. If these values are mapped within the Data Import, returning users will have “(not set)” in their default campaign dimensions due to GA’s last non-direct attribution model.
- All custom dimensions must be session-scoped.
- Send Custom Dimension Names and Index to your Claravine CSM.
- GA Path: Admin → Property → Custom Definitions → Custom Dimensions.
- Setup Data Import:
- GA Path: Admin → Property → Data Import.
- Click Create.
- For Step 1: Data Set type, select Campaign Data.
- For Step 2: Data Set details, give your data set a name and select applicable views.
- For Step 3: Data Set schema:
- Key: Campaign Code (utm_id query parameter).
- Imported Data: All custom dimensions as defined above.
- Choose Processing Time Import. For GA360 customers, Query Time would not apply, assuming you have integrations with other Google Marketing Platform tools
- Make a selection on Override Hit Data. This decision varies among organizations. It is best to talk to who manages your GA property to determine the best selection.
- Click Save.
- Key: Campaign Code (utm_id query parameter).
- GA Path: Admin → Property → Data Import.
- Retrieve Data Import Schema and send to your Claravine CSM:
- From main Data Import Menu, click on your Data Import Name.
- Click Get Schema.
- Either download schema or copy the values under the CSV Header and paste in a text file.
- From main Data Import Menu, click on your Data Import Name.
In The Data Standards Cloud:
- In Claravine, navigate to Settings → Integrations → Accounts and connect GA via your GA account login.
- From Settings, navigate to Templates and chose the Template to integrate.
- Click Step 3 - Connect to see your Inbound/Outbound connections.
- On Outbound, click the green plus (+) sign, then click the Google Analytics tile.
- On Integration Details, leave the default integration name, or rename to your choosing.
- On Account Configuration, make the following selections from the dropdown options:
- Connected Google Analytics Account: The name of the GA account from Step 1.
- Google Analytics Account: The Account in GA you want to connect to.
- GA Property: The Property in GA where you created the Custom Dimensions and Data Import schema.
- Data Set Type: Choose Campaign Data.
- Data Source: The Data Import name in your GA Account:
- Connected Google Analytics Account: The name of the GA account from Step 1.
- In Field Mapping, paste the schema of your Data Import and click Apply Schema.
- Your screen will look like this:
We are ready to map each value to the value in Claravine. - Within each field highlighted in red, use the drop-down to map the schema value to the corresponding Claravine value.
- After each value is mapped, click Save.
Custom Data Import
Follow these instructions to create a custom Data Set to import data for your specific use case. Typically used with Adobe/GA customers who run their analytics platforms side by side and collect Adobe Campaign Codes (evar0) within GA Custom Dimension.
Callouts
For GA360 customers, users can choose Query Time Import when using a Custom Dimension as a key to import data retroactively and Query Time imported values are reversible.
Query Time imported data is not directly sent to your Big Query tables during your GA sync. Claravine can send the same import file via Google Cloud Storage should you want to connect the data in Big Query; contact your CSM should you be interested in this integration.
In Google Analytics:
- Define/map out Custom Dimensions to use with your data import key:
- GA Path: Admin → Property → Custom Definitions → Custom Dimensions.
- All custom dimensions and/or default dimensions must be the same scope as your key.
- Send Custom Dimension Names and Index to your Claravine CSM.
- GA Path: Admin → Property → Custom Definitions → Custom Dimensions.
- Set up Data Import:
- GA Path: Admin → Property → Data Import.
- Click Create.
- For Step 1: Data Set type, select Custom Data.
- For Step 2: Data Set details, give your data set a name and select applicable views.
- For Step 3: Data Set schema:
- Key: Your defined key, most likely a Custom Dimension.
- Imported Data: All custom dimensions and/or default dimensions as defined above.
- Key: Your defined key, most likely a Custom Dimension.
- For GA 360 Customers, choose Processing Time Import or Query Time Import. We recommend choosing Query Time based on the ability to define historical data.
- Make a selection on Override Hit Data. This decision varies among organizations. It is best to talk to who manages your GA property to determine the best selection.
- Click Save.
- GA Path: Admin → Property → Data Import.
- Retrieve Data Import Schema and send to your Claravine CSM:
- From main Data Import Menu, click on your Data Import Name.
- Click Get Schema.
- Either download schema or copy the values under the CSV Header and paste in a text file.
- From main Data Import Menu, click on your Data Import Name.
In The Data Standards Cloud:
- In Claravine, navigate to Settings → Integrations → Accounts and connect GA via your GA account login.
- From Settings, navigate to Templates and chose the Template to integrate.
- Click Step 3 - Connect to see your Inbound/Outbound connections.
- On Outbound, click the green plus (+) sign, then click the Google Analytics tile.
- On Integration Details, leave the default integration name, or rename to your choosing.
- On Account Configuration, make the following selections from the dropdown options:
-
- Connected Google Analytics Account: The name of the GA account from Step 1.
- Google Analytics Account: The Account in GA you want to connect to.
- GA Property: The Property in GA where you created the Custom Dimensions and Data Import schema.
- Data Set Type: Choose Custom Data.
- Data Source: The Data Import name in your GA Account.
- On Field Mapping, paste the schema of your Data Import and click Apply Schema.
- Your screen will look like this:
We are ready to map each value to the value in Claravine. - Within each field highlighted in red, use the dropdown to map the schema value to the corresponding Claravine value.
- After each value is mapped, click Save.
- Connected Google Analytics Account: The name of the GA account from Step 1.
On template submission, Claravine-defined metadata will be directly sent to your GA Property. When a hit value is recorded to your defined key, GA will recognize the value and expand the session’s metadata when processing the hit for that visit.
In the case you would like to use the other Data Set types (Refund, User, Geographical, Content, Product, Cost), the steps are similar to Custom Data import configuration. Choose your Data Set type, choose how to import, choose your schema in GA, and then, map the schema in Claravine.
If you have any questions about this process or which option is best suited for your environment, please contact your Claravine CSM.
Learn more:
- Define/map out Custom Dimensions to use with your data import key:
-
Templates Overview
Templates is the area of The Data Standards Cloud where the Administrator or Manager combines any Patterns and Field Sets to configure the user’s Submission Table. Administrators will configure templates with the appropriate URL output, link validation, and input and output configurations.
Administrators and Managers with template-management permissions have the ability to view and manage Templates.
View a Template
To view Template:
- Navigate to Settings → Templates.
The Templates page displays.
You can view the following information about Templates:
- Name
- Updated Date
- Patterns
- Field Sets
- Description
-
The sort feature is available for all columns. You can sort all columns in ascending or descending order.
Create a Template
Define and govern Patterns, Field Sets, URL output, link validation, and input and/or output configurations to design the user’s Submission Table and processing.
For detailed instructions on creating a new template, refer to the Creating a Template Using a Basic URL and Creating a Template Using Patterns sections.
Duplicate a Template
To save the time of creating a Template, you can duplicate an existing Template. This allows you to copy most of the parameters from the original Template, then modify as needed.
To duplicate a template:
- On the Templates page, check the box to the left of the name of the Template you want to duplicate.
- Click the plus (+) sign to duplicate the Template.
- The Template name defaults to “Duplicate of {Template Name}”. Edit the Template details to your preference: template name, description, folder, fields, patterns, link validations and URL parameters, inbound and outbound integrations to accommodate this Template.
For detailed instructions on creating a new template, refer to the Creating a Template: Using a Basic URL and Create a Template: Using Patterns sections. - Click Save.
A confirmation message displays.
Edit a Template
To edit a Template:
- On the Templates page, check the box to the left of the name of the Template you want to edit.
- Click the pencil icon to edit the Template.
- Edit the Template details to your preference: template name, description, folder, and add or remove any parameter on the Setup, Define Schema, Validate, Construct URL, or Integrate steps to accommodate this Template.
- Click Save Template.
A confirmation message displays.
Delete a Template
To delete a Template:
- On the Templates page, check the box to the left of the name of the Template you want to remove.
- Click the delete (waste bin) icon.
If you delete a Template, the existing submissions will be deleted. - A confirmation message displays.
- Click Confirm.
Template and Schema Tips
Tool Tip
The Description field will show as a tool tip in the user's Submission Table.
Error and Warning
Click on the errors icon at the top of the template schema to view the errors and warnings.
The template cannot be saved with any errors or bad configuration. Errors include a variable Pattern Element that has not been defined, a field used in a concatenation that isn’t included in the schema, etc.
Warnings notify you if there is a potential issue such as not all columns are used from a list.
Preview
Preview how this template will look in the user's Submission Table without having to navigate away from the template page. Preview is only available after a Template Name and Folder have been assigned.
Add Fields and Field Set
Add a Field to a Field Set from the Template by clicking . Remember to add Target Mapping on the Field Set if applicable.
Add a Field Set from the Template by clicking +Add Field Set. Find the Field Set and click to add Fields to the Field Set. Remember to add Target Mapping on the Field Set if applicable.
Reorder Mode
Reorder the fields how you want them to appear in user's Submission Table seen by the user:
- Manual: Drag the field into the order you desire.
- Custom: Reorder Mode allows the administrator to easily order the fields (left to right).
- Move the field to first position
- Move the field up one position
- Move the field down one position
- Move the field to the last position
- Select the field number to reassign the field order, field number is on the right
Visible
All fields default to Visible. Uncheck the box if you want the field to be hidden from the Submission Table view.
Hide any fields the user does not need to see, such as dependent variables and fields, constant values, autofilled values to reduce the number of columns they do not need to enter a value in.
Required
If the Required Field governance has not been assigned at the Field Set level, you can check the Required box per field.
Field Type
Hover over the Field Type to view the Field Type details. If the field is a List, the list name will be visible. If the field is a drill list and the Filter Value has been set, the list name and default value will be visible.
Delete
Hover over the plus (+) sign to view the Edit options, and click the waste bin icon to delete the field.
Pattern Element Types
Use the following table to define the Pattern Element variable field type:
Pattern Element Type Description List Pick lists allow a defined list of allowable entries the user can select from. Select the Pick List from the drop-down menu either by scrolling or begin typing the Pick List name. You can also select "Create New List".
If the list you want to use has more than one column, you must specify which column you want the list to populate from.
If the Field utilizes a drill down list and needs to be defaulted at the template level (i.e Global Region needs to be defaulted to “Global North”), hover over the plus (+) sign to view the Edit options, and click the pencil icon and use the drop-down menu to Select Filter Value.
For more information refer to the Pick List Overview article, or, for more detailed instructions for each of the pick list types, see their respective articles: Pick List - Drop Down, Pick List - Dependent, and Pick List - Drill Down.
Auto Fill Select the field you want to automatically duplicate.
TRANSFORM
Options in this section auto-transform entries from the autofilled field.- Transform: Convert Case: Select uppercase to have all text display in capital letters and lowercase to have all text display in lowercase.
- Transform: Spaces: Select how spaces auto-transformed. Options are:
- None - For no transformation.
- Replace Spaces: Replaces all spaces the user enters with a character you determine. (Summer_Bash)'Remove Spaces - Removes all spaces from the text the user enters. (SummerBash)
Constant Specify a constant value that you want to always be populated in this template in the Submission Table. Text Text fields allow users to manually enter values in the user's Submission Table. Specify the following parameters for text fields: - Show Previous Values: Select this option if you want a new value to be added to a dynamic list gathering values entered through a submission.
- Flag New Values: Select this option if you want users to be alerted that the value they entered has not been used in that field before. Users have the option to continue and submit the value. If they proceed the new value will not be flagged next time.
- Use list to provide suggestions: You can specify a drop-down (single column) pick list to populate suggestions for users to choose from, or they can enter their own text.
Options in this section establish governance over text entered in this field. If the text does not match any of the governance, the user will receive an error and must correct the text to match the requirement before proceeding.- Begins/Ends With: Enter the prefix or suffix you want text fields to be required to begin and/or end with. *Case sensitive
- Must Contain: Enter the value you want text fields to always include. *Case sensitive
- Exclude: Use the drop-down menu to select the appropriate checkboxes to exclude all letters, all numbers, all symbols (special characters and punctuation), or spaces from the value.
- Custom Exclusion: Enter a custom value you want to exclude from the field. *Case sensitive
- Exclude as term: Check this box to exclude the Custom Exclusion combination of characters entered above. This makes the text field act as a "Must not include". For example, if we have set Toy as an exclude term, Toyota would receive a warning.
Options in this section auto-transform entries the user enters to gain consistent entries in open text fields.
- Transform: Convert Case: Select uppercase to have all text display in capital letters and lowercase to have all text display in lowercase.
- Transform: Spaces: Select how spaces should be auto-transformed. Options are:
- None: For no transformation.
- Replace Spaces: Replaces all spaces the user enters with a character you determine. (Summer_Bash)
- Remove Spaces: Removes all spaces from the text the user enters. (SummerBash)
Define the minimum and maximum length of characters a user is allowed to enter in open text fields. If the field is optional, set the minimum length to 0. If the length of characters is an exact number, set the minimum and maximum to the same number. - Navigate to Settings → Templates.
-
Create a Template: Basic URL Structure
Templates is the area of Claravine where the Administrator or Manager combines any Field Sets to configure the user’s Submission Table. Administrators will configure templates with the appropriate URL output, link validation, and input and output configurations.
For Administrators that need additional information about configuring the prerequisite Template Elements, refer to the Patterns Overview and Pick Lists Overview articles, and the Field Sets Overview section of this article.
Organizations that use UTM parameters have two options to create their consistent and accurate URLs: creating a basic, UTM URL and creating a UTM ID URL. Additional information about UTM IDs and Dimensions Widening through Google Analytics.
This article provides instructions to create a basic, UTM URL in Claravine not using Patterns.
The Field Set must have a field for each UTM parameter: Campaign, Medium, Source, Content (if applicable), and Term (if applicable). Many fields can be concatenated to make a UTM field, for example UTM Content = {Format}-{Product}-{Image ID}-{Language}.
To create a template for a basic URL structure:
- Navigate to Settings → Templates.
The Templates page displays. - Click the plus (+) sign to create a New Template.
The Edit New Template menu displays.
There are 3 steps to create a new submission template:
Step 1. Setup
- Enter the Template Name of the template (required).
- Enter the Description (optional). It is recommended to enter a description to make it easier to determine the use of the template.
- Select the Folder (or create a new folder) this template is assigned to. Templates within a Folder are immediately available to users of a Group if that Folder is assigned to the Group.
If you create a new Folder, be sure to associate it to the Group so users have access to it. - Check the box Require Submission Name if users must assign a submission name before being able to submit the data.
You must enter a Template Name and Folder before you can save the template.
Step 2. Define and Govern
Define and govern Fields and Link.
Define and Govern: Fields
- Click + Select Fields.
- Check the box to select all the fields in the Field Set or click the drop down menu to select individual fields.
Use the Search field to find a specific field name or Field Set. - Click Select Fields.
The fields selected are added to the end of the schema. Fields within a Field Set share the same color in the second column for easy reference.
Add a field into an existing Field Set, or create a new Field Set in the +Add Fields menu - Reorder the fields as they should appear in the user's Submission Table.
- Manual: Drag the field into the order you desire.
- Custom: Reorder Mode allows the administrator to easily order the fields (reorder menu options left to right).
- Move the field to first position
- Move the field up one position
- Move the field down one position
- Move the field to the last position
- Select the field number to reassign the field order, field number is on the right
- All fields default to Visible. Uncheck the box if you want the field to be hidden from the Submission Table view.
Hide any fields the user does not need to see, such as dependent variables and fields, constant values, autofilled values to reduce the number of columns they do not need to enter a value in. - If the Required Field governance has not been assigned at the Field Set level, you can check the Required box per field.
- Hover over the plus (+) sign to view the Edit options, and click to remove the field from the template.
- If the Field utilizes a drill down list and needs to be defaulted at the template level (e.g. Global Region needs to be defaulted to “Global North”), hover over the plus (+) sign to view the Edit options, click the pencil icon, and use the drop-down menu to Select Filter Value.
- Click the error/alert icon to see all errors and warnings on the template. Errors must be fixed before the template can be saved. Warnings will not block saving the template but should be reviewed to confirm the configuration is accurate.
Define and Govern: Link
To add and define a template-generated link:
- Click + Add Link Field.
The Link field is automatically added to the end of the schema. - Hover over the plus (+) sign to view the Edit options, and click the pencil icon to edit the Link requirements and parameters.
The Edit Link menu displays. - Link Definition
- Rename the Link column header as seen in the user's Submission Table (optional).
- Autofill the Link column from another field in the schema (optional). This is helpful if the user is entering a Vanity URL field and does not want to also enter the URL in the Link column.
- Click + Add Parameter to design the UTM parameters to generate the URL as desired.
In the Customize Link Parameters page:
- Enter the UTM parameter (utm_medium), do not include the =
- Select the field to populate with this parameter from the drop down menu.
- Check the box to URL Encode if you want the final URL to be UTF encoded. Encoding the URL will convert any special characters to encoded characters ( colon : becomes %3A, spaces become %20).
- Click +Add Parameters to add as many parameters as needed for the URL requirements.
- Confirm the final URL is correct in the Current Configuration line.
- Input the domain and click Enter after each domain to restrict the domains that are allowed for this template. Leaving this field open allows any domain to be used (optional).
- Select which Link Validations must be checked when the user enters a domain in the Link column of the user's Submission Table. All Link Validations are defaulted off. Click the box to define the validation checks.
- General Website Validation: Validated general website functionality, the page exists, the Link+Link Parameters will take the consumer to the final destination correctly, tags are firing correctly.
- Google Analytics: Validate Google Analytics pixels and Property IDs are tagged correctly on the landing page. These validations confirm the Link is firing and sending data to the same Property that the Pattern and metadata classifications are sending to.
- Verify Google Pixel: Verify that the links submitted by users fire a Google Analytics Pixel. This validation ensures that URL parameters trigger the correct Pixels on the page.
- Verify Property ID>Inherit through a Target: Select a Claravine Target to specify which Property ID to check.
- Verify Property ID>Explore my Properties: Select the Connected Google Analytics Account and select a Property ID to check.
- Verify Property ID>Input by Hand: Enter the Property ID manually to check.
- Add multiple Validation configurations to check for several rsid/eVars or Google Property IDs.
- Click Done.
Step 3. Connect
Connect inbound and outbound integrations for this template.
Inbound Integrations
Map metadata from a Connected Account to fields in this template as an inbound submission. Use the Inbound Integration to map the inbound data fields to the template fields, when new data is found, Claravine will bring that data in as a new submission. Completed inbound data will be found in Submission, inbound data with errors will be found in Pending as Paused-With Errors submissions. Request configuration from your Customer Success Manager.
- Click the plus (+) sign to add a new inbound integration.
- Select the Connected Account to map to design the outbound file format to apply to submission data out of Claravine.
- Follow the instructions for each inbound integration type:
Outbound Integrations
Design the outbound file exports, emails, and other outbound metadata from this template.
- Click the plus (+) sign to add a new outbound integration.
- Select the Connected Account to map to design the outbound file format to apply to submission data out of Claravine.
- Follow the instructions for each inbound integration type:
- Click Save to save the template.
- Navigate to Settings → Templates.
-
Create a Template: Using Patterns
Templates is the area of Claravine where the Administrator or Manager combines any Field Sets to configure the user’s Submission Table. Administrators will configure templates with the appropriate URL output, link validation, and input and output configurations.
For Administrators that need additional information about configuring the prerequisite Template Elements, refer to the Patterns Overview, Pick Lists Overview, and Field Sets Overview content.
Organizations that use UTM parameters have two options to create their consistent and accurate URLs: creating a basic, UTM URL and creating a UTM ID URL. Additional information about UTM IDs and Dimensions Widening through Google Analytics.
Using a UTM ID associates a single Key to many Dimensions as defined in Google Analytics without creating extensive and confusing UTM parameters. This article provides instructions to create a UTM ID or UTM URL using Patterns.
Create a Template
- Navigate to Settings → Templates.
The Templates page displays.
- Click the plus (+) sign to create a New Template.
The Edit New Template menu displays.
There are 3 steps to create a new submission template:
Step 1. Setup
- Enter the Template Name of the template (required).
- Enter the Description (optional). It is recommended to enter a description to make it easier to determine the use of the template.
- Select the Folder (or create a new folder) this template is assigned to. Templates within a Folder are immediately available to users of a Group if that Folder is assigned to the Group.
If you create a new Folder, be sure to associate it to the Group so users have access to it. -
Check the box Require Submission Name if users must assign a submission name before being able to submit the data.
You must enter a Template Name and Folder before you can save the template.
Step 2. Define and Govern
Define and govern Fields, Patterns, and Link.
Define and Govern Fields
- Click + Select Fields.
- Check the box to select all the fields in the Field Set or click the drop down menu to select individual fields.
Use the Search field to find a specific field name across all Field Sets. - Click Select Fields.
The fields selected are added to the end of the schema. Fields within a Field Set share the same color in the second column for easy reference.
Add a field into an existing Field Set, or create a new Field Set in the +Add Fields menu. If you are using a Target to send data to Google Analytics, remember to go into the Field Set and assign the Target Mapping. - Reorder the fields as they should appear in the user's Submission Table.
- Manual: Drag the field into the order you desire.
- Custom: Reorder Mode allows the administrator to easily order the fields (reorder menu options left to right).
- Move the field to first position
- Move the field up one position
- Move the field down one position
- Move the field to the last position
-
Select the field number to reassign the field order, field number is on the right
- All fields default to Visible. Uncheck the box if you want the field to be hidden from the Submission Table view.
Hide any fields the user does not need to see, such as dependent variables and fields, constant values, autofilled values to reduce the number of columns they do not need to enter a value in. - If the Required Field governance has not been assigned at the Field Set level, you can check the Required box per field.
- Hover over the plus (+) sign to view the Edit options, and click the waste bin icon to remove the field from the template.
- If the Field uses a drill down list and needs to be defaulted at the template level (e.g. ga.Medium needs to be defaulted to “Paid Social”), hover over the plus (+) sign to view the Edit options, and click the pencil icon and use the drop down menu to Select Filter Value.
- Hover over the Field Type to view the Field Type details. If the field is a List, the list name will be visible. If the field is a drill list and the Filter Value has been set, the list name and default value will be visible.
Define and Govern Patterns
- Click + Select Pattern.
- Check the box to select the Patterns needed on this template.
- Click Select Patterns.
The Parent Pattern field (reflects the final Pattern in the user's Submission Table view) and the Pattern’s Element fields appear automatically at the end of the schema.
The Parent Pattern and Element fields share the same color in the second column for easy reference. -
Define the Pattern to send to Google Analytics as the UTM ID/Key. Hover over the plus (+) sign to view the Edit options, and click the pencil icon to Associate Field Set data to the Pattern. This step indicates to Claravine that the output of the Pattern (e.g., SOC-34E25F4MO) is the UTM ID and the values entered in the fields of the Associated Field Set will be sent to Google Analytics as Dimension metadata.
Without this association, no metadata will be sent to Google Analytics and the Dimension will be unspecified or blank.
- If the Pattern Element is a variable it must be defined in the template. The errors icon will indicate a warning that this field must be governed. Hover over the plus (+) sign to view the Edit options, and click the pencil icon to define and govern the Pattern Element variable:
- List: Select the List Name and Column.
- Autofill: Add the Field from the Field Set to autofill from (see Define and Govern Fields). Transform to autofill values into all capitals, all lowercase, remove spaces, or replace spaces.
- Constant: Enter the value.
- Text: Select the Type as Text and add governance.
See more details in Schema Tips help section
- Click the alert/error icon to see all errors and warnings on the template. Errors need to be fixed before the template can be saved. Warnings will not block saving the template but should be reviewed to confirm the configuration is accurate.
Define and Govern LinkTo add and define a template-generated link:
- Click + Add Link Field.
The Link field is automatically added to the end of the schema. -
Hover over the plus (+) sign to view the Edit options, and click the pencil icon to edit the Link requirements and parameters.
The Edit Link menu displays. -
Rename the Link column header as seen in the user's Submission Table (optional).
-
Autofill the Link column from another field in the schema (optional). This is helpful if the user is entering a Vanity URL field and does not want to also enter the URL in the Link column.
-
Click + Add Parameter to design the UTM parameters to generate the URL as desired.
-
Enter the landing page parameter as designated (utm_id).
-
Select the Pattern or other field to populate with this parameter.
-
Check the box to URL Encode if you want the final URL to be UTF encoded. Encoding the URL will convert any special characters to encoded characters ( colon : becomes %3A, spaces become %20).
- Click +Add Parameters to add as many parameters as needed for the URL requirements.
- Confirm the final URL is correct in the Current Configuration line.
-
- Input the domain and click Enter after each domain to restrict the domains that are allowed for this template. Leaving this field open allows any domain to be used (optional).
-
Select which Link Validations must be checked when the user enters a domain in the Link column of the user's Submission Table. All Link Validations are defaulted off. Click the box to define the validation checks.
-
General Website Validation: Validated general website functionality, the page exists, the Link+Link Parameters will take the consumer to the final destination correctly, tags are firing correctly.
-
Google Analytics: Validate Google Analytics pixels and Property IDs are tagged correctly on the landing page. These validations confirm the Link is firing and sending data to the same Property that the Pattern and metadata classifications are sending to.
-
Verify Google Pixel: Verify that the links submitted by users fire a Google Analytics Pixel. This validation ensures that URL parameters trigger the correct Pixels on the page.
-
Verify Property ID>Inherit through a Target: Select a Claravine Target to specify which Property ID to check.
-
Verify Property ID>Explore my Properties: Select the Connected Google Analytics Account and select a Property ID to check.
-
Verify Property ID>Input by Hand: Enter the Property ID manually to check.
-
Add multiple Validation configurations to check for several rsid/eVars or Google Property IDs.
-
-
-
Click Done.
Step 3. Connect
Connect inbound and outbound integrations for this template.
Inbound Integrations
Map metadata from a Connected Account to fields in this template as an inbound submission. Use the Inbound Integration to map the inbound data fields to the template fields, when new data is found, Claravine will bring that data in as a new submission. Completed inbound data will be found in Submission, inbound data with errors will be found in Pending as Paused-With Errors submissions. Request configuration from your Customer Success Manager.
-
Click the plus (+) sign to add a new inbound integration.
-
Select the Connected Account to map to design the outbound file format to apply to submission data out of Claravine.
-
Follow the instructions for each inbound integration type:
Outbound Integrations
Design the outbound file exports, emails, and other outbound metadata from this template.
-
Click the plus (+) sign to add a new outbound integration.
-
Select the Connected Account to map to design the outbound file format to apply to submission data out of Claravine.
-
Follow the instructions for each inbound integration type:
-
Click Save to save the template.
- Navigate to Settings → Templates.
-
Field Sets Overview
Field Sets is a library of fields to be used in the Submission Table. Administrators define the field’s name, description, field type (list, autofill, concatenation, constant, date, text), governance and formatting. Administrators can map fields to GA Custom Dimension in a Target. For Administrators that need additional information about Targets, refer to the Targets Overview section.
View a Field Set
- Navigate to Settings → Elements → Field Sets.
The Field Sets page displays.
You can view the following information about Field Sets:
- Name
- Updated Date
- Description
The sort feature is available for all columns. You can sort all columns in ascending or descending order.
Create a Field Set
There are two methods to create Field Sets:
Create a New Field Set
- On the Field Sets page, click the plus (+) sign to Create New Field Set.
The New Field Sets work area displays.
You can view the following information about Field Sets in the work area:- Name
- Type
- Updated Date
- Required
- Target Mapping
- Enter the Field Set Name and Description in the designated fields.
We recommend entering a description to easily determine the purpose of a particular Field Set. - Add Fields by one of three methods:
-
- Click the arrows icon to Import from Targets at the top-right of the work to create fields for each classification in a designated Target (report suite and evar/report).
- Click the arrows icon to Import from Lists at the top-right of the work area to create all fields as they appear in a Pick List.
- Click the plus (+) sign at the top-right of the work area to add a field.
Enter the new field Name (required).
-
- Enter a Description (optional). The description will display as a hover-over tool tip in the Submission Table.
- Check the box Required Field if the field must be filled in before the Submission Table can be completed (optional).
- Select the Field Type from the drop-down menu.
Field Type Description List Pick lists allow a defined list of allowable entries the user can select from. Select the Pick List from the drop-down menu either by scrolling or begin typing the Pick List name.
If the list you want to use has more than one column, you must specify which column you want the list to populate from.
For more information refer to the Pick Lists Overview article or for more detailed instructions for each of the pick list types see their respective articles: Pick List - Drop Down, Pick List - Dependent, Pick List - Drill Down.
Check the box Select Multiple Values if the user should be allowed to select more than one value from the pick list in the Submission Table. Define the delimiter.Autonumber The Autonumber field generates a sequential number managed by Claravine. Designate the starting number and minimum width. Claravine will increase by one across all templates this field is used in. Auto Fill Select the field you want to automatically duplicate. Transform the metadata from the autofilled field.
Convert Case:
- None - For no transformation.
- Uppercase to have all text display in capital letters
- Lowercase to have all text display in lowercase letters
Spaces:
- None - For no transformation.
- Replace Spaces - Replaces all spaces the user enters with a character you determine. (Summer_Bash)
- Remove Spaces - Removes all spaces from the text the user enters. (SummerBash)
Concatenation Combine the values from two or more fields into a single field. Concatenated fields can use all field types: text, pick lists, constant, autofill, and date. You can specify the separator character/delimiter or to not use a separator between fields.
If you add a new field to include in the concatenation, you must save the Field Set first.
Constant Specify a constant value that you want to always be populated in this template in the Submission Table
.Date The Date field will populate in the submission table as a pop-up calendar widget. Specify the following date parameters: - Name: Enter the name of the date.
- Order: Select the order the date displays (M/D/Y, Y/D/M, D/M/Y, or Y/M/D).
- Month Format: Select the format of the month to display: single-digit (M), double-digit (MM), abbreviated (Jan), full name (January), or None to exclude the month from the date field.
- Day Format: Select the format of the day to display: single-digit (D), double-digit (DD), or None to exclude the day from the date field.
- Year Format: Select the format of the year to display double-digit (YY), 4-digit year (YYYY), or None to exclude the day from the year field.
- Separator: Enter the delimiter between the month, day, and year values.
- Auto Populate: Check the box to auto-populate the current date upon submission.
Text Text fields allow users to manually enter values in the user's Submission Table. Specify the following parameters for text fields: - Show Previous Values: Select this option if you want a new value to be added to a dynamic list gathering values entered through a submission.
- Flag New Values: Select this option if you want users to be alerted that the value they entered has not been used in that field before. Users have the option to continue and submit the value. If they proceed the new value will not be flagged next time.
- Use list to provide suggestions: You can specify a drop-down (single column) pick list to populate suggestions for users to choose from, or they can enter their own text.
Options in this section establish governance over text entered in this field. If the text does not match any of the governance, the user will receive an error and must correct the text to match the requirement before proceeding.- Begins/Ends With: Enter the prefix or suffix you want text fields to be required to begin and/or end with. *Case sensitive
- Must Contain: Enter the value you want text fields to always include. *Case sensitive
- Exclude: Use the drop-down menu to select the appropriate checkboxes to exclude all letters, all numbers, all symbols (special characters and punctuation), or spaces from the value.
- Custom Exclusion: Enter a custom value you want to exclude from the field. *Case sensitive
- Exclude as term - Check this box to exclude the Custom Exclusion combination of characters entered above. This makes the text field act as a "Must not include". For example, if we have set Toy as an exclude term, Toyota would receive a warning.
Options in this section auto-transform entries the user enters to gain consistent entries in open text fields.
- Transform: Convert Case: Select uppercase to have all text display in capital letters and lowercase to have all text display in lowercase.
- Transform: Spaces: Select how spaces should be auto-transformed. Options are:
- None - For no transformation.
- Replace Spaces - Replaces all spaces the user enters with a character you determine. (Summer_Bash)
- Remove Spaces - Removes all spaces from the text the user enters. (SummerBash)
Define the minimum and maximum length of characters a user is allowed to enter in open text fields. If the field is optional, set the minimum length to 0. If the length of characters is an exact number, set the minimum and maximum to the same number. -
Click Done.
The field displays in the work area. -
If the metadata entered in the Submission Table for this field needs to be sent to Google Analytics, click Target Mapping to associate a dimension in the appropriate Target.
Without this field to Target dimension association, no metadata will be sent to Google Analytics and the dimension will be unspecified. Not mapping this field will act as a Claravine-local field. - Find the Target Name, use the arrow to expand the view of dimension options for this Target.
- Check the box to the left of the dimension(s) name to map the field.
You can map a single field to many dimension in any Target. - Click Done.
- Click Save to save the Field Set.
Duplicate an Existing Field Set
To save time in creating Field Set, you can duplicate an existing Field Set. This allows you to copy most field parameters from the original Field Set and then modify field parameters on the new Field Set. Concatenation and Auto Fill fields will not duplicate prior settings.
When you duplicate a Field Set, any Target mappings that are designated on the parent Field Set will remain.
To duplicate a Field Set:
- On the Field Set page, click the checkbox to the left of the name of the Field Set you want to duplicate and click the Duplicate (plus + sign) button.
- Edit the Field Set details to your preference: Field Set name, description, and update the fields as needed.
- Click Save.
Edit a Field Set
To edit a Field Set :
- On the Field Set page, click the name of the Field Set you want to modify.
- Edit the Field Set details to your preference: Field Set name, description, and update the fields as needed.
- Click Save.
Delete a Field Set
To delete a Field Set:
- On the Field Set page, click the checkbox to the left of the names of the Field Set you want to remove.
- Click the waste bin icon for Delete.
A confirmation message displays. - Click Confirm.
- Navigate to Settings → Elements → Field Sets.
-
Targets Overview
Targets specify where data from between a Connected Account and Claravine flow. Administrators and Managers with target-management permissions have the ability to view and manage Targets.
You must have a Connected Account to use a target. For administrators that need additional information about creating a Connected Account, refer to the Accounts Overview article.
View a Target
To view Targets:
- Navigate to Settings → Targets.
The Targets page displays.
You can view the following information about Targets:
- Name
- Type
- Multi Targets
- Description
The sort feature is available for all columns. You can sort all columns in ascending or descending order.
Create a Target
To create a Target:
- In the Targets page, click the plus (+) sign to create a new Target.
The Edit Target menu displays. - Enter the Target Name and Description in the designated fields.
We recommend to enter a description to make it easier to determine the use of the target for future use. - Select the Integration Type from the drop-down menu (Google Analytics).
- Select the Connected Account from the drop-down menu. This list of Connected Account are populated from the Connected Account menu.
- Select the Property from the drop-down menu.
- Select the Custom Data Source.
- Enter the Custom Data Source Schema using a comma delimiter. (You can find this data schema in the Manage Uploads > Get Schema. Click Here to learn more.)
- Click Save.
Edit a Target
Administrators and Managers with target-management permissions can edit a target in order to:
- Change the Target Name, Description, selected Connected Account, Account, Property, Custom Data Source
- Resync the Data Source Schema from Google Analytics
To edit a Target to change the Target Name, Description, selected Connected Account, Account, Property, Custom Data Source:
- On the Targets page, click the name of the Target you want to modify.
The Edit Target menu displays. - Edit the Target details to your preferences.
- Click Save.
A confirmation message displays.
To edit a Target to re-sync the Data Source Schema from Google Analytics into Claravine:
- On the Targets page, click the name of the Target you want to modify.
The Edit Target menu displays. - Edit the Custom Data Source Schema to your preferences.
- Click Save.
- For new Data Source fields: Go to any Field Sets that require the new Data Source field to be added as a field. Add the field and map to the Target and Data Source.
Go to any Templates that require the new Data Source field to be added as a column within the Submission Table.
Delete a Target
To delete a Target:
- On the Target page, click the name of the Target you want to remove.
- Click the waste bin icon to delete.
A confirmation message displays. - Click Confirm.
- Navigate to Settings → Targets.
-
Pattern Overview
Companies using Google Analytics do not require a Pattern unless they are using a UTM ID or would like to utilize the Random or Auto # features in Claravine as part of the URL. If your company uses UTM ID or would like to include Random or Auto #, follow the steps below. If your company is using Claravine to generate a basic URL, please navigate to the Creating a Template for Google Analytics: Basic URL Structure document.
Administrators and Managers with pattern-management permission can create patterns or company-specific taxonomy for UTM parameters. A pattern is a configuration of Elements used to define and standardize your company's campaign parameters and URL.
The fundamentals of a Pattern remain the same no matter the use. The table below explains each Element:Elements Description Constant The Constant Element does not change within the pattern, such as a channel abbreviation (EM). Variable The Variable Element is the placeholder for values that will change, such as Campaign Name. Auto # The Auto # Element generates a sequential number to ensure a unique ID is generated with this pattern. Date The Date Element allows a user to add a date formatted to your organization’s preferences. Random The Random Element generates a different string value between 6-99 characters long and is generated using numeric digits (0-9), uppercase letters (A-Z), or lowercase letters (a-z). Delimiter The Delimiter is the character that separates each Element in your pattern. View a Pattern
To view Patterns:
- Navigate to Settings → Elements → Patterns.
The Patterns page displays.
You can review the following information about patterns from the Patterns view:
- Name
- Created Date
- Description
The sort feature is available for all columns. You can sort all columns in ascending or descending order.
Create a New Pattern
To create a new Pattern:
- On the Pattern page, click the plus (+) sign to create a new Pattern.
The Edit New Pattern menu displays. - Enter the Pattern Name and Description in the designated fields.
We recommend entering a description to make it easier to determine the use of the pattern, such as UTM ID, UTM Medium, etc. - In the Pattern Configuration section, click the Element to configure the taxonomy.
- In the Pattern Configuration workspace, click the Element name to define the parameters for each Element in the Edit menu.
Element Available Parameters Constant Enter the name of the constant for your pattern. Your constant should indicate what its consistent use is. For example SOC for Social channel. Variable Enter the name of the variable in your pattern. This variable name will become a header in the Submission Table. If the variable name is the same as a field, we recommend to change the font or add an identifier to easily distinguish the same named pattern variable and field. For example variable name in lower case "campaign name" or bracketed [Campaign Name]" to differentiate between the field name "Campaign Name". Auto Number Specify the following auto number parameters: - Name: Enter the auto number name to have a custom name as required by your preferences. The field defaults to Auto #.
- Starts With: Enter a custom number for the auto number to begin with. The field defaults to 1.
- Set Minimum Width: Enter the length or select the arrows to increase and/or decrease the length of the auto number. The field defaults to 8.
Date The Date field will populate in the submission table as a pop-up calendar widget. Specify the following date parameters: - Name: Enter the name of the date. For example change the name to Launch Date.
- Order: Select the order the date displays (M/D/Y, Y/D/M, D/M/Y, or Y/M/D).
- Month Format: Select the format of the month to display: single-digit (M), double-digit (MM), abbreviated (Jan), full name (January), or None to exclude the month from the date field.
- Day Format: Select the format of the day to display: single-digit (D), double-digit (DD), or None to exclude the day from the date field.
- Year Format: Select the format of the year to display double-digit (YY), 4-digit year (YYYY), or None to exclude the day from the year field.
- Separator: Type the character to separate the month, day, and year values.
- Auto Populate: Check the box to auto-populate the current date upon submission.
Random String Specify the following random string parameters: - Length of Random: Enter the length of the random string.
We recommend to use between 6 and 99 characters. - Valid Characters: Select if you want the random string to include numeric digits, uppercase letters, and/or lowercase letters.
- Frequency: Select if you want a new random string assigned to your pattern once every row (a new string for every pattern) or once per session (a new random string once for an entire submission).
Delimiter Select one of the following delimiter options to separate each of the pattern Elements: - None
- (-)
- ( _ )
- ( : )
- ( | )
- Arrange each Element in the order of your choosing by dragging. Delete the Element(s) by selecting theon the Element you want to remove. You can add as many Elements as required by your taxonomy.
- Confirm the pattern is correct in the Pattern Review section.
- Click Save.
Duplicate a Pattern
To save time in creating a Pattern, you can duplicate an existing Pattern. This allows you to copy the parameters from the original Pattern then modify as needed.
To duplicate a Pattern:
- On the Patterns page, click the checkbox to the left of the name of the Pattern you want to duplicate and click the plus (+) button to duplicate.
- Edit the Pattern details to your preference: Pattern name, description, and update the Pattern Elements.
- Click Save.
Edit a Pattern
To edit a pattern:
- On the Patterns page, click the name of the Pattern you want to modify.
- Edit the Pattern details to your preference: Pattern name, description, and update the Pattern Elements.
- If the Pattern removes or adds a new Element, navigate to the Template where this Pattern is used.
- Notice the error icon with the message, the pattern has been updated. Click the error message to be taken to the field in the schema on Step 2 Define and Govern.
- Hover over the pencil icon to open the Edit menu, then click the Reload button.
- The removed Pattern Elements will appear as blank fields, click the Delete button to remove them from the template.
- The new Pattern Elements will be added to the bottom of the schema. Modify the visibility, required/optional, field type, and order as needed.
- Click Save.
Delete a Pattern
To delete a pattern:
- On the Patterns page, click the checkbox to the left of the names of the Patterns you want to remove.
- Click the waste bin icon to delete.
A confirmation message displays. - Click Confirm.
- Navigate to Settings → Elements → Patterns.
-
Getting Started for Admin
Google Analytics to Claravine API Connection
Claravine can connect with either a Google Analytics Free or Google Analytics 360 account using an API connection.
- Within your Google Analytics account, navigate to the appropriate Account.
- Click Admin in the left-side menu.
- Under Property, click Data Import.
- Open an existing schema or create a new schema:
- Data Set Type - Extended Data Import - select Campaign Data.
- Data Set Details - enter the Data Set name. Enable the Views that will make use of the data in this Data Set.
- Data Set Schema - select the Acquisition, Advertising, and Custom Dimensions to be used in this schema. Select Yes for Overwrite Hit data.
For more information about creating custom dimensions, refer to the Dimension Widening and UTM ID article.
- Click Save.
- On the Data Import screen, click Manage Uploads for the Data Set.
- Click Get Schema.
- Copy the string in the CSV Header section.
- If you have not already created the Google Account in Claravine, follow the instructions to Create a Connected Account.
- In Claravine, navigate to Settings → Targets.
- Create or edit an existing Target with the correct GA Account, GA Property, and Custom Data Source selections.
- Paste the above CSV Header string into the Custom Data Source Schema field.
- Click Save.
- Within your Google Analytics account, navigate to the appropriate Account.
Comments
0 comments
Article is closed for comments.