Document ID: E2-016-UGRevision: 2Release Date: 2016-08-01
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 BrowserUser Guide
The Key Performance Indicator (KPI) Browser allows the user to extract and display KPI data from selected assets and tags.
Note: In order for the KPI Browser to function, the KPI event types must be configured in the KPI Manager. For information on configuring the KPI event types consult the KPI Manager User Guide.
Topics:
Tag/Asset Selection
To use the KPI Browser the user must select the tags and assets that the data will be extracted from.
Tags Option
This option allows you to extract the data from one asset’s multiple tags.
Note: Only tags that are placed in tag groups will be displayed in the Tags panel.
To select tags for an asset:
1. Click on the Tags tab. Checkboxes will appear beside the tags in the tag groups.
2. Go to the Asset panel and select an asset. The asset name will become highlighted and appear at the top of the page.
3. Go to the Tags panel.
4. Expand the tag group folder.
5. Select the checkboxes of the tags that will be used.
Continued on next page
Tag/Asset Selection................................1 Default Configuration Options ................6
Time Period Selection ............................4 Template Option .....................................7
Data Display Options..............................4 Export Option .........................................8
Figure 1. Asset and Tag Selection Tabs
1
KPI Browser
Continued> Tag/Asset Selection/ Tags Option
6. Click on the Refresh button to update the data displayed.
Assets Option
This option allows you to extract the data from multiple assets that share a common tag.
Note: Only tags that are placed in tag groups will be displayed in the Tags panel.
To select assets for a tag:
1. Click on the Assets tab. Checkboxes will appear beside the assets.
2. Go to the Tags panel and select a tag. The tag name will become highlighted and appear at the top of the page.
3. Go to the Assets panel.
4. Select the checkboxes of the assets that will be used.
5. Click on the Refresh button to update the data displayed.
Continued on next page
Figure 2. Tags Option
Name of the Selected Asset
Figure 3. Assets Option
Name of the Tag Selected
2
KPI Browser
Continued> Tag/Asset Selection
Both Option
This option allows you to base the KPI extraction on a selection of multiple assets and tags.
To select both the assets and the tags:
1. Click on the Both tab. Checkboxes will appear in front of all the assets as well as the tags.
2. Select the assets as explained in the Asset subsection.
3. Select the tags as explained in the Tags subsection.
4. Click on the Refresh button to update the data displayed.
Figure 4. Both Option
3
KPI Browser
Time Period Selection
Once the tags and assets have been established, the user must define a time period that will determine the data extraction.
To set the time period:
1. Select the period that will be covered. There are two selection formats: Quick and Specific. The time selection that appears is determined in the KPI Browser’s Configuration menu.
• Specific: Use the calendar tool to select a precise year, month, and day.
• Quick: Use the drop-down menus to select a year and a month.
2. From the KPI event drop-down menu select the type of KPI event that will be used for the extraction.
3. Click on the Refresh button once the time period has been selected.
Data Display Options
These options help determine how the extracted data will be displayed.
Chart
The chart option enables the user to view the data as a chart.
Note: The chart itself cannot be exported. Upon exporting the data only the grid will be exported.
To use the chart option:
1. Click on the Chart icon. A chart will appear in the area beneath the data display area.
Continued on next page
Figure 5. Specific Time Period Selection Options
Figure 6. Quick Time Period Selection Options
4
KPI Browser
Continued> Data Display Options/ Chart
2. Configure the chart by bringing the mouse into the chart area and clicking on the Settings icon.
3. Once in the Chart Configuration window, set the axis of the data and select the type of chart that will be displayed for each data series.
Note: A bulk edit option is also available.
4. Click on the OK button to confirm the settings or click on the Reset Default Settings button to return to the chart’s default settings.
Aggregate
Aggregate equations columns can be added to the data display.
Continued on next page
Figure 7. Chart Options
Figure 8. Aggregate Options
5
KPI Browser
Continued> Data Display Options/ Aggregate
To add an aggregate equation column:
1. Click on the Aggregate icon. A list of option will appear.
2. Select the checkboxes of the equations that will be added to the data.
3. Click on the Refresh button. The columns will appear in the data display area.
Rotate
Click on the Rotate icon to change the orientation of the data table.
Default Configuration Options
The options set in the Default Configuration window define what options are selected on the screen when the KPI browser is open.
Continued on next page
Figure 9. Rotate Option
Figure 10. Default Configuration
6
KPI Browser
Continued> Default Configuration Options
To set the default configuration:
1. Select the extraction mode.
2. Select whether the specification colors will be applied or not.
3. Select whether the Specific date options or the Quick date options will be displayed.
4. Select the default KPI event type that will be displayed.
5. Select a default time period.
6. Exit the window when the selection is complete. The default configuration will be applied the next time the KPI Browser is open.
Template Option
The template option is used to save a specific selection of assets and tags.
To create a template:
1. Click on the Template icon.
2. Click on the Create icon.
3. Enter a name for the template.
4. Enter a description for the template.
5. Select the Save as SnapShot box to save the date settings as well as the tag and asset selection.
6. Click on the Save icon.
Continued on next page
Figure 11. KPI Browser Template
7
KPI Browser
Continued> Template Option
To apply a template:
1. Click on the Template icon.
2. Click on a template from the list. The template will be applied.
Export Option
The extracted data can either be exported as an .XLSL file or a .PDF file.
To export the extracted data:
1. Click on the Export icon.
2. Select the file format in which the data will be exported. The Save As window will open.
3. Select the directory in which the file will be saved.
4. Click on the Save button.
Figure 12. KPI Browser Export Options
8
Copyright Ekhosoft 2016 Canada. All rights reserved .WWW.EKHOSOFT.COM
