Tag Generator

Type: User Documentation 29-Mar-2024 | Petr Reviakin

In this article

Tag Generator allows you to create a batch of tag numbers by using a prepared Tag Scheme. Tag Scheme helps to avoid mistakes and create correct Tag No for a specific Engineering Register, Function Code and Discipline.

Add Function Code

  1. In CMS Configuration, open the Function Codes tab.
  2. In Function Codes grid, create a function code by filling in Engineering Register and Function Code.
  3. Optionally, fill in Discipline if you want to create Tags with only that Discipline for that Function Code

Add Tag Scheme

In the Tag Numbering Scheme grid, you can configure parts of a Scheme which combine a Tag No. Create a Tag Scheme element by filling in a new row in Tag Numbering Scheme Grid.

  • Discipline: auto-populated to new Tag. You can only use Discipline that is configured in the related Function Code. Otherwise, you can create different schemes with different Disciplines. Option ALL allows you to create a scheme without linking to a discipline and configure it by yourself in Tag Details after creation.
  • Part No: position of an element in a scheme
  • Label: name of an element
  • Tooltip: optional element content hint
  • Field Type: can be one of options:
    1. Function Code: auto populate current Function Code, not editable.
    2. FreeText
    3. FixedValue: configurable value, not editable
    4. Numeric: only numbers
    5. Plant: auto populate Plant name from Tag Generator form, not editable.
    6. Sequence: option with 1-4 digits, which can be looped for creating unique Tag No
    7. System: populate System name from list of Systems
    8. TagNo: populate another TagNo from list of Tags
    9. Lookup: allows to configure lookup with any views and fields from CMS
  • Separator: character that will appear in TagNo after element value
  • Length: allows to choose number of digits from 1 to 4, available only for Sequence Type
  • Lookup Value Member: available only for Lookup Field Type
  • Fixed Value: available only for Fixed Value Type
  • Auto-Populate FieldName: element value from Scheme will auto-populate in chosen Tag Field after tag creation
  • Mask: limit how field value should look like
    1. A – Alpha character A-Z
    2. N – Numeric character 0-9
    3. Z – Alpha or numeric character
    4. | – allows to use multiple masks; example AA|AAA - value that can have 2 or 3 letters
    5. You can use any specific characters and combine them – example 5A.K means that value must has 5 in the start, “.” (dot) and K in the end, and any letter in the middle
  • Required: making this element mandatory to fill in Tag Scheme

Configure Lookup Value Member

  1. Choose Lookup as Field Type in the Tag Numbering Scheme.
  2. Click on the field Lookup Value Member with arrow in the same row.
  3. This will open a modal window to configure Lookup by choosing View Name, Fields, Lookup Value Member. The value from the chosen field will be populated to generated tag. Where Clause is optional.

Allow Tag Generator for Register

  1. In Engineering Setup open Register.
  2. In Settings tab Enable Tag Creator Tool.
  3. Save changes.

Tag Generator

  1. In Engineering Registers choose a register from the left side panel
  2. Click Tag Generator above a grid
  3. Fill in the main Tag Generator fields: Function Code, Plant, Project, Number of Tags
    1. # Tags: number of Tags that would be generated
    2. From/To: fill specific numeric interval, works when Scheme has Sequence element.
  4. Fill Tag Scheme elements.
    1. % - you can use running values by this character; it would be looping value for every new generated Tag No
      • In Sequence element loops only digits
      • In Free Text element running value works only with single character Mask (only A or N), also forces sequence be fully filled
    2. Use next available – this option will find next available Tag No according to the Scheme and replace all % in sequence, would be active only when full Scheme is filled
  5. Click the Generate button to generate TagNos in the grid below.
  6. Click the Validate button to validate generated TagNos.
  7. Click the Create button to create new Tags. Only Tags with Status OK will be created.

Mandatory fields

Mandatory fields is an option to display which fields aren’t filled in a Tag based on specific Function Code. It helps to see what required data is missed for each Tag. Mandatory fields are displayed only at Engineering Registers.

Enable Mandatory fields sidebar

  1. In Engineering Setup, open Register.
  2. In Settings tab, check Enable Mandatory Fields Sidebar In Engineering Register.
  3. Save changes.

Now you can see the sidebar with all mandatory fields in Engineering Registers.

Configure Mandatory Fields

  1. In CMS Configuration, open the Function Codes tab.
  2. Choose a Function code which you want to configure and open the Mandatory Fields tab below.
  3. Add Tag field names.

Default Values

With Default Values you can auto populate to new generated Tag any value to any field.

Configure Default Values

  1. In CMS Configuration, open the Function Codes tab.
  2. Choose Function code which you want to configure and open the Default Values tab below.
  3. Choose Field Name and fill in Default Value.


In this article