Define an indicator type
- In the left navigation panel, expand Configuration and click Evaluation Types.
- In the explorer, click the evaluation type for which you want to define an indicator.
- Click the heading of the Indicator Types view to open it.
- Click New > Create New Indicator Type and define the indicator type. Select one of the following configurations for the indicator:
-
This configuration is for object-based indicators only. The users will define the indicator values for this type of indicators in data workbenches or evaluation views.
- Define the following in the Basic Data step of the indicator definition wizard:
- Name: Enter a name that is easy for users to understand. The name will be displayed in the Evaluation view and in data workbenches.
- Description: Add a description to inform other users about the purpose of the indicator type. The description is displayed as a tooltip in the Evaluation view.
- Range: Define a range if the user shall select the values in a drop-down list. A text field to enter the indicator value is available for indicators without a range definition. Enter the valid values for the range:
- Each value must be on a separate line.
- Each value must be defined as a numeric value or as a combination of numeric value and semantic value in the format:
<NumericValue> - <SemanticValue>
Ensure that an empty space exists before and after the dash.
- Only non-negative integers (greater than or equal to zero) may be specified.
- The text you enter for each range value in the Range field may not exceed 128 characters.
It is highly recommended that you do NOT change your specification of the Range attribute once users have already defined indicator values for objects in Alfabet. If you decide that the Range attribute must be changed, the existing indicators must be migrated to align with the new values defined for the Range attribute. Contact Software GmbH Support about the script required for such a migration.
- Default Value: Enter a default value. Users can set the indicator to the default value via the Set Undefined Values to Default option in the Evaluations view.
- Hide Numbers: Set a checkmark if the numeric values defined in the Range field should not be displayed in evaluation views and data workbenches. If a checkmark is set, only the semantic values defined in the Range field will be displayed. Generation: The value must be 0.
- Is Global: Leave this field unchecked.
- Add to Content Repository: Set a checkmark to add the indicator to the content repository. This allows a user to display the indicator in a content area for an object based on the object class that the indicator is configured for. You must select Widget or IconAndWidget in the Visualization Type attribute. Be sure to specify the relevant fields in the Widget tab.
The complete methodology for adding indicator cards to the content repository is described in the section Configure cards to display indicators in content areas.
- Short Name: Enter a short name with up to 5 characters for the indicator type. The short name is displayed in small labels in graphic visualizations.
- Technical Name: Enter a unique technical name with no whitespaces or special characters.
- Visualization Type Select one of the following in the Visualization Type field:
- Value: The indicator is displayed as text.
- Grouped Cards: The indicator is displayed as an icon from an icon gallery and the indicator will be available in a grouped card if the evaluation type has been added to the content repository. Configure cards to display indicators in content areas.
- Single Item Cards: This is only relevant if you selected the Add to Content Repository checkbox. Select a card in the Widget Definition field. Configure cards to display indicators in content areas.
- Single and Grouped Item Cards: This is only relevant if you selected the Add to Content Repository checkbox and additionally the indicator shall be visible in a grouped card for the evaluation type. Select a card in the Widget Definition field and define an icon gallery in the Icon. Configure cards to display indicators in content areas
Icon tab: The settings are required if you have selected either Grouped Cards or Single and Grouped Item Cards as visualization type.
Select an icon gallery in the Icon Gallery field. In the table, enter a number for the minimum and maximum value that the icon represents in the Min. Value and Max. Value columns. You can leave either the Min. Value or Max. Value cells empty in order to include everything below or above a certain value. If there is overlap in the definition of the value ranges, then the first range that matches an indicator value will be used to determine the icon to display. In the Caption cell, enter a tooltip text that explains the numeric values.
- Widget tab: Define the card design for display of the indicator value in content areas. Click here for a description of the complete configuration for different types of cards.
- Leave the Computation Rules step undefined.
- Define the following in the Basic Data step of the indicator definition wizard:
-
This configuration is for object-based and global indicators. Predefined Alfabet indicators are re-calculated daily. If you define a new calculated indicator, you must define a schedule for re-calculation to ensure that the indicator values are up to data. For calculated object-based indicators, users can also manually trigger re-calculation from evaluation views. For global indicators, go to Configuration > Global Indicator Evaluation to manually re-calculate indicators.
- Define the following in the Basic Data step:
- Name: Enter a name that is easy for users to understand. The name will be displayed in the Evaluation view and in data workbenches.
- Description: Add a description to inform other users about the purpose of the indicator type. The description is displayed as a tooltip in the Evaluation view.
- Range: Remove the default values from the field.
- Default Value: Leave this field empty.
- Hide Numbers: Leave this field unchecked.
- Generation: This attribute defines the sequence of the computation of the indicators. Indicators specified with a lower integer number are computed prior to indicators with a higher integer value. If the computed indicator depends on the results of other computed indicators, change the number to a number higher than the number of the indicators that shall be computed first.
- Is Global: Set a checkmark if the indicator will display data combined from multiple objects of one or multiple object classes. Do not set a checkmark if the indicator targets a single object.
- Add to Content Repository: Set a checkmark to add the indicator to the content repository. This allows a user to display the indicator in a content area for an object based on the object class that the indicator is configured for. Global indicators can be added to content areas that are independent of a class (like the Home content area). Be sure to specify the relevant fields in the Visualization tab described below. You must select Widget or IconAndWidget in the Visualization Type attribute.
- Short Name: Enter a short name with up to 5 characters for the indicator type. The short name is displayed in small labels in graphic visualizations.
- Technical Name: Enter a unique technical name with no whitespaces or special characters.
- Visualization Type Select one of the following in the Visualization Type field:
- Value: The indicator is displayed as text.
- Grouped Cards: The indicator is displayed as an icon from an icon gallery and the indicator will be available in a grouped card if the evaluation type has been added to the content repository. Configure cards to display indicators in content areas.
- Single Item Cards: This is only relevant if you selected the Add to Content Repository checkbox. Select a card in the Widget Definition field. Configure cards to display indicators in content areas.
- Single and Grouped Item Cards: This is only relevant if you selected the Add to Content Repository checkbox and additionally the indicator shall be visible in a grouped card for the evaluation type. Select a card in the Widget Definition field and define an icon gallery in the Icon. Configure cards to display indicators in content areas
- Go to the Computation Rules step of the indicator definition wizard.
- Click New > Create New Computation Rule.
- Define how the indicator shall be calculated in computation rules. There are different methods for indicator calculation. Click here for a description about how to define different types of computation rules. You can define more than one computation rule to assign an object based indicator to multiple object classes. For each object, the computation rule that is specific for the relevant object class will be executed.
- Define the following in the Basic Data step: