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. In Field Sets, Administrators can create the fields to be used in the Submission Table, define each field's data type, and add governance, formatting, and restrictions.
View Field Sets
- 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 +Create Field Set button.
The New Field Sets work area displays.
- Enter the Field Set Name and Description (optional) in the designated fields.
We recommend creating one Field Set per Template and naming it the same (e.g. Meta Campaign Taxonomy Fields) to easily determine the purpose of a particular Field Set from the menu.
-
Add Fields by one of three methods:
-
- Click the import button, then select Import from Targets button to create fields for each classification in a designated Target (report suite and evar/report). The field Name is populated with the Adobe classification name, but can be changed to a different name in the Field Set.
- Click the import button, then select Import from Lists button to create a field for each column of the selected List. The field Name is populated by the column header, but can be changed to a different name in the Field Set.
- Click the +Add Field at the top-right of the work area to add a field.
- Enter the new field Name (required).
- 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 dropdown menu. Refer to the Field Type Options section below.
- Click Done.
The field displays in the work area.
You can see the Name, Updated Date, Type, Required, and Target Mapping columns.
-
If the metadata entered in the Submission Table for this field needs to be sent to Adobe Analytics, click the Map this field button to associate the appropriate Target and classification field.
Without this field to Target classification association, no metadata will be sent to Adobe Analytics and the classifications 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 classification options for this Target.
- Check the box to the left of the classification(s) name to map the field.
You can map a single field to many classifications 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.
Note that 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 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. Or click the checkbox to the left of the name of the Field Set you want to edit and click the Edit button.
- Edit the Field Set details to your preference: Field Set name, description, and update the fields as needed.
- Click Save.
Refer to Field Sets and Templates: Best Practices for Deleting Fields before deleting any fields or field sets to prevent unforeseen problems.
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 Delete.
A confirmation message displays.
- Click Confirm.
Refer to Field Sets and Templates: Best Practices for Deleting Fields before deleting any fields or field sets to prevent unforeseen problems.
Designate Fields as Required
Fields can be designated as required in two places: in the Field Set and in the Template.
Required on the Field Set
If a field is marked as required at the Field Set level, that field will automatically be required and unchangeable in the template. This allows for global consistency without managing each template individually. The required checkbox is defaulted to required and grayed out.
Field in the Field Set:
Field in the Template:
Required on the Template
If a field is marked as optional at the Field Set level, that field can be designated as optional or required per the template. This allows the admin to make the field required in some templates but optional in other templates while utilizing the same field set.
Field in the Field Set:
Field in the Template:
Field Types (List, Autonumber, Auto Fill, Concatenation, Constant, Date, Number, Text)
Field Type: List
Lists allow a defined list of allowable entries the user can select from. Select the List from the drop-down menu either by scrolling or begin typing the 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.
- Check the box Select Multiple Values if the user should be allowed to select more than one value from the list in the Submission Table. Define the delimiter.
For more information, refer to the Lists Overview article, or, for more detailed instructions on each of the list types, read their respective articles: List - Dropdown, List - Dependent, List - Drill Down.
Field Type: 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.
Field Type: Autofill
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)
Field Type: Concatenation
Combine the values from two or more fields into a single field. Concatenated fields can use all field types: text, 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.
Learn more about concatenation in our Field Sets - Concatenation article.
Field Type: Constant
Specify a constant value that you want to always be populated in this template in the Submission Table:
.
Field Type: 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.
Field Type: Number
This data type only allows number entry, including decimal values. Number-type fields support a minimum number, a maximum number, and a default value. They allow users to enter specific budget ranges; e.g., '20-455' dollars.
Currency Symbols With Numbers
To enforce a currency symbol position, you can build a concatenation with a symbol and a number type, like this:
$ + Number or Number + $
Using concatenations, you can even enforce spaces.
Field Type: 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) list to populate suggestions for users to choose from, or they can enter their own text.
Rules for Text Fields
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.
Transform Values in Text Fields (Letter Case, Spaces, Split & Extract)
Use the options in this section to automatically apply transformations to values entered into this field. You can configure multiple text transformations on the same field (for example, convert case and split & extract).
Convert Case
Select uppercase to have all text display in capital letters; select lowercase to have all text display in lowercase.
Replace or Remove 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)
Split & Extract
Split & Extract is useful for auditing and validating existing campaign data against naming conventions and marketing taxonomies and helps you quickly convert coded dimensions into readable formats.
Use this transformation split text based on preset or custom delimiters:
To apply the Split & Extract transformation:
You can apply Split & Extract transformations to Text, List, or Date field types. Apply the transformation to the field into which you’re placing the parsed value. By default, values will be extracted only once. Resubmissions that edit the source fields won’t cause the final value to be updated.
Note: The supported field types for "Source Field" are "text" or "date" field type.
- Navigate to the field where you want to apply logic and scroll down to the Transform section of the field configuration drawer.
- In the Extract Data field, select Split and Extract on Delimiter.
- Set configuration options for the transformation:
- Extract Data From: Select the source field from which to extract data. Source fields must be of type Text or Date, and must be saved to the field set prior to appearing in the dropdown.
- Delimiter: This is the character the text will be split on, and it is required. Either select it from a list of common delimiter options, or enter a custom value.
-
Position: Specify the position of the of the data as parsed by the delimiter.
- Mark the Allow Reprocessing button if you want the value to be regenerated on resubmissions. If you don't select this button, values will be extracted only once and resubmissions that edit the source fields won’t cause the final value to be updated.
- Optionally paste the example text from which you want to extract the data (your source field value) in to the Preview field to help verify your logic. This preview field will highlight the position number you entered when you specified the Delimiter and desired Position.
You can apply multiple levels of naming conventions. Use multiple Split & Extract transforms in combination to split apart text containing multiple levels of conventions. For example, you can first split the value value1-value2a_value2b-value3 into value1, value2a_value2b , and value3. You can then split value2a_value2b into value2a and value2b in the same template.
Default
Enter a default value for the text field.
Character Length for Text Fields
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.
Learn More
- Training in Claravine Academy: About Field Sets
Comments
0 comments
Article is closed for comments.