🗒️ Note: This article refers to Assignments. Depending on your label alias configuration these might display differently in your tenant. Learn more here
🔒 Note: This capability requires Work Templates Admin to access. Learn more here
🔒 Note: This capability requires a feature flag to be enabled. Please contact Obzervr Support at support@obzervr.com to request enabling this.
Identifiers on groups, sections, and fields in Work Designer are commonly used for analytics reports and other integrations to uniquely identify links to specific groups, sections, and fields. Automatically generating identifiers gurantees a unique, meaningful identifier that can be easily used in analytics. This allows you to still be able to change field names without affecting the analytics setup, helping improve overall data consistency and reducing errors. Locking the created identifiers also prevents accidental changing of identifiers that are used in external integrations to prevent errors.
In this article, you will learn when identifers are generated and the naming convention used to generate identifiers. You will also learn how to bulk create identifiers for extisitng templates, as well as how to lock and unlock identifiers.
Click any of the following links to skip ahead:
- When is an identifier generated?
- How are the identifiers created?
- How to edit identifiers
- Identifier generation on pre-existing templates
When is an identifier generated?
dentifers are automatically generated once the group, section, or field is created and named. The identifer is automatically locked to prevent any unintentional changes.
🗒️ Note: Identifers can still be changed after creation if necessary.
How are the identifers created?
The identifier is generated with a prefix denoting its type, followed by an acronym from the first 3 words of its name. For sections or fields within groups, the prefix is followed by the group acronym before the section or field acronym. In the case of duplicate acronyms, a number is added as a suffix to differenciate them.
|
Legend |
Name | Description |
|---|---|---|
| 1 | Element type | This denotes the type of element identified. FLD (Field), SEC (Section), or GRP (Group) |
| 2 | Group Acronym | This is only present in fields or sections created within a group, and uses the acronym of the group to indicate its hierachy |
| 3 | Element Acronym | This is created from the first 3 words of the name of the element. where there are less than 3 words in the name, it takes more letters from the one or 2 words that are present* |
| 4 | Duplicate counter | Where there are elements with the same acronyms, a counter is added for each subsequent duplicate. |
*Where there is only one word in the name of the element, the first 3 letters of the word are used. In a 2 word name, the first letter of the first word and the first 2 letters of the second word are used.
How to edit identifiers
The identifer is automatically locked when it is created to prevent any unintentional changes.
Click on the lock icon to the right of the identifier to unlock the identifier. You will now be able to make any desired changes to the identifier. Click on the lock icon again to relock the identifier. Identifiers will also relock when the work template is saved.
🗒️ Note: Changing an identifier could affect any analytics or external integrations that use it
Identifier generation on pre-existing templates
When a fragment or work template draft with missing identifiers is opened, a system message will prompt users to automatically generate identifiers for all the elements with missing identifiers in bulk. If the fragment or work template opened is already published, the identifiers will be generated in a new draft template.
🗒️ Note: Automatically bulk generating identifers will not apply to fragment templates within the template. These will need to be seperately generated for each fragment.
Comments
0 comments
Please sign in to leave a comment.