Version: 2.4

Entity Specification

An Entity Specification (also called Configuration Profile in the tSM UI) defines a subtype of a business entity by grouping Characteristics into a coherent set. It is the primary mechanism for distinguishing between, for example, a Retail Customer and a Wholesale Customer — both are Customer entities, but each has a different Entity Specification with different dynamic attributes, forms, and rules.

What it's for

Subtype definition — create meaningful subtypes (specifications) for any EntityType.
Dynamic attributes — bundle one or more Characteristics that define the extra fields for the subtype.
Form assignment — assign default forms for create, detail, list, and other UI contexts.
Supporting entity rules — control which attachment types, comment types, worklog types, and notification types are allowed.
Access control — optionally link an access policy for row-level security.

Entity Specifications are first-class configuration entities — they have validity, localization, audit trail, and can be organized with dataTags and configType.

Naming Convention

According to the TM Forum standard, this entity is called EntitySpecification. The tSM API and backend use this name. The tSM UI refers to it as Configuration Profile for user-friendliness.

For the architectural context, see Entities & Characteristics.

Key concepts

Characteristics binding

The characteristics field holds a list of Characteristics codes that this Entity Specification includes. When an entity is created with this specification, the platform renders and validates the corresponding forms for each characteristic.

For finer control, the characteristicsSpecification list provides per-characteristic overrides:

Field	Type	Description
`id`	UUID	Unique identifier.
`characteristicCode`	String	Code of the referenced Characteristics.
`config`	Map	Per-specification configuration overrides for this characteristic.
`defaultValue`	String	Default value for this characteristic within this specification.
`regexp`	String	Validation regex override for this specification.
`description`	String	Description override for this specification context.
`auditInfo`	Object	Standard audit metadata.

This allows the same Characteristics to behave differently in different Entity Specifications — for example, a contactEmail characteristic might be required in a Retail Customer specification but optional in a Wholesale Customer specification.

EntityType binding

The entityType field (FK EntityType.code) declares which "class" of records this specification applies to. Common examples:

EntityType	Example specifications
`Customer`	Retail, B2B, Wholesale, Internal
`Ticket`	Incident, Service Request, Change Request
`Order`	SDWAN Provisioning, Fiber Installation
`Product`	Internet Access, VoIP, IPTV

Form specification (`formSpecification`)

The formSpecification map assigns default forms to UI contexts:

{
  "new": "customer-retail-new",
  "detail": "customer-retail-detail",
  "list": "customer-retail-list",
  "card": "customer-retail-card"
}

Keys are context identifiers (e.g., new, detail, list, card), and values are Form codes.

Supporting entity rules

Entity Specifications can restrict which types of supporting entities are allowed:

Field	Description
`attachmentTypes`	List of allowed attachment type codes.
`attachmentTypeAllowEmpty`	If `true`, entities can exist without attachments. Default `true`.
`commentTypes`	List of allowed comment type codes.
`commentTypeAllowEmpty`	If `true`, comments without a type are allowed. Default `true`.
`defaultCommentType`	Default comment type code for new comments.
`worklogTypes`	List of allowed worklog type codes.
`worklogTypeAllowEmpty`	If `true`, worklogs without a type are allowed. Default `true`.
`notificationTypes`	List of allowed notification type codes.
`notificationTypeAllowEmpty`	If `true`, notifications without a type are allowed. Default `true`.

Access policy

The optional accessPolicyCode field links to an access policy that enforces row-level security — only users matching the policy can view or edit entities with this specification.

Mnemonic code

The optional mnemonicCode field (FK MnemonicConfig.code) links to a mnemonic configuration for automatic business key generation for entities of this specification.

Expanded characteristics

When requesting an Entity Specification via API with the CHARACTERISTICS expand key, the expandedCharacteristics field is populated with the full Characteristics objects (including their Forms), avoiding additional API calls.

Reference