Configuration Entity Naming Conventions
In certain cases, especially with type-oriented configuration entities (usually containing "Type" in their name), the complete configuration or template involves multiple interconnected entities. To simplify the configuration process, the tSM platform provides the ability to automatically generate these related entities along with their initial setup. The names and codes of these automatically created entities are based on the primary type entity name that you define.
A common example is the configuration entity "Order Type" (e.g., "Residential / Internet / Soft Suspend"). Alongside this main entity, the system can automatically generate related entities such as:
- Configuration Profile: Defines the default behavior and groups all relevant configuration entities together.
- Form New: A form used for creating a new order instance.
- Form Detail: A form displaying detailed information about an existing (completed or processed) order.
- Form Selfcare: A form tailored specifically for self-service scenarios.
- Process Definition: A definition of the workflow associated with the specific order type.
Additionally, it's possible to define a simplified version of entity mnemonic keys by specifying only a prefix and using a basic numeric sequence (from 1 to infinity). However, for production environments, it is strongly recommended to leverage the full capabilities of mnemonic configuration, including static and dynamic prefixes, suffixes, and custom-defined sequences.
Below is a clear and practical example demonstrating how entities are automatically generated. For further examples and to experiment with different naming conventions, refer to the Naming Helper provided in the next article. This tool allows you to test various entity names and instantly see how the system generates associated entity titles and codes, or how you should manually name entities if needed.
Example of Automatically Generated Configuration Entities
Entity Type: Order
Defined Entity Name: Residential / Internet / Soft Suspend
| Entity Type | Title | Code |
|---|---|---|
| Order Type | Residential / Internet / Soft Suspend | Residential.Internet.SoftSuspend |
| Configuration Profile | Ord / Residential / Internet / Soft Suspend | Ord.Residential.Internet.SoftSuspend |
| Form New | Ord / Residential / Internet / Soft Suspend / Form / New | Ord.Residential.Internet.SoftSuspend.Form.New |
| Form Detail | Ord / Residential / Internet / Soft Suspend / Form / Detail | Ord.Residential.Internet.SoftSuspend.Form.Detail |
| Form Selfcare | Ord / Residential / Internet / Soft Suspend / Form / Selfcare | Ord.Residential.Internet.SoftSuspend.Form.Selfcare |
| Process | Ord / Residential / Internet / Soft Suspend | Ord.Residential.Internet.SoftSuspend |