kpi manager ug - ekhosoft

Document ID: E2-015-UGRevision: 2.0Release Date: 2016-07-22

Copyright Ekhosoft 2016 Canada. All rights reserved 7005 Taschereau, suite 350 | Brossard (QC) J4Z 1A7 tel +1.450.462.8105 fax +1.450.462.8205 WWW.EKHOSOFT.COM

KPI ManagerUser Guide

Table of ContentsTable of Contents

Chapter 1. Overview ..........................................................................1-1KPI Manager Introduction ..................................................................................... 1-1

Accessing the KPI Manager.................................................................................. 1-1

Search Tool........................................................................................................... 1-1

Missing Link Function............................................................................................ 1-2

Chapter 2. Historian Extraction Group Tab.....................................2-1Introduction ........................................................................................................... 2-1

Basic Settings ....................................................................................................... 2-1

Tags ...................................................................................................................... 2-1

Historian Extraction Group Actions ....................................................................... 2-2

Chapter 3. Event Extraction Group Tab ..........................................3-1Introduction ........................................................................................................... 3-1

Basic Settings ....................................................................................................... 3-1

Tag Settings .......................................................................................................... 3-2

Event Extraction Group Actions ............................................................................ 3-5

Chapter 4. Marker Extraction Group Tab ........................................4-1Introduction ........................................................................................................... 4-1

Basic Settings ....................................................................................................... 4-1

Marker Configuration............................................................................................. 4-1

Marker Extraction Group Actions .......................................................................... 4-3

Chapter 5. Formula Group Tab.........................................................5-1Introduction ........................................................................................................... 5-1

Basic Settings ....................................................................................................... 5-1

Formulas ............................................................................................................... 5-1

Formula Group Actions ......................................................................................... 5-3

Chapter 6. Roll Up Group Tab ..........................................................6-1Introduction ........................................................................................................... 6-1

Basic Settings ....................................................................................................... 6-1

Asset and Tags Panels ......................................................................................... 6-2

Roll Up Group Actions........................................................................................... 6-3

Chapter 7. Custom Group Tab .........................................................7-1Introduction ........................................................................................................... 7-1

Basic Settings ....................................................................................................... 7-1

i

Table of Contents

Custom KPI Definitions ......................................................................................... 7-1

Custom Group Actions .......................................................................................... 7-3

Chapter 8. Job Tab ............................................................................8-1Introduction ........................................................................................................... 8-1

Basic Settings ....................................................................................................... 8-1

Groups and Job Step ............................................................................................ 8-1

Job Actions............................................................................................................ 8-2

Chapter 9. Template Tab...................................................................9-1Introduction ........................................................................................................... 9-1

Basic Settings ....................................................................................................... 9-1

Configuration Tab.................................................................................................. 9-2

Auto Reprocess Tab ............................................................................................. 9-2

Template Actions .................................................................................................. 9-3

ii

Chapter 1. OverviewKPI Manager Introduction
The Key Performance Indicator (KPI) Manager is used to create configurations in order to calculate KPIs. These configurations can then be extracted and displayed in the KPI Browser. Please consult the KPI Browser User Guide for more information.

Accessing the KPI Manager

Accessing the KPI Manager:

1. Open the Tree View menu from within the user’s Ekhosoft website.

2. In the search box enter KPI Manager.

3. Select the entry KPI Manager System Management\KPI Manager.

Search Tool

The search tool allows the user to quickly visualize and access the KPI configurations that are associated with each tag.

Using the search function:

1. Type a key word into the search field. The tag list will be narrowed down to tags that contain that keyword. (See Figure 1-3)

2. Select a tag. All groups that use that specific tag will appear in the Results panel, sorted by group type.

Figure 1-1. KPI Manager Overview

Group Tab Job Tab Save IconSearch Tool Template Tab

Figure 1-2. Accessing the KPI Manager

Continued on next page

1-1

Chapter 1. Overview

Continued> Search Tool

3. To access a KPI group, click on the Go To icon at the end of the row.

4. The group configuration page will open.

Missing Link Function

It is important that all the definition items used in a KPI are configured and linked. Please consult the Definition Items User Guide for more information. There is a quick access within the KPI Manager to manage any missing links.

Linking definition items by using the missing link function:

1. Click on the Link icon to visualize any items specified in your group configuration that are not linked properly. The Missing Links window will open.

2. Select the checkbox of the items that need to be linked (the Check All/Clear All option can be used).

3. Click on the Save icon at the bottom of the window to save the changes.

4. The items are now linked.

Figure 1-3. Search Tool

Search Field

Figure 1-4. Missing Links Function

Missing LinkButton

1-2

Chapter 2. Historian Extraction Group TabIntroduction
Topics:

Basic Settings

The historian extraction group is defined by the information listed in Table 2-1. These fields must be completed when creating a new historian extraction group.

Tags

Once the basic settings are configured, tags related to the selection will become visible in the Tags panel.

IMPORTANT: The historian tags must be previously linked to a tag, server, event type(s) and asset(s) using the Advanced Configuration option in the Tag tab of the Definition and Configuration application. See the Definition Items User Guide for more information.

Adding tags to the historian extraction group:

1. Select the checkboxes to include the tags in the historian extraction group.

2. Additional information and configurations are available in the following columns:

• Selected: Checkbox that includes the tag in the historian extraction group.

• Image: Icon that indicates the type of information in the row.

• Tag: Displays the Ekho tag name.

The Historian Extraction Group tab allows the user to configure the historian data extraction used in the KPI calculations.

Historian extraction groups are configured from the KPI Manager page found in the System Management directory of the user’s Ekhosoft website.

Figure 2-1. Historian Extraction Tab

Basic Settings......................................2-1 Historian Extraction Group Actions......2-2

Tags.....................................................2-1

Table 2-1. Historian Extraction Basic Settings

Information Description

Name A unique name that is used to identify the historian extraction group. Once attributed to a historian extraction group, this name cannot be re-used for the same type of KPI group.

Description A brief optional description of the historian extraction group.

Destination Event Type

The selected event type will be assigned as the destination event type.

Asset The selected asset(s) or asset type(s) will be assigned as the destination asset(s).

Filter Adds optional metrics that are used to filter the historian tags.

2-1


Chapter 2. Historian Extraction Group Continued> Tags

• Aggregate: Contains all the aggregate options that can be applied to the extraction.

• Offset: The value defined as the offset is added to the destination tag value.

• Multiplier: The value defined as the multiplier multiplies the destination tag value.

• Offset Order: Determines if the offset is applied after or before the multiplier.

• Time Offset: Adds a defined time buffer before and/or after the event that will be included in the event.

• Tag Information: Click on the Tag Information icon to open the Tag Information window.

3. Click on the Save icon at the top of the window to save the changes.

Historian Extraction Group Actions

Creating a new historian extraction group:

1. Click on the Historian tab. A drop-down menu will open.

2. Click on the Create Historian Extraction item.

3. Fill out the information fields in the Basic Settings and Tags panels as explained in the previous section.

4. Click on the Save icon at the top of the window to save the new historian extraction group.

Figure 2-2. Adding Tags to the Historian Extraction Group

Missing LinkButton

Figure 2-3. Creating a New Historian Extraction Group


2-2

Chapter 2. Historian Extraction Group Continued> Historian Extraction Group Actions

Copying a historian extraction group:


2. Place the cursor on the item. A New From... icon will appear at the end of the line.

3. Click on the New From... icon to create a copy of the historian extraction group. A new historian extraction group will be created.

4. The Basic Settings panel will be filled with the same information as the original historian extraction group, to the exception of the Name and Description fields that will need to be entered.

5. Click on the Save icon at the top of the window to save the new historian extraction group.

Editing a historian extraction group:


2. Select the item that requires editing from the list.

3. Edit the information fields as required. Consult the previous section on the Basic Settings and Tags panels for explanations on the information fields.


Figure 2-4. Copying an Historian Extraction Group

Figure 2-5. Editing an Historian Extraction Group


2-3

Chapter 2. Historian Extraction Group

Continued> Historian Extraction Group Actions

Deleting a historian extraction group:


2. Place the cursor on the item. A red X icon will appear at the end of the line.

3. Click on the red X icon to delete the historian extraction group.

4. Click on the OK button in the prompt window to confirm the delete command.

Note: A historian extraction group can only be deleted if it is not used in any job.

Figure 2-6. Deleting an Historian Extraction Group

2-4

Chapter 3. Event Extraction Group TabIntroduction
Topics:

Basic Settings

The event extraction group is defined by the information listed in Table 3-1. These fields must be completed when creating a new event extraction group.

Using the filter:

1. Click on the Filter icon in the Basic Settings panel. The filter window opens.

2. In the Metrics panel, select the metric that will be used in the filter.

3. Drag and drop the metric in the Filter panel or use the arrow Add Filter icon to add the metric to the filter.

4. Then, in the Filter panel, click in the Value Type cell. An ellipsis <...> button will appear.

5. Click on the ellipsis <...> button.

6. Select the value type from the drop down list.

7. Click in the cell next to Value Type. An ellipsis <...> button will appear.

The Event Extraction Group tab allows the user to configure the event data extraction used in the KPI calculations.

Event extraction groups are configured from the KPI Manager page found in the System Management directory of the user’s Ekhosoft website. Figure 3-1. Event

Extraction Tab

Basic Settings......................................3-1 Event Extraction Group Actions...........3-5

Tag Settings.........................................3-2

Table 3-1. Event Extraction Basic Settings Definition


Name A unique name that is used to identify the event extraction group. Once attributed to an event extraction group, this name cannot be re-used for the same type of KPI group.

Description A brief optional description of the event extraction group.

Source Event Type The selected event type will be assigned as the source event type.

Source Asset The selected asset(s) or asset type(s) will be assigned as the source asset(s).

Filter Adds optional metrics that are used to filter the event type data extraction.

Destination Event Type

The selected event type will be assigned as the destination event type.

Destination Asset The selected asset(s) will be assigned as the destination asset(s).


3-1

Chapter 3. Event Extraction Group TabContinued> Basic Settings

8. Click on the ellipsis <...> button.

9. Select an equation symbol from the drop down list.

10. Click on the value cell. An ellipsis <...> button will appear.

11. Click on the ellipsis <...> button and type a value.

12. Click on the apply icon at the bottom of the window.

Note: Metrics can be combined using the “(“, “)”, “And”, “OR” operators. When there are multiple metrics, they can be sorted by using the position arrows on the right side of the window.

Tag Settings

The tag panel is used to add, edit or delete the tag settings within the event extraction group.

Figure 3-2. Using the Filter

Position Arrows

Add/Remove Filter

Table 3-2. Tag Settings Definition


Source The selected tag will be assigned as the source tag.

Destination The selected tag will be assigned as the destination tag.


3-2

Chapter 3. Event Extraction Group TabContinued> Tag Settings

Adding a new tag setting:

1. Click on the Add icon on the top right corner of the Tag panel. The Tag Settings window will open.

2. In the Tag Settings window, fill the information fields as explained in Table 3-2.

Aggregate This option allows the user to choose how the data will be presented in the destination tag.

• AVG: Average of the selected source tag values.

• COUNT: Number of occurrences of the source tag.

• MAX: Maximum value of the source tag value.

• MIN: Minimum value of the source tag value.

• STDEV: Sample standard deviation of the source tag value.

• SUM: Adds the value of the source tag value.

• WAVG: Average of the selected source tag values, weighted with an additional tag value. (The option of a second tag source is grayed out for all other functions except WAVG.)

Offset The value defined as the offset will be added to the destination tag value.

Multiplier The value defined as the multiplier will multiply the destination tag value.

Offset Order This field determines if the offset will be applied after or before the multiplier.

Rule This field determines which events will be considered in the KPI.

• End time included: Includes events that end within the selected period.

• Event Genealogy: Includes all events in the genealogy of the source event type.

• Start and End Time included: Includes events whose duration is contained between the selected event’s start and end time.

• Start or End time in the period or overlap: Includes all the events whose duration overlaps with the selected event’s start time or end time.

• Start or End Time included: Includes events that begin or end within the selected period.

• Start time included: Includes events that start within the selected period.

• Weighted by Overlapping duration of the source events VS dest.: Proportionally distributes tag value per time period when the events overlap.

Table 3-2. Tag Settings Definition (Continued)



3-3

Chapter 3. Event Extraction Group Tab

Continued> Tag Settings

3. Click on the OK icon at the bottom of the window.

Editing a tag setting:

1. Select the row that contains the tag setting that needs to be modified.

2. Click on the Edit icon on the top right corner of the Tag panel. The Tag Settings window will open.

3. In the Tag Settings window, modify the information fields as explained previously in Table 3-2.

4. Click on the OK icon at the bottom of the window to save the changes.

Deleting a tag setting:

1. Select the row that contains the tag setting that needs to be deleted.

2. Click on the Delete icon on the top right corner of the Tag panel.


Note: The delete command will be executed immediately, no prompt window will appear to confirm the command.

Figure 3-3. Adding a Tag Setting

Missing LinkButton

3-4


Event Extraction Group Actions

Creating a new event extraction group:

1. Click on the Event tab. A drop-down menu will open.

2. Click on the Create Event Extraction item.

3. Fill out the information fields in the Basic Settings and Tag panels as explained in the previous section.

4. Click on the Save icon at the top of the window to save the new event extraction group.

Copying an event extraction group:



3. Click on the New From... icon to create a copy of the event extraction group. A new event extraction group will be created.

4. The Basic Settings panel will be filled with the same information as the original event extraction group, to the exception of the Name and Description fields that will need to be entered.

5. Click on the Save icon at the top of the window to save the new event extraction group.

Figure 3-4. Creating a New Event Extraction Group

Figure 3-5. Copying an Event Extraction Group

3-5



Continued> Event Extraction Group Actions

Editing an event extraction group:



3. Edit the information fields as required. Consult the previous section on the Basic Settings and Tag panels for explanations on the information fields.


Deleting an event extraction group:



3. Click on the red X icon to delete the event extraction group.


Note: An event extraction group can only be deleted if it is not used in any job.

Figure 3-6. Editing an Event Extraction Group

Figure 3-7. Deleting an Event Extraction Group

3-6

Chapter 4. Marker Extraction Group TabIntroduction
Topics:

Basic Settings

The marker extraction group is defined by the information listed in Table 4-1. These fields must be completed when creating a new marker extraction group.

Marker Configuration

Configuring a marker:

1. In the Marker panel, select the marker’s checkboxes.

2. In the Tag Source panel, select the tag’s checkboxes.

3. Optionally, add an offset and/or a multiplier to the tag by clicking in the cell and typing a value.

4. To access the option in the Tag Configuration column, click in the cell then click on the ellipsis <...> button that appears within the cell. The Tag Configuration window will appear.

5. Select the appropriate tag configuration:

• To use a historian tag, click on the Historian (Tags) tab and select a tag from the list.

• To use a custom procedure, click on the Custom Procedure tab and select a procedure from the list.

The Marker Extraction Group tab allows the user to configure the marker data extraction used in the KPI calculations.

Marker extraction groups are configured from the KPI Manager page found in the System Management directory of the user’s Ekhosoft website.

Figure 4-1. Marker Extraction Tab

Basic Settings......................................4-1 Marker Extraction Group Actions.........4-3

Marker Configuration...........................4-1

Table 4-1. Marker Extraction Basic Settings


Name A unique name that is used to identify the marker extraction group. Once attributed to a marker extraction group, this name cannot be re-used for the same type of KPI group.

Description A brief optional description of the marker extraction group.

Event Type From The selected event type will be assigned as the source event type.

Event Type To The selected event type will be assigned as the destination event type.

Asset The selected asset(s) or asset type(s) will be assigned to the marker extraction group.


4-1

Chapter 4. Marker Extraction Group Continued> Marker Configuration

6. Click on the Apply icon at the bottom of the Tag Configuration window.

7. Automatically, newly created tags will appear in the Tag Destination panel.

IMPORTANT: Once created, the tags must be included in a tag group to be visible in the KPI Browser. Refer to the Definition Items user guide for more information.

8. Click on the Save icon at the top of the window to save the configuration.

Modifying a destination tag name:

1. In the Tag Destination panel, click in a Tag Destination Name cell.

2. Type directly in the cell to modify the name.


IMPORTANT: Modifying the name of an existing tag will create a new tag.

Modifying a mask definition:

1. In the Mask section at the bottom of the screen, click on the Modify button (see Figure 4-2). The Mask Definition window will appear.

2. Select items from the Wildcard panel and use the Add arrow icon (or drag them directly into the Mask panel) to add items to the tag destination name.

Figure 4-2. Configuring Markers

Figure 4-3. Modifying Destination Tag Name

Newly Created Tags


4-2

Chapter 4. Marker Extraction Group Continued> Marker Configuration

Note: A maximum of 4 wildcard items can be used in the Mask panel.

3. The mask can also be edited manually by clicking and typing directly in the cell.


IMPORTANT: Modifying the mask when there are existing tags will create new tags.

Marker Extraction Group Actions

Creating a new marker extraction group:

1. Click on the Marker tab. A drop-down menu will open.

2. Click on the Create Marker item.

3. Fill out the information fields in the Basic Settings, Marker and Tag Source panels as explained in the previous section.

4. Click on the Save icon at the top of the window to save the new marker extraction group.

Copying a marker extraction group:



3. Click on the New From... icon to create a copy of the marker extraction group. A new marker extraction group will be created.

4. The Basic Settings panel will be filled with the same information as the original marker extraction group, to the exception of the Name and Description fields that will need to be entered.

Figure 4-4. Modifying Mask Definition

Figure 4-5. Creating a New Marker Extraction Group


4-3

Chapter 4. Marker Extraction Group

Continued> Marker Extraction Group Actions

5. Click on the Save icon at the top of the window to save the new marker extraction group.

Editing a marker extraction group:



3. Edit the information fields as required. Consult the previous section on the Basic Settings, Marker and Tag Source panels for explanations on the information fields.


Deleting a marker extraction group:



3. Click on the red X icon to delete the marker extraction group.


Note: A marker extraction group can only be deleted if it is not used in any job.

Figure 4-6. Copying a Marker Extraction Group

Figure 4-7. Editing a Marker Extraction Group

Figure 4-8. Deleting a Marker Extraction Group

4-4

Chapter 5. Formula Group TabIntroduction
Topics:

Basic Settings

The formula group is defined by the information listed in Table 5-1. These fields must be completed when creating a new formula group.

Formulas

The Formulas panel is used to add, edit and delete formulas within the formula group.

Adding a new formula:

1. Click on the Add icon on the top right corner of the panel. The New Formula window will open.

The Formula Group tab allows the user to configure formulas used in KPI calculations.

Formula groups are configured from the KPI Manager page found in the System Management directory of the user’s Ekhosoft website. Figure 5-1. Formula

Group Tab

Basic Settings......................................5-1 Formula Group Actions........................5-3

Formulas .............................................5-1

Table 5-1. Formula Basic Settings


Name A unique name that is used to identify the formula group. Once attributed to a formula group, this name cannot be re-used for the same type of KPI group.

Description A brief optional description of the formula group.

Default Value The specified value will be applied if a parameter of the formula does not contain data. The default value will then replace that parameter in the formula.

Event Type The selected event type will be assigned as the source and destination event type.

Asset The selected asset(s) or asset type(s) will be assigned as the source and destination asset(s).

Figure 5-2. Formulas Panel

Missing LinkButton

Position Arrows


5-1

Chapter 5. Formula Group Tab

Continued> Formulas

2. In the Destination panel, choose whether the result of the formula will be routed towards a tag or an alias.

• To use a tag, click on the Tag tab and use the drop-down menu to select a destination tag.

• To use an alias, click on the Alias tab and type a name for the alias. The alias is a virtual tag that holds the value in order to use it in another formula, its name must be unique.

3. To write a formula, the items listed in the Wildcard panel can be dragged and dropped into the Formula panel or added by using the Add arrow icon. It is also possible to type the formula directly into the Formula panel.

4. Optionally, a description of the formula can be entered in the Explain your Formula panel.

5. Click on the Save icon at the bottom of the window to save the new formula.

Note: The position arrows can be used to determine the order in which the formulas will be executed.

Editing a formula:

1. Select the row that contains the formula that needs to be modified.

2. Click on the Edit icon at the top right corner of the Formula panel. The Edit Formula window will open.

3. Edit all required information.


Deleting a formula:

1. Select the row that contains the formula that needs to be deleted.

2. Click on the Delete icon at the top right corner of the Formula panel. A prompt window will open.

3. Click on the OK icon in the prompt window to confirm the delete command.

Figure 5-3. Adding a Formula

5-2


Formula Group Actions

Creating a new formula group:

1. Click on the Formula tab. A drop-down menu will open.

2. Click on the Create Formula Group item.

3. Fill out the information fields in the Basic Settings and Formulas panels as explained in the previous section.

4. Click on the Save icon at the top of the window to save the new formula group.

Copying a formula group:



3. Click on the New From... icon to create a copy of the formula group. A new formula group will be created.

4. The Basic Settings panel will be filled with the same information as the original formula group, to the exception of the Name and Description fields that will need to be entered.

5. Click on the Save icon at the top of the window to save the new formula group.

Figure 5-4. Creating a New Formula Group

Figure 5-5. Copying a Formula Group

5-3



Continued> Formula Group Actions

Editing a formula group:



3. Edit the information fields as required. Consult the previous section on the Basic Settings and Formulas panels for explanations on the information fields.


Deleting a formula group:



3. Click on the red X icon to delete the formula group.


Note: A formula group can only be deleted if it is not used in any job.

Figure 5-6. Editing a Formula Group

Figure 5-7. Deleting a Formula Group

5-4

Chapter 6. Roll Up Group TabIntroduction
Topics:

Basic Settings

The roll up group is defined by the information listed in Table 6-1. These fields must be completed when creating a new roll up group.

The Roll Up Group tab allows the user to configure the roll ups used in the KPI calculations. A roll up constitutes the aggregation of KPI values from one level to another in the asset hierarchy or over a time period.

Roll up groups are configured from the KPI Manager page found in the System Management directory of the user’s Ekhosoft website.

Figure 6-1. Roll Up Group Tab

Basic Settings......................................6-1 Roll Up Group Actions .........................6-3

Asset and Tags Panels........................6-2

Table 6-1. Roll Up Basic Settings


Name A unique name that is used to identify the roll up group. Once attributed to a roll up group, this name cannot be re-used for the same type of KPI group.

Description A brief optional description of the roll up group.

Roll Up Mode • Time: Allows the user to perform the roll up based on a time period for each of the selected assets or asset types.

• Asset: Allows the user to perform the roll up based on the asset’s hierarchy for the selected KPI types.

• Both: Allows the user to perform the roll up based on a time period and on the asset’s hierarchy.

Aggregate This option allows the user to choose how the data will be presented in the destination tag.

• AVG: Average of the selected source tag value.

• MAX: Maximum value of the source tag value.

• MIN: Minimum value of the source tag value.

• SUM: Adds the value of the source tag value.

• WAVG: Average of the selected source tag value, weighted with an additional tag value. (The option of a second tag source is grayed out for all other functions except WAVG.)

Event Type From The selected event type will be assigned as the source event type. (Available only with the Time and Both roll up modes.)

Event Type To The selected event type will be assigned as the destination event type. (Available only with the Time and Both roll up modes.)


6-1

Chapter 6. Roll Up Group Tab

Continued> Basic Settings

Asset and Tags Panels

Once a source event is selected in the Basic Settings panel, all related tags will appear in the Tags panel.

Roll up configuration:

1. In the Asset panel, if the selected roll up mode is Asset or Both, select the source and destination assets or asset types. A custom genealogy can also be used. If the selected roll up mode is Time, select assets or asset type(s).

Note: The search tool is most effective when using a unique keyword.

2. In the Tags panel, select the checkbox of a single or multiple tags to be added to the roll up.


Event Type Allows the user to select multiple destination event types (Available only with the Asset roll up mode.)

Table 6-1. Roll Up Basic Settings (Continued)


Figure 6-2. Roll Up Configuration

Missing LinkButton

6-2


Roll Up Group Actions

Creating a new roll up group:

1. Click on the Roll Up tab. A drop-down menu will open.

2. Click on the Create New Roll Up item.

3. Fill out the information fields in the Basic Settings, Asset and Tags panels as explained in the previous section.

4. Click on the Save icon at the top of the window to save the new roll up group.

Copying a roll up group:



3. Click on the New From... icon to create a copy of the roll up group. A new roll up group will be created.

4. The Basic Settings panel will be filled with the same information as the original roll up group, to the exception of the Name and Description fields that will need to be entered.

5. Click on the Save icon at the top of the window to save the new roll up group.

Figure 6-3. Creating a New Roll Up Group

Figure 6-4. Copying a Roll Up Group

6-3



Continued> Roll Up Group Actions

Editing a roll up group:



3. Edit the information fields as required. Consult the previous section on the Basic Settings, Asset and Tags panels for explanations on the information fields.


Deleting a roll up group:



3. Click on the red X icon to delete the roll up group.


Note: A roll up group can only be deleted if it is not used in any job.

Figure 6-5. Editing a Roll Up Group

Figure 6-6. Deleting a Roll Up Group

6-4

Chapter 7. Custom Group TabIntroduction
Topics:

Basic Settings

The custom group is defined by the information listed in Table 7-1. These fields must be completed when creating a new custom group.

Custom KPI Definitions

Adding a new custom KPI definition:

1. Click on the Add icon at the top right corner of the Custom KPI Definitions panel. The New Custom Creation window will appear.

2. In the Destination panel, select the destination.

• If the destination is a tag, open the Tag tab. From the Name drop-down menu, select a destination tag.

• If the destination is an alias, open the Alias tab. Type a name for the alias and select the type of information from the Type drop-down menu. The alias is a virtual tag that holds the value in order to use it in another custom definition.

• If there are no destination, open the None tab.

3. In the Tag Reference panel, select all tag(s) that will be used in the procedure by clicking the checkboxes.

The Custom Group tab allows the user to configure custom data extractions and formulas used in the KPI calculations.

Custom groups are configured from the KPI Manager page found in the System Management directory of the user’s Ekhosoft website. Figure 7-1. Custom

Group Tab

Basic Settings......................................7-1 Custom Group Actions ........................7-3

Custom KPI Definitions .......................7-1

Table 7-1. Custom Basic Settings


Name A unique name that is used to identify the custom group. Once attributed to a custom group, this name cannot be re-used for the same type of KPI group.

Description A brief optional description of the custom group.

Event Type The selected event type(s) will be assigned as the source and destination event type(s).

Asset The selected asset(s) or asset type(s) will be assigned as the source and destination asset(s).


7-1

Chapter 7. Custom Group Tab

Continued> Custom KPI Definitions

4. To write a custom procedure, the items listed in the Wildcard panel can be dragged and dropped in the Custom Procedure panel or added by using the Add arrow icon. It is also possible to type the custom procedure directly in the Custom Procedure panel.

5. Click on the Save icon at the bottom of the window to save the new procedure.

Note: The position arrows can be used to determine the order in which the procedures will be executed.

Editing a custom KPI definition:

1. Select the row that contains the definition that needs to be modified.

2. Click on the Edit icon at the top right corner of the Custom KPI Definitions panel. The New Custom Creation window will open.

3. In the New Custom Creation window, edit all required information.


Deleting a custom KPI definition:

1. Select the row that contains the definition that needs to be deleted.

2. Click on the Delete icon at the top right corner of the Custom KPI Definition panel. A prompt window will open.


Figure 7-2. Adding a New Custom Definition

Position Arrows

Missing LinkButton

7-2


Custom Group Actions

Creating a new custom group:

1. Click on the Custom tab. A drop-down menu will open.

2. Click on the Create New Custom item.

3. Fill out the information fields in the Basic Settings and Custom KPI Definitions panels as explained in the previous section.

4. Click on the Save icon at the top of the window to save the new custom group.

Copying a custom group:



3. Click on the New From... icon to create a copy of the custom group. A new custom group will be created.

4. The Basic Settings panel will be filled with the same information as the original custom group, to the exception of the Name and Description fields that will need to be entered.

5. Click on the Save icon at the top of the window to save the new custom group.

Figure 7-3. Creating a New Custom Group

Figure 7-4. Copying a Custom Group

7-3



Continued> Custom Group Actions

Editing a custom group:



3. Edit the information fields as required. Consult the previous section on the Basic Settings and Custom KPI Definitions panels for explanations on the information fields.


Deleting a custom group:



3. Click on the red X icon to delete the custom group.


Note: A custom group can only be deleted if it is not used in any job.

Figure 7-5. Editing a Custom Group

Figure 7-6. Deleting a Custom Group

7-4

Chapter 8. Job TabIntroduction
Topics:

Basic Settings

The job is defined by the information listed in Table 8-1. These fields must be completed when creating a new job.

Groups and Job Step

The Job Step panel is used to add and organize the groups that are part of the job. They can be sorted by ascending or descending order by clicking on the column header.

Adding group(s) to a job:

1. In the Groups panel, select a group.

Note: The yellow caution sign in front of the group’s name indicates that the group had yet to be included in a job.

The Job tab allows the user to select all required group(s) for a specific KPI job.

Jobs are configured from the KPI Manager page found in the System Management directory of the user’s Ekhosoft website. Figure 8-1. Job Tab

Basic Settings......................................8-1 Job Actions ..........................................8-2

Groups and Job Step ..........................8-1

Table 8-1. Job Basic Settings


Name A unique name that is used to identify the job. Once attributed to a job, this name cannot be re-used.

Description A brief optional description of the job.

Effective Determines if the job is effective or not.

Figure 8-2. Group and Job Step Panels

Add/RemoveArrows

Position Arrows


8-1

Chapter 8. Job TabContinued> Groups and Job Step

2. The group can be dragged and dropped in the Job Step panel or added by clicking on the Add arrow icon. The group will then appear in the Job Step panel (as shown in Figure 8-2).

3. In the group row, the following columns are available:

• Effective: Determines if the group is effective or not.

• Effective Date: Indicates the date the group has become effective (or will become effective). It can be edited directly in the cell.

• <Empty>: Icons representing the type of group.

• Name: Shows the name of the group.

• Go To: Icon that allows the user to go directly to the specific group configuration page.

4. Use the position arrows to determine the order of the steps.


Removing a group from a job:

1. In the Job Step panel, select a group.

2. Click on the Remove arrow icon.

3. Click on the Save icon at the top of the window to save the change.

Job Actions

Creating a new job:

1. Click on the Job tab. A drop-down menu will open.

2. Click on the Create Job item.

3. Fill out the information fields in the Basic Settings, Groups and Job Step panels as explained in the previous section.

4. Click on the Save icon at the top of the window to save the new job.

Figure 8-3. Creating a New Job


8-2

Chapter 8. Job TabContinued> Job Actions

Copying a job:



3. Click on the New From... icon to create a copy of the job. A new job will be created.

4. The Basic Settings panel will be filled with the same information as the original job, to the exception of the Name and Description fields that will need to be entered.

5. Click on the Save icon at the top of the window to save the new job.

Editing a job:



3. Edit the information fields as required. Consult the previous section on the Basic Settings, Groups and Job Step panels for explanations on the information fields.


Figure 8-4. Copying a Job

Figure 8-5. Editing a Job


8-3

Chapter 8. Job Tab

Continued> Job Actions

Deleting a job:



3. Click on the red X icon to delete the job.


Figure 8-6. Deleting a Job

8-4

Chapter 9. Template TabIntroduction
Topics:

Basic Settings

The template is defined by the information listed in Table 9-1. These fields must be completed when creating a new template.

The Template tab allows the user to combine single or multiple jobs to create a KPI template. The templates will then be executed using either the Data Reprocess application or the Process Library application.

Templates are configured from the KPI Manager page found in the System Management directory of the user’s Ekhosoft website.

Figure 9-1. Template Tab

Basic Settings......................................9-1 Auto Reprocess Tab ............................9-2

Configuration Tab ................................9-2 Template Actions .................................9-3

Table 9-1. Template Basic Settings


Name A unique name that is used to identify the template. Once attributed to a template, this name cannot be re-used.

Description A brief optional description of the template.

Reprocess to This option defines when the reprocessing of the KPI stops in relation to specified time period.

• Yesterday

• Last Hour

• Now

• End of Year

• Absolute (Reprocesses only the specified time period.)

9-1

Chapter 9. Template Tab

Configuration Tab

The Configuration tab is used to add, remove, and organize the historian tag(s) and job(s) that are part of the template.

Adding items to a template:

1. In the Items panel, select a job or a historian tag.

2. The item can be dragged and dropped in the Selected Items panel or added by clicking on the Add arrow icon. The item will then appear in the Selected Items panel (as shown in Figure 9-2).

3. Use the position arrows to determine the order of the items.


Removing items from a template:

1. In the Selected Items panel, select an item.

2. Click on the Remove arrow icon.

3. Click on the Save icon at the top of the window to save the change.

Auto Reprocess Tab

It is possible to set a trigger to auto reprocess the data when a specific type of event is added or modified. Simply select the events for which the template should be reprocessed from the list in the Event panel.

IMPORTANT: The Log History option must be enabled for the selected event types.

Figure 9-2. Configuration Tab

Add/RemoveArrows

Position Arrows

Figure 9-3. Auto Reprocess Tab

Select/Deselect All

9-2


Template Actions

Creating a new template:

1. Click on the Template tab. A drop-down menu will open.

2. Click on the Create Template item.

3. Fill out the information fields in the Basic Settings and Configuration panels as explained in the previous section.

4. Click on the Save icon at the top of the window to save the new template.

Copying a template:



3. Click on the New From... icon to create a copy of the template. A new template will be created.

4. The Basic Settings panel will be filled with the same information as the original template, to the exception of the Name and Description fields that will need to be entered.

5. Click on the Save icon at the top of the window to save the new template.

Figure 9-4. Creating a New Template

Figure 9-5. Copying a Template

9-3



Continued> Template Actions

Editing a template:



3. Edit the information fields as required. Consult the previous section on the Basic Settings and Configuration panels for explanations on the information fields.


Deleting a template:



3. Click on the red X icon to delete the template.


Figure 9-6. Editing a Template

Figure 9-7. Deleting a Template

9-4

E2-015-UG Copyright Ekhosoft 2016 Canada. All rights reserved.WWW.EKHOSOFT.COM

kpi manager ug - ekhosoft

Documents