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

Areas

Allows the user to select one or multiple filtering patterns, for the run-time component's measurements. If an entity is used in multiple filter patterns, the duplicates will be automatically removed, resulting in a unique collection of i4connected entities. The filtering patterns support the wildcard filtering mechanism, by using the “*” wildcard.

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

Devices

Allows the user to select one or multiple filtering patterns, for the run-time component's measurements. If an entity is used in multiple filter patterns, the duplicates will be automatically removed, resulting in a unique collection of i4connected entities. The filtering patterns support the wildcard filtering mechanism, by using the “*” wildcard.

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

KPI 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.

KPIs

Allows the user to select one or multiple filtering patterns, for the run-time component's measurements. If an entity is used in multiple filter patterns, the duplicates will be automatically removed, resulting in a unique collection of i4connected entities. The filtering patterns support the wildcard filtering mechanism, by using the “*” wildcard.

To add KPIs filter patterns, the user can click the Expand array list button.

KPIs.jpg

The view is updated to display the Add new item button. As soon as the Add new item button is clicked, the user can click on the Expand the list button, to view the list of KPIs, available for the current project.

Note

The list of entities is by default filtered to show all possible combinations. The "*" wildcard means "any".

wild_card.jpg
KPIs_list_view.jpg

The user can define filter patterns, as follows:

  • by manually selecting one or multiple KPIs, from the list view;

  • by inserting specific combinations of character patterns, using the "*" wildcard.

To preserve the selection, the Apply button needs to be clicked.

Local Signal 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

Organizational Units

Allows the user to select one or multiple filtering patterns, for the run-time component's measurements. If an entity is used in multiple filter patterns, the duplicates will be automatically removed, resulting in a unique collection of i4connected entities. The filtering patterns support the wildcard filtering mechanism, by using the “*” wildcard.

To add Organizational Units filter patterns, the user can click the Expand array list button.

OrgUnits.jpg

The view is updated to display the Add new item button. As soon as the Add new item button is clicked, the user can click on the Expand the list button, to view the list of Organizational Units, available for the current project.

Note

The list of entities is by default filtered to show all possible combinations. The "*" wildcard means "any".

wild_card.jpg
OrgUnits_list_view.jpg

The user can define filter patterns, as follows:

  • by manually selecting one or multiple Organizational Units, from the list view;

  • by inserting specific combinations of character patterns, using the "*" wildcard.

To preserve the selection, the Apply button needs to be clicked.

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

Sites

Allows the user to select one or multiple filtering patterns, for the run-time component's measurements. If an entity is used in multiple filter patterns, the duplicates will be automatically removed, resulting in a unique collection of i4connected entities. The filtering patterns support the wildcard filtering mechanism, by using the “*” wildcard.

To add Sites filter patterns, the user can click the Expand array list button.

Sites.jpg

The view is updated to display the Add new item button. As soon as the Add new item button is clicked, the user can click on the Expand the list button, to view the list of Sites, available for the current project.

Note

The list of entities is by default filtered to show all possible combinations. The "*" wildcard means "any".

wild_card.jpg
Sites_list_view.jpg

The user can define filter patterns, as follows:

  • by manually selecting one or multiple Sites, from the list view;

  • by inserting specific combinations of character patterns, using the "*" wildcard.

To preserve the selection, the Apply button needs to be clicked.

Time Range

Contains a set of time range configurations. By clicking the Expand array list button, a list of modular time range properties is exposed. Based on the selection made for the Date range property, the view is updated accordingly, as follows:

  • Date range Offset - allows the user to pick the current filter, on a specified date, using the design-time properties Start offset and End offset, by choosing the type (seconds, minutes, hours, days). Time frame is by default calculated and set.

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

    • Start offset - Allows the user to set the start offset interval.

    • End offset interval - Allows the user to set the end offset interval.

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

    Offset.jpg
  • Date range Specific - allows the user to pick the desired time interval, using the Start date / End date calendar selectors.

    • Start date - sets the start date of the component measurement.

    • End date - sets the end date of the component measurement.

    Specific.jpg
  • Date range Day - allows the user to select the desired Day as time range, from the calendar view.

    • Date - sets the date range, to a specific day.

    Day.jpg
  • Date range Week - allows the user to select the desired Week as time range, from the calendar view.

    • Date - sets the date range, to a specific week.

    week.jpg
  • Date range Month - allows the user to select the desired Month as time range, from the calendar view.

    • Date - sets the date range, to a specific month.

    Month.jpg
  • Date range Year - allows the user to select the desired Year as time range, from the calendar view.

    • Date - sets the date range, to a specific year.

    year.jpg
  • Date range:

    • Current day - allows the user to select the current day, as time range. Time frame of 24 hours is by default calculated and set.

      Current_day.jpg
    • Current week - allows the user to select the current week, as time range. Time frame of 7 days is by default calculated and set.

      Current_week.jpg
    • Current month - allows the user to select the current month, as time range. Time frame is by default calculated and set.

      Curent_month.jpg
    • Current year - allows the user to select the current year, as time range. Time frame is by default calculated and set.

      Current_time_range.jpg
  • Date range Last day / Last week / Last month / Last year

    • Last day - allows the user to select the day before the current one. Time frame of 24 hours is by default calculated and set.

      Last_day.jpg
    • Last week - allows te user to select the week before the current one. Time frame of 7 days is by default calculated and set.

      Las_week.jpg
    • Last month - allows the user to select the month before the current one. Time frame is by default calculated and set.

      Last_month.jpg
    • Last year - allows the user to select the year before the current one, as time range. Time frame is by default calculated and set.

      Past_date_range.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