Management of Classes

Modifying and creating classes within a template is straightforward. After selecting the desired template from the template tree pane, the Edit template view becomes available, where classes can be managed. Classes appear under the selected template in the order they are displayed on data cards, initially following their order of addition. This order can be adjusted within the Edit template view.

To organize classes within a template, assign a sequence number to each class. The specific numbers used are not critical, but employing a logical sequence facilitates easier insertion of new classes without needing to adjust existing sequence numbers significantly. For instance, using a base-ten numbering system (10, 20, 30, etc.) simplifies placing a new class between existing ones.

By default, all classes are expanded, but they can be set to appear collapsed in the template by checking the corresponding checkbox in the Collapsed column. Attributes of collapsed classes will not be visible in data card views or edit modes until the user chooses to expand them.

Classes also enable the organization of attributes, including setting attributes as unique or mandatory and defining their default visibility in search results.

Management of Attributes

Attributes, the fundamental units of the ESM data model, specify the individual fields on data cards and include rules and properties for displaying information. Attributes can be static or dynamic, single or multi-valued, and administrators have the flexibility to create and modify them. Attributes are a method to store a single value on data cards. Individual attributes can be added and modified without service interruptions. Attributes can be thought of as form fields, where the details of an individual data instance (data card) are stored.

A key concept is the primary attribute, which names data cards based on the template. A template without a primary attribute is marked with an exclamation point, indicating it's non-identified. In such cases, data cards derive their names from the first accessible attribute.

Each attribute consists of at least a name and a data type. The following data types are available:

• String, with a maximum of 450 characters.
• Text
• Integer, Can be a number up to 10 digits. 
  • For example, "10000000001" can't be stored, as it has 11 digits.
• Decimal
  • Output pattern can be configured in the platform settings decimal.output.pattern.
• Date
  • Input and output pattern can be configured in the platform settings date.input.pattern & date.output.pattern.
• Date and time (datetime)
  • Input and output pattern can be configured in the platform settings datetime.input.pattern & datetime.output.pattern.
• Reference (the attribute's value is a relation to another data card, for example a Team assigned to a Ticket. In this case, a Ticket refers to a Team)
• Back-reference (the attribute's value is a relation to another data card forming a pair with a referrer data card. The value can be changed on the reference or back-reference, but the paired values on both data cards are always synchronized. The data card with the back-reference value is being referred to)
• External reference (link to a webpage or a file on a file server)

Decimal, date, datetime have specific output pattern platform setting.

An attribute can be configured to contain only one value or multiple values. It's possible to define a fixed set of selectable values for an attribute.

Attributes can be enabled only under certain conditions, creating dynamic data model content. For example, an attribute can be enabled only if another attribute has a specific static value. These condition attributes must be string type attributes with static values.

Special handlers can be assigned to attributes to add functionalities like calculations or value combinations. For more on using special handlers, consult the Attribute Handler Guide available within the Administration > Templates section.

Each template should have a primary attribute, because data cards based on the template are named on the basis of the primary attribute. A template without a primary attribute is a non-identified template and is shown in the template tree with an exclamation mark icon. If a template does not have a primary attribute, data cards based on that template get their name from the first user-visible attribute.

Attribute Creation

Creating a new attribute involves selecting a class within a template and then choosing "New attribute" from the display menu. The New attribute view allows for the input of basic information, properties, and appearance settings for the attribute:

Basic information includes the attribute's name, an optional description, and help text, which can contain HTML tags for formatting.

Basic properties cover the attribute's handler, data type, and default value. Notably, the data type is fixed upon creation and cannot be changed later. Default values are particularly versatile, supporting date macros and references, including the current user's data card.

Appearance settings determine the attribute's visibility on data cards, with options for view and/or edit modes, and can include header and footer texts for additional context.

Attribute Data Types

Data types define the form and type of data an attribute can hold, ranging from strings and numbers to dates, references, and more. Each data type has specific characteristics and limitations:

Reference Attributes

After the initial save of an attribute with a reference data type, settings for specifying the reference target become available. This includes selecting possible reference templates and configuring how referred data cards are displayed.

For reference attributes pointing to the ESM “user” template (which could be named differently but is identified by the template code “admin”), it's feasible to set the current user’s ESM user card as the default value. This is done by using the #user# macro or $USER$ for a direct reference to the “user” template. This functionality automatically links the attribute to the active user's data card within the system.

If the current user lacks a corresponding ESM “user” data card, as might be the case with a root user, then no reference will be established. Moreover, it's possible to extend this default value to refer to other templates associated with the ESM "user" template by specifying a path like #user:attribute_code#.

Example:

For an "Incident" data card with a "Contact person" field, setting #user# as the default value creates a link to the current user’s ESM "user" data card. If the ESM "user" template includes a reference to another template, say a "Person" template with an attribute code of "person", you can use #user:person# to default to that specific reference.

This method allows for both direct references and back references within reference paths, facilitating complex reference chains like #user:code1:code2#. However, it’s essential that every attribute in the path be a single-value reference attribute to ensure the integrity of the reference path. The concluding attribute in any reference path must align with the target templates of the attribute being set up, maintaining a coherent link throughout the chain.

Key Points:

• The #user# macro or $USER$ can define default values for reference attributes targeting the ESM “user” template.
• Default values automatically link to the current user’s ESM user data card, facilitating personalized data card configurations.
• Extended reference paths allow linking to further templates via the ESM "user" template, broadening the scope of default values.
• All attributes within a reference path must be single-value reference attributes to function correctly, ensuring clear and direct linkage to the intended target templates.

Static Attributes

Static attributes use predefined values from which users can choose. Creating static values for these attributes is a process that needs to be done cautiously to avoid impacting existing data cards. 

When adding values to attributes in your system, it's important to understand the distinction between static and dynamic attributes.

Adding Static Value: Static values can only be assigned to static attributes. During the attribute creation process, ensure to check the "Static" checkbox. Once this is done, you're then able to define values for this static attribute.

Using Existing Static Attributes: Opting to use an already defined static attribute means inheriting all its associated static values. Be cautious; altering a value for a static attribute updates this value across every template that includes the attribute. This change cascades, modifying the values in all data cards associated with those templates. To avoid unintended data alterations, consider creating a new static attribute when its current values don't fit your needs.

Creating a Static Attribute: The system automatically generates a static value entry sharing the name with its corresponding static attribute upon creation. This feature aids in easily identifying which static values are linked to which attributes.

Editing Static Attributes: To edit a static attribute, locate it within the Templates tree pane, which will bring up the "Edit attribute" view. For adding or modifying static values, navigate to "Menu values" within the display menu, leading you to the "Static values" view. Here, you can enter new static values, which will then be selectable during data card creation.

Conditional Attributes

Conditional attributes are displayed only when specific conditions are met, allowing for dynamic content within templates.

Creating dynamic template content through conditional attributes allows for a more interactive and responsive user experience. This feature enables attributes within templates to become visible or active based on specific conditions, such as the value of another attribute. Here's how to effectively utilize conditional attributes:

Creating a Conditional Attribute:

1. Initial Creation: Start by crafting a new attribute, selecting the datatype that fits your needs, and then save it. This initial save is crucial for retaining the selected datatype.
2. Setting Conditions: After saving, locate the "Enable if" field, which lists static string attributes. Select the attribute that will act as the trigger for enabling your new attribute.
3. UI Reload: Upon setting your condition, the user interface (UI) will automatically refresh, presenting you with options for values that activate the conditional attribute.

Configuration Tips:

• Selecting Values: You can choose one or multiple static values as the criteria for enabling the conditional attribute. The attribute becomes active when any of these specified conditions are met.
• Chaining Attributes: Conditional attributes can be linked in a chain where the visibility of one depends on the value of another, and so on. This chain can extend to multiple levels, creating complex visibility and activation scenarios based on multiple conditions.
• Mandatory Fields: If a conditional attribute is set as mandatory, the requirement for filling it out is enforced only when the attribute is visible, meaning its conditions have been fulfilled.

Important Considerations:

When handling data, be aware that if the conditions for a conditional attribute are no longer met, its value will be removed from the database. Should the conditions be met again later, the data for the attribute will need to be re-entered.

Utilizing conditional attributes allows for the creation of templates that adapt to the data entered, enhancing the usability and efficiency of forms and data entry processes. This dynamic approach ensures that users are only presented with relevant fields based on their specific inputs, streamlining the data entry experience.

Editing Attributes

To edit an attribute's properties within a class, select the class under the desired template. The Edit class attributes view allows for adjustments to names, order, codes, and visibility settings among others.

To adjust the properties of attributes within a specific class of a template, follow these steps:

1. Accessing Attribute Properties: Navigate to the template you're working on and select the class containing the attribute you wish to modify. This action opens the "Edit class attributes" view, providing a detailed overview of the attribute settings specific to the chosen class.
2. Understanding Scope of Changes: Changes made in the "Edit class attributes" view affect only the attributes within the selected class. For example, adjustments to the "Display(s)" attribute in the "Workstation information" class will not impact any other class the attribute might belong to. However, the class's properties, such as attribute requirements and visibility, apply universally across all templates that incorporate the class.
3. Pre-editing Check: Before making edits, verify if the class is used across multiple templates. This precaution ensures you are aware of the broader impact your changes might have due to the class-wide application of attribute settings.

Editing Basic Information of an Attribute:

• Name**: Defines the attribute's label. Clicking on the attribute name opens the "Edit attribute" view for more detailed modifications.
• Order: Controls the sequence in which attributes appear within the class. Use logical increments (e.g., 10, 20, 30) to facilitate the addition of new attributes later without needing to overhaul the existing order.
• Code: Serves as a unique identifier for the attribute, crucial for data import processes and when applying specific handlers to attributes.
  • Note: Assigning a code to each attribute is essential.
• Required: Ensures data cards cannot be saved unless a value is entered for this attribute, thereby enforcing data completeness.
• Unique: Guarantees the attribute's value remains unique within all data cards sharing the class. The system checks for uniqueness both during data card creation and data import. Uniqueness can be scoped either to the visibility range of the editing user or globally across the entire system, with the specific mode adjustable in platform settings.
• Selected: Determines whether the attribute is visible by default, such as in search result lists, enhancing user experience by prioritizing important information.

Remember, when configuring attributes, consider the broader implications of changes to ensure consistency and integrity across your system's data structure.