Valuelist types

Valuelistists in PeakTMS can be just a simple list of values or a more complex structure with multiple attributes, e.g. if it is used as a template.

The valuelist type manager allows to define the valuelist types which are used in your organization and the internal structure of each valuelist which is necessary to describe it.

The value type list view

The list view provides you with an overview over all currently registered valuelist types. You can use the table headers to define filters or to change the column width and order. Pressing the column chooser icon will give the possibility to add additional columns, e.g. about the change history.

Overview registered valuelist types

Definition of general information

General attributes of valuelist types

A rule snippet contains the following information

Name

Defines the label of the valuelist type shown to the user in the application

Manual id

A clear unique technical name is specified, which should not be changed later. It is uses to address a data pools in other technical modules like reports, email content, tms rules, rest api

Display attribute

From the dynamic atttributes one attribute has to be selected which is used to specify the name of a valuelist. Mostly a TEXT, ID or COMPOSE attribute is used therefore.

Sorting attribute

Specifies the default sorting of valuelist. Mostly the "display name" attribute is used. However also selecting an alternate attribute of type NUMBER is common, e.g. to sort equipment based on a running number.

Log change?

If activated, then than all changes on the valuelist item will be logged and provides as history

Composite unique

In the section dynamic attributes it can be specified that they must be unique. In case compose unique is activated than the combination of the attributes marked "unique" must be unique when saving valuelists.

Data pools

Definition into which data pool the valuelist belongs. The assignment to data pools indirectly steers which user groups will have access to the valuelists of this type. While multiple selection is possible it is best practise only to assign one data pool. Otherwise, the matrix between user groups and valuelist types might become very complex.

Default columns

From the available attributes the user can select a set of ordered attributes which will be the base for display of valuelists of this type in tables. Additionally, it is based for the tooltip description of a valuelist.

Definition of dynamic attributes

Additionally to the general information, each resource type can have a set of dynamic attributes which are used to describe the resource. Attributes are grouped into named groups. Each attribute has a type which defines the input method and the data type of the attribute. Please refer here for available attribute types: Dynamic attributes types.

Example of dynamic attributes of a resource

In this area you can declare:

Dynamic attribute groups

They are used to group the attributes in the resource type input masks. They also define the layout in which the attributes are displayed.

Dynamic attributes

They are used to describe the resource. Each attribute has a type which defines the input method and the data type of the attribute.

The examples below show how fields are positioned in the input mask based on the definition of attribute groups and attributes.

Example, position attributes within a group

Example, position attributes within a group

Adding / Editing an attribute group

Groups can be added through clicking on the corresponding icon . If there is already at least one group clicking on it and selecting in the context mene "Add group above" or "Add group below" will add a new group as well.

The properties of a group can be edited directly in the table.

Name

Name as it appears on labels and column headers.

Manual Id

Logical name as it might be used to address the field in reports, email, Rest API or Rules engine. This property should not be changed once given.

Columns

The columns of a group split the mask into several columns in which attributes can be placed.

Pressing the button in a row deletes the attribute group including all attributes within the group.

Adding / Editing an attribute

Attributes can be added through clicking on the corresponding icon . Alternatively, if there is already at least one attribute clicking on it and selecting in the context menu "Add attribute above" or "Add attribute below" will add a new attribute as well.

Name

Name as it appears on labels and column headers.

Manual Id

Logical name as it might be used to address the field in reports, email, REST API or rules engine. This property should not be changed once given.

Datatype

Specific data type of the attribute

Columns

Specifies the relative width of the attribute within its group, through defining how many columns of group columns are "occupied".

Mandatory

Whether the attribute is mandatory for input.

Unique

Whether the attribute value must be unique over all resources of this type. Not available for all data types.

Copy

The flag defines if the attribute value is copied when copying a resource.

Settings

Depending on the data type different special settings are available in . If there is no icon, then the data type doesn't support special settings.

Pressing the button in a row deletes the attribute.

Definition of field write permissions

The application allows to define for each attribute of a resource type the field write permissions. This is done in the field permission area. Field write permissions can be assigned directly to a user group / user or based on existing data values of other attributes. Finally, also the rules engine code snippets can be used to define complex rules for field write permissions.

info

If for attributes no specific field write permission is defined, then the default behavior is that all users with access to the resource type can edit the attribute.

Adding / Editing a field write permission

When adding a new field write permission, follow this process:

1. Select the attribute for which the permission is defined. Alternatively you can also choose All to define a permission for all attributes of the resource type.
2. If applicable select in Based on an attribute which is used to define the permission based on its value. If no attribute is selected, then the permission is defined for all resources of this type.
3. Select the user group or user for which the permission is defined.
4. If a Based on attribute is selected, then select the value of the attribute for which the permission is defined.

The picture below permits the group Administrator to have write permissions on the field "Calibration interval", if fuel type is Electric or Petrol.

Definition of field write permissions

Maintaining valuelist items

The valuelist items are maintained in the group values. Here you can add, edit and delete valuelist items. The valuelist items are displayed in a table view with the attributes defined in the general settings section.

All defined items of type test cycle

info

Once the general settings and dynamic attributes are defined, you might want to hide those groups to focus only on the value list items. Therefore, unselect the nodes in the left tree view.

When adding or editing a valuelist item, the attributes defined in the dynamic attributes section are displayed in a form view.

Editing a complex value list