Datacomponent settings

The data component is the most commonly used component for managing numerical data (values).

In the component’s settings, there are six tabs:

• General
• Fields
  
• Form
  
• Appearance
  
• Gauge
  
• Graph

General:

Under the “General” tab, you will find the basic settings for the data component:

• Name: Specify the title to be displayed at the top of the component in the overview view.
• Data Source: Select the data source to link to the component. All available data sources you have created will be listed here.
• Group Name: Use this to set a filter for the component.

-If two identical components exist in the same organization, they will display the same data.

-If one or both components have a unique group name, the data can be separated, allowing the fields to show different values despite sharing the same data source.

-To aggregate or mirror data from a component with a group name, the linked component must have the exact same group name.

• Organization: Here you can select which organization’s data will be displayed in the component.

This Organization: Displays only the data entered within the organization where the component is placed.

Mirrored: Displays data from another organization. You can select the organization via a drop-down menu. (When mirroring, you can also input data as if it were entered in the mirrored organization).

Aggregated: Displays data from multiple organizations. Select which organizations’ data to display from the list.

• Default Date: In the “Default Date from Today” field, you can adjust which date the data should be retrieved from.

Example: If you enter -3 and today’s date is May 20th, the component will display data from May 17th instead.

These settings make it easy to customize how and where data is retrieved, displayed, and shared between different organizations.

Fields

Here, the fields from the selected data source are displayed, and you can adjust their settings to customize how they are used:

• Display: Select or deselect which fields should be visible in the form or graph.
• Key: Displays the field’s unique key. This can only be changed in the data source settings.
• Display Name: Specify the name the field should have in the form or graph to make it more user-friendly.
• Group: The grouping function allows you to group fields for better organization.

-This is not the same as the group name under the “General” tab. These are entirely separate functions. To group fields, enter a group name in the box. Fields with the exact same group name belong to the same group.

-Grouping only affects how fields are displayed and is purely a visual feature.

-These settings make it easy to customize field visibility and structure, helping you create clear and functional forms or graphs.

The top three headings, “Display Name,” “Group,” and “Display,” correspond to the same settings available in the previous view.

• Read-Only: Makes the field read-only, meaning its value cannot be edited in a form.
• Goal: Displays the field’s values as a goal line in bar charts. When the field is marked as a goal, it is used as a reference for the setting “Color bars based on goal” under the “Graph” tab.
• Enable Annotations: Allows you to add colors and comments to values in a form. Double-click a field to open a menu where you can assign a color or write a comment (see image below).

• Hide in Summary: If this option is selected, the field will be hidden in the summary of a form.
• Aggregation Function: Determines how the field’s values are displayed when the component aggregates data from multiple organizations:

-Sum: Combines all values from the organizations.

-Average: Displays the average value across all organizations.

-Max: Displays the highest value.

-Min: Displays the lowest value.

This setting also affects how the field is displayed in graphs or speedometers when grouping data. In these cases, the aggregation is applied to data from multiple days or weeks instead of organizations.

• Number of decimals: Specify the number of decimal places to display in forms and graphs.
• Unit: Define the unit to be displayed for the field in forms and graphs.
• Default Value: Set an automatically pre-filled value for the field. (Note: This value is not aggregated and applies only to the current component.)
• Color in Graph: Choose the color the field will have in a graph.

• Add Virtual Field: A virtual field is a calculation based on one or more other fields and therefore cannot be aggregated or mirrored. It is also not possible to input a value directly into a virtual field.

For the settings that also apply to a regular field, the same rules and information apply.

• Formula: Enter the formula that will define the value of the virtual field. The rules for the formula are displayed below the field. You can also click the link in the information text for additional documentation.

Form

The form is used to input values for a field, and the menu contains the settings for the form in the data component.

• Display Form: The form will be displayed in the component if this option is selected.
• Hide Form at startup: The form will remain hidden until you actively choose to display it.
• Form Display Mode: If the data component aggregates data from multiple organizations, you can choose whether values should be displayed per organization or summed according to the aggregation function specified in the field settings.
• Striped Form: Alternating rows in the form are given different colors for better readability.
• Allow word wrap for field Names: Long field names are split across multiple lines to improve readability.
• Display names for grouped fields: Field names are also displayed for fields that belong to the same group.
• Display comments field: A comments field is added at the bottom of the form.

Appearance

Here, you can choose whether to display the component header, which includes the component’s name and date navigation. If you choose to hide it, the header will only appear when the user hovers over the top part of the component.

Gauge

The gauge is, alongside the form, one of two ways to visualize data in the data component.

• Display gauge: Select this option to display the gauge in the data component.
• Aggregate values for the gauge by: Choose whether to aggregate data for a week, month, year, etc. The aggregation is performed based on the “Aggregation Function” specified for each field in their settings.
• Scale: Min/Max Value: Specify the range for the speedometer, i.e., the lowest and highest values.
• From, To, Color: Define the value intervals for each color in the speedometer. Click on a color to change it, and add more color intervals if needed.
• Display number scale: Displays a numerical scale on the speedometer.
• Display Value: Displays the current value of the speedometer in the center of the gauge.
• Decimal Places: Specify the number of decimal places to display in the speedometer.
• Number of decimals Unit: Specify the unit to be displayed in the gauge.

Graph

The graph is the second way to visualize data in the data component.