Skip to main content

Forms Architecture

This chapter explores the architecture of Forms within the tSM system.

In tSM, Forms are associated with both characteristics and configuration profiles.

  • A configuration profile defines a list of characteristics.
  • A characteristic defines a specific form.

archs_entity_diagram.png


📘 Configuration Profiles

A Configuration Profile (also known as EntitySpecification in the TM Forum model) includes:

  • Characteristics – Stored in the chars attribute, these represent additional data points beyond the core attributes.
  • FormSpecification – A list of selectors that define which forms are linked to the core attributes.

For more details on tSM entities based on the TM Forum standard, see
TM Forum Entities & Characteristics

confprofile_config.png

Entity Types

Entities that include the entitySpecId attribute are linked to Configuration Profile settings.

For example, the Ticket entity type uses entitySpecId to access its associated configuration.

confprofile_config.png

📘 Characteristic

PropertyDescription
SubtitleThe name of characteristic.
JSON attribute nameThe key name used in the data model or API to represent this field.
Read permissionThe permission required to view this field.
Edit permissionThe permission required to edit this field.
FormSpecific form
Position in the form (deprecated)Defines the section or tab in the form UI where this field appears.
ES mapping typeElastic configuration
Display Order (deprecated)Indicates that this field is shown in read-only mode in the UI.
Readonly (deprecated)Indicates that this field readonly

confprofile_config.png