Identification Basics

Overview

The tSM platform uses several types of identifiers across its entities. The specific combination of identifiers used for an entity depends on the entity's intended purpose.

Types of Identifiers:

• ID: An internal UUID automatically generated by the system (not visible in the UI).

• Name: A descriptive label provided by the configurator, serving as a basis for generating the Code.

• Key: An identifier generated via the Mnemonic component, allowing configurable static or dynamic prefixes and suffixes, combined with a definable numeric sequence.

• Code: A structured, human-readable identifier used primarily for APIs and configurations. Usually derived from the entity’s chosen Name.

Key vs. Code

The fundamental difference between a Key and a Code is their generation method and purpose:

• A Code is typically defined for each entity record by adjusting the selected entity name to meet external identifier requirements, facilitating easier manipulation and integration.

  Example (Order Type):

  • Name: Resident / block
  • Generated Code: Resident.Block

• In contrast, a Key is defined through the previously mentioned Mnemonic, a script-based component where you can combine constants (e.g., "ORD_"), variables (e.g., customer number), and numeric sequences (e.g., 1–1,000,000) into flexible structures.

  Example (Customer Account):

  • Automatically Generated Key: ACC_ZAK15_12345

Most entities use a combination of ID + Name + Code, while entities that typically have a high number of instances—such as customers, orders, and product instances—utilize a combination of ID + Name + Key.

One notable exception is the Characteristic entity, which contains five identifiers: the standard ID, Code, and Name, plus an additional JSON identifier (used in scripts and processes), and a Title, displayed in the UI whenever the characteristic is used in forms.