Skip to content

Name Generators#

🔒 Administration.NameGenerators

A Name Generator provides a mechanism to generate unique object names.

A Name Generator is identified by a unique name and contains:

  • A collection of Tokens that describe how the name is generated (order, format and calculation method).
  • A collection of Name Generator Contexts (a context is a string representing the generated Name without any counter generated data).

name_generator_tokens

For Name Generator(s) with rollover counters, the system needs to keep track of a context to know what is the next counter value to be used.

For increased flexibility, the system provides a DEE Action to resolve the Name Generator to be used for a given context. The ResolveNameGenerator DEE ensures that each entity has a valid name by cross-referencing it with the NameGeneratorContext Smart Table. If an entity lacks a name during creation, the system generates a default one based on its type. For example, an object might be named "Object1".

Info

For specialized naming requirements, you must create custom Name Generators. Then, you need to update the Action Groups in the ResolveNameGenerator DEE to incorporate these generators for specific entity types. This ensures that the system uses the appropriate naming conventions for different types of entities.

Screenshot showing a user interface for creating and updating custom Name Generators in the Resolve Name Generator DEE.

Info

Name Generator(s) can be used to automatically create Change Set names for versioned objects. This can be configured in the Entity Types page of the desired object.

Counters#

There are two counter types:

  • Rollover - the counter is incremented for a given context, once the context is changed it's reset to zero.
  • Absolute - the counter is always incremented.

Rollover counters are maintained for a given context, start with the value one and are always incremented by one.

Browsing Name Generators#

The default page in the Administration menu lists all the available Name Generator(s):

name_generator_list

If you select a Name Generator, you can see its details:

name_generator_details_view

Info

The Contexts only apply to Rollover Counters.

Creating a Name Generator#

🔒 NameGenerator.Create

To create a new Name Generator, select Create on the top ribbon and follow the instructions below.

Step 1 - General data#

  1. Provide a name.
  2. Optionally, provide a description.
  3. Select whether the context is deleted on context change - a context is used to find the counter (only applicable to Name Generator(s) that contain Rollover Counters).
  4. Select whether the Name Generator is synchronous, that is, the counter sequences are not increased if the transaction fails.
  5. Enter the last absolute counter value (applicable if the Name Generator contains an Absolute Counter).

  6. Define the context retention type:

    • Do Not Purge Contexts - the contexts are not deleted.
    • Do Not Store Contexts - the contexts are not even stored.
    • Purge Contexts With Retention Time - the contexts are deleted after the defined retention time (default).

  7. If the context retention type is Purge Contexts With Retention Time, define the number of days after which the contexts are purged.

name_generator_create_step_one

Step 2 - Tokens#

  1. Add as many tokens as desired in the left side panel. The order of the tokens can be altered by selecting the arrows on top of the left side panel. Each added token should be configured on the right side panel by specifying:

    • Name
    • Description (optional)
    • Calculation Method:
      • Absolute Counter - a counter which is never reset, it increases by one every time. In this case, the Value field has no meaning, but the Format field can be used to specify how the counter value will be formatted.
      • Constant - a constant as defined in the Value field. In this case the Format field has no meaning.
      • Date Time - the current server local time. Do not provide a Value in this case, but rather a Format.
      • Dee - value must contain the name of a valid Dee rule. Also the Format can be used to specify how the resulting value will be formatted.
      • Fiscal Date Time - the current fiscal information according a defined Fiscal Calendar, in this case the Value must refer to a valid Fiscal Calendar and its desired part. Also the Format can be used to specify how the resulting value will be formatted.
      • Guid - a system generated Guid (Globally Unique Identifier). The Value and Format fields have no meaning in this case.
      • Not Defined - no Calculation Method is defined.
      • Property - the value of a property of a given entity type. The Value field must contain the name of the Object and Property.
      • Rollover Counter - a counter which is reset every time the context changes. In this case the Value field has no meaning, but the Format field can be used to specify how the counter value will be formatted.
    • Format (depends on the selected Calculation Method, and can be used to specify how the resulting value will be formatted - refer to the String Formats page).
    • Value (depends on the selected Calculation Method and may require further contextual information).

name_generator_create_step_two

Info

A Name Generator can only contain one counter, be it rollover or absolute.

Warning

To associate a Name Generator with the creation of an object, it is necessary to edit the DEE Action ResolveNameGenerator. This configuration must be performed by expert personnel only.

Managing Name Generator Tokens#

🔒 NameGenerator.Edit

The tokens included in a Name Generator can be edited from within the main Details page by selecting the Manage button in the Tokens section of the page:

name_generator_manage_tokens

Terminating a Name Generator#

🔒 NameGenerator.Delete

It is possible to delete an existing Name Generator by opening it from the list and then selecting the Delete button:

Screenshot showing a name generator deletion process with instance name "BOMinstanceNameGe".