i4designer Knowledgebase

Core

Abstract

Here are the i4designer Navigation components for your new project created on the i4SCADA, i4connected or OPC-UA platforms.

The components available in the Core category of the i4designer Toolbox panel are described, individually, in the upcoming articles.

Kpi
Abstract

Check out this article describing the core component, allowing i4designer users with possibility to takes the kpi's parameters over time and write local signals with the result.

The i4designer Kpi component is a core component, allows users with possibility to apply conventional patterns for KPI parameters, in order to write local signal values. Similar with the Utilties components, the Kpi component will not be visible at run-time.

KPI_component.jpg

The KPI component

Category

Property

Description

Configuration

Aggregate totals

If the toggle button is set to true all the measurements of the respective media and KPIs will be summed up.

Aggregate_totals.jpg

Auto update

Allows the user to specify whether the updating should happen automatically or not. When this option is enabled the chart pulls interval for data and updates it automatically. The Filter object property must be also filled, when enabling the Auto update property.

Auto_update.jpg

Conventional Pattern

Sets the proposed naming convention. The pattern can be changed, in order to build a new naming convention.

Note

Please keep in mind that the original values (placeholder names) inside the brackets, should be kept the same.

Conventional_patterns.jpg

Date range

Allows the user to set the date range span specifying when it starts and ends. The user can chose from the following drop-down options:

  • Specific (specific periods of time)

  • Offset (runs the current filter on a specified date in the past)

  • Current day

  • Current week

  • Current month

  • Current year

  • Last day

  • Last week

  • Last month

  • Last year

Date_range.jpg

Direction

Sets the chart label direction measured in pixels. The value can be increased or decreased using the up / down arrows or manually added.

Direction.jpg

End date

Sets the end date of the chart measurement. Available tokens are - YYYY, YY, Y, Q, MM, MMM, MMMM, D, DD. Further information are available in the "Year, month, and day tokens" chapter under https://momentjs.com/docs/#/parsing/string-format/.

End_date.jpg

Filter object

Allows the user to apply the i4connected chart parameters. When adding the Filter object, the Auto update property should be also enabled.

The Filter Object can be selected by clicking the Expand the list button.

Expand_the_list_Filter_object.jpg

The Entities area is expanded, listing all the Object Filters available for the current project.

Entities_area.jpg

For large lists of Object Filters, the Entities area is also equipped with a simple search functionality.

After selecting the desired Filter, the view in this area is updated, to display the user's selection.

Applied_filter.jpg

Note

The Entities list does not allow multi-selection of items.

KPI Data Properties

Allows the user with possibility to set properties, inside the analysis data mode, used to generate the local signasl, based on the predefined conventional patterns.

The view the list of KPI Data Properties, the user can click the Expand array list button.

Array_list_of_kpi_data_props.jpg

To add new KPI Data Properties, the user click the Add new item button.

add_kpi_data_props.jpg

By clicking the Expand the list button, a list of predefined KPI Data Properties is made visible. The list features the following options: key, aggregate, aggregateUnit, values, chartType, color, description, goals, icon, name, object, timestamps, type and unit.

Expand_list.jpg

After choosing the desired KPI Data Property, it will be listed here.

By clicking the Remove button, the KPI Data Property can be deleted from the list.

KPI Ids

Allows the user with possibility to add the one or multiple KPI id(s). The KPI identification can be selected by clicking the Expand array button.

Expand_array_KPIs.jpg

Next, an Add button is displayed. By clicking it, the view is expanded to display the "Empty item" area. By clicking the Expand the list button, the list of KPIs, synchronized from an i4connected environment, is displayed.

Select_KPI.jpg

After choosing the desired KPI, the user can either remove it, via the Delete button, or decide to ad another KPI, via the upper Add button.

Multiple_KPis.jpg

Resolution

Allows the user to select the resolution of the data rendered in the chart (the time interval between two consecutive measurements displayed on the time axis). The user can choose between five predefined resolutions (15 minutes, one hour, one day, one month and one year) or can set the option on Auto. When the Resolution is set to Auto, the system automatically adjusts the resolution based on the active Time range setting and the current zoom level.

Resolution.jpg

Start date

Sets the start date of the chart measurement. Available tokens are - YYYY, YY, Y, Q, MM, MMM, MMMM, D, DD. Further information are available in the "Year, month, and day tokens" chapter under https://momentjs.com/docs/#/parsing/string-format/.

Start_date.jpg

Alarms

End offset

Allows the user to specify the end length offset measured in seconds, minutes, days, weeks, months or years.

End_offset.jpg

End offset interval

Allows the user to set the end offset interval.

End_offset_interval.jpg

Start offset

Allows the user to specify the start length offset measured in seconds, minutes, days, weeks, months or years.

Start_offset.jpg

Start offset interval

Allows the user to set the start offset interval.

Start_offset_interval.jpg

Update rate

Allows the user to specify the update rate in milliseconds. This property will be taken into consideration only if the Alarms Mode is set to Online.

Update_rate.jpg

Transform

Angle

Sets the rotation angle using the up and down arrows to increase and decrease, or by manually typing the desired degree value.

The component angle can also be adjusted directly on the design surface by means of mouse manipulation.

Angle.jpg

Height

Sets the height of the component using the up and down arrows to increase and decrease, or by manually typing the desired pixels value.

The component height can also be adjusted directly on the design surface by means of mouse manipulation.

Control_height.jpg

Left

Specifies the X (horizontal) coordinate of the component, on the grid, using the up and down arrows to increase and decrease, or by manually typing the desired value.

The component X coordinate can also be adjusted directly on the design surface by means of mouse manipulation.

Left.jpg

Top

Specifies the Y (vertical) coordinate of the component, on the grid, using the up and down arrows to increase and decrease, or by manually typing the desired value.

The component Y coordinate can also be adjusted directly on the design surface by means of mouse manipulation.

Top.jpg

Width

Sets the width of the component using the up and down arrows to increase and decrease, or by manually typing the desired pixels value.

The component width can also be adjusted directly on the design surface by means of mouse manipulation.

Control_width.jpg