Domain Context Registration

Modules integrated with Ticket Management can register a domain context. This allows for the association of tickets with a specific domain and the definition of custom context attributes, which can be used for filtering and data organization.

Prerequisites

To register or manage a domain context, the calling application must be assigned the Ticket Context Registrar role.

Registration and Management

Domain context are managed via the REST API that facilitates registration, modification, and deletion. All operations are performed through backend-to-backend communication.

Example Request Body

To register a domain context, provide a request body with the following fields. See Ticket Management API for details.

name (string): The name of the domain or module (e.g., Shift Book, Condition Monitoring). This appears as a filter option in the ticket overview UI.
attributes (list): A list of domain-specific context attributes. Each attribute object defines its properties, such as whether it is mandatory.

Example: Condition Monitoring

For CM, the context includes a single, optional attribute:

code (optional)
- For CM, because of the customized implementation of "fine-grained access control" and definition of "automatic ticket", the code attribute is fixed and must be optional. New context attribute can still be registered for CM.

Example: Setup-Specs

For Setup-Specs, the context may include the following attributes:

productFamilyId
productTypeId
productVariantId
productId
typeNumber

Ownership and Permissions

When a module registers a domain, the owner is set to the registered application and cannot be changed by other non-privileged applications.
If a domain has no owner, any module can modify or delete its context. The module that performs the action becomes the new owner.
A privileged user can register, modify, or delete the context of any domain, regardless of ownership.

Rules for Modifying Context Definitions

Changes to a domain’s context definition only apply to newly created tickets. Existing tickets are not migrated or updated.

Adding: New context attributes can be added to a domain.
Removing: Existing context attributes can be removed.
Updating: An attribute’s characteristics (e.g., mandatory flag) can be updated.
Renaming: Renaming an existing context attribute is not permitted.

The maximum number of context attributes that can be registered per domain is 5.