Reference values
Reference values are stable values that rarely change and are not modified by processes that use them. Reference values are organized in reference objects. Reference values can be structured in a hierarchy of superordinate and subordinate reference values.
A reference value can have different values at different points in time. The time series of the reference value determines which values are valid at which points in time.
Add reference values
Reference values are specified in a reference data model in the subpanel of a reference object.
A new reference value is added by clicking the tab "Reference values" and the icon "+" (or by selecting "Add Reference value..." in the menu).
It is mandatory to assign a code to the reference value. In addition, a short form and a long form can be specified. If a superordinate reference object is defined, a superordinate reference value can be selected from the superordinate reference object.
Selecting a superordinate reference value automatically classifies the reference value as a subordinate reference value.
If the reference object is hierarchically unique, multiple reference values can be added with the same code, as long as their superordinate reference values are different.
Clicking "Add" creates the reference value.
Reference values can also be created by duplicating other reference values.
Edit reference values
Quick edit
A reference value is edited in the subpanel of the reference object, by clicking the edit icon (or by selecting "Edit Reference value" in the menu) next to the reference value.
The quick edit mode allows the modification of the most frequently used input fields.
The icons in the lower left corner of the edit view allow further settings to be made:
- Clicking
marks the element as favorite. - Clicking
marks the element as locked. - Clicking
marks the element as read-only.
Clicking "Save" applies the changes.
A reference value can be deleted in the subpanel of the reference object, by selecting "Delete Reference value" in the menu next to the reference value.
In quick edit mode, the code, short form and long form of the final validity period of the time series is implicitly edited.
Detailed edit
A reference value is edited in the main panel of the reference value, by clicking the edit icon (or by selecting "Edit Reference value" in the menu).
The detailed edit mode allows the modification of all standard input fields. Additional, customer-specific fields can be added using annotations and will then also appear in the edit mode.
The icons in the lower left corner of the edit view allow further settings to be made:
- Clicking marks the element as favorite.
- Clicking marks the element as locked.
- Clicking marks the element as read-only.
Clicking "Save" applies the changes.
A reference value can be deleted in the main panel of the reference value, by selecting "Delete Reference value" in the menu.
In detailed editing mode, only the governance information of the reference value can be edited. The time series of the reference value, defining at which point in time which code, short form or long form is valid, is edited in the subpanel of the reference value.
Edit time series
The time series can be edited in the subpanel of the reference value, by clicking the tab "Time series" and the edit icon (or by selecting "Edit Time series" in the menu).
The list of validity periods specifies which values are valid at which points in time.
For each validity period, you can define which code, short form or long form is valid in that time period.
- A new validity period is added by clicking "Add".
- Clicking the delete icon deletes the validity period.
Clicking "Save" applies the changes.
Order reference values
The sorting of the reference values is determined by their order (if present). This order can be assigned manually during editing. Alternatively, in the subpanel of the reference object, it is possible to arrange the reference values and assign their order automatically.
Selecting "Order Reference values..." in the menu opens a dialog, where the reference values can be rearranged with the mouse using "drag and drop".
Clicking "Save" applies the changes and reassigns the order automatically.
If required, it is possible to specify that automatic ordering should start at a certain number.