visual kpi mobile user's guide

Visual KPI Mobile User's GuideUpdated for Build: 3.1.24.157
TABLE OF CONTENTS
Introducing Transpara Visual KPI ___________________________________________ 5
Architecture ....................................................................................................................... 6 New in Version 3.1 ............................................................................................................ 7 Visual KPI Components .................................................................................................... 9 Getting Started with Visual KPI ....................................................................................... 10
Using Mobile KPI ________________________________________________________ 11 Navigating in the Visual KPI Website .............................................................................. 11
Adding Visual KPI Pages to your Favorites ............................................................... 12 Portrait and Landscape Views ................................................................................... 12 Auto Adjust to Window Size ...................................................................................... 12
Links and Trends on the Visual KPI Website .................................................................. 13 Site Links & Trends Page .......................................................................................... 13
Using the Home Page ..................................................................................................... 13 Using the Scorecards Page ............................................................................................ 15 Using the KPI Page ......................................................................................................... 16 Using the Status Filter & Attribute Grouping Page .......................................................... 17 Using the KPI Map Page ................................................................................................. 18 Using the KPI Map Detail Page ....................................................................................... 22 Using the KPI Configuration Detail Page ........................................................................ 23 Using the Manual Entry Page ......................................................................................... 24
Entering KPI Values Using the Visual KPI Website .................................................. 25 Using the Scorecard Configuration Detail Page .............................................................. 25 Using the View Configuration Detail Page ...................................................................... 26 Using the System Configuration Detail Page .................................................................. 27 Using the Trend Page ..................................................................................................... 29
KPI Trend Types ....................................................................................................... 30 KPI Trend Scales ...................................................................................................... 32
Using the Ad Hoc Trend Page ........................................................................................ 33 Using Calculations in an Ad Hoc Trend ..................................................................... 33 Using an Ad Hoc Trend Offset .................................................................................. 34 Building an Ad Hoc Trend Page ................................................................................ 35
Using Interactive Trends ................................................................................................. 37 Viewing Values in a Trend ......................................................................................... 37 Comparing Values in a Trend .................................................................................... 38 Zooming In A Trend ................................................................................................... 41
Using Export to CSV ....................................................................................................... 42 Export To CSV Example Using Visual KPI Desktop Version .................................... 43 Export To CSV Example Using Visual KPI Mobile Version ....................................... 46
Using the Bar Charts Page ............................................................................................. 47 Using the Search Page ................................................................................................... 50 Using the Defined Ranges Page ..................................................................................... 51 Using the Custom Ranges Page ..................................................................................... 52
Table of Contents
iv Transpara Corporation
Introducing Transpara Visual KPI
Transpara’s Visual KPI is a revolutionary application that provides you with access to your real-time business key performance indicators right now, whether you are sitting at your desk or in the field. With Visual KPI, key operating measures are made available to stake-holders at every level of the corporation, delivering a configurable solution for implementing such initiatives as Balanced Scorecard, Six Sigma and Sarbanes-Oxley compliance.
Based on Microsoft SQL Server and ASP.NET 2.0, and leveraging such industry standard technologies as OSIsoft’s proven RtPM platform, this web-based application intelligently determines the screen size available to the requesting user and optimizes the interaction with Graphics, Scorecards, and Trends for the specific device. In addition, the system can be configured either online or offline through an intuitive Excel spreadsheet.
Visual KPI allows you to easily create and securely distribute real-time key performance indicators by simply configuring scorecards and KPIs in Microsoft Excel, or via the Web Editor. You can publish them for instant consumption by anyone in your organization or even on the Internet. By providing ready access to key performance information when and where needed, more informed and accurate decisions can be made, improving business performance and profitability.
A rc
hi te
ct ur
e A R C H I T E C T U R E Transpara’s Visual KPI is based on an architecture that separates the data capture from the way in which this data is organized or queried. This allows a company to change the fundamental way it consumes the data without affecting the data capture method. In fact, companies can add new analyses, or change existing analyses and then apply these analyses not only to new incoming data but all existing data as well.
Transpara’s approach is to keep the underlying source systems pristine and unaffected. Visual KPI lowers the “marginal cost of curiosity” by allowing new questions and data schemas to be applied to existing data without requiring the cube to be re-architected. The software constantly extracts new data from the online systems for a continuous stream of data from business operations.
N ew
in Version 3.1
N E W I N V E R S I O N 3 . 1 Version 3.1 includes many new features that enhance Visual KPI’s functionality and usability.
Links and Trends
Links allow you to pre-define URLs and display them as links on the Visual KPI website; the URLs can be simple or extremely complex. Trends allow you to pre-define Trends and display links to the Trends on the Visual KPI website. Links and Trends are configured in the same manner as other Visual KPI data.
Attribute Grouping Override
Views and Scorecards now allow you to override the Default Attribute Grouping defined in the Website Configuration. You can customize each View and Scorecard to use any of the supported attribute grouping options.
True Roll Up™ Override
The True Roll Up™ provides a graphical view of the statuses of the KPIs belonging to a View or Scorecard. By default, True Roll Up™ is enabled. However, you can configure your Visual KPI website to not use the True Roll Up™ view.
Multi-Scale Trends
Trends now support the use of multiple Y scales. While viewing a multi-scale trend, you can change the active Y Scale by select a pen in the trend’s legend.
Interactive Trends
Interactive trends allow you to see specific point values as you mouse over a trend line, zoom in on a trend, and compare a single value against others in the trend by locking that value and mousing over other values. You can configure your Visual KPI website to allow or disallow Interactive Trends.
Enhanced Organization of KPI Maps
You now have the ability to define how to organize KPIs in a KPI Map for individual Views and Scorecards.
Dynamically Define Responsible Party Information
Responsible party, mail, and phone now have an Interface assignment, allowing Visual KPI to dynamically determine the responsible party information. This can be useful when equipment has varying responsible parties based on things such as the day of week, or specific shifts.
Ad Hoc Trend Offset
Ad Hoc trends now support the use of an offset time range, allowing you to easily view the variations seen over time, such as seasonal variations.
Manual Data Trending
You can now define KPIs that support the manual input of values. The manually input values are saved in the Visual KPI database. You can also create trends based on these manual KPIs.
Support for Built-in KPI Functions
You can now define KPIs using built-in KPI functions that include the use of date, logical, lookup and text functions.
KPI Sparklines
You can now see your KPIs in a Sparkline graphic, which is a compact, detailed image of the KPI’s value over time.
Export to CSV
You can now export your KPI data from the Trend or Ad Hoc Trend pages to a CSV file. You can use the CSV file in Microsoft Excel to generate custom charts. Export to CSV on a handheld sends the data to a static screen that contains a table of raw data and timestamps, allowing you to scroll through the data in the table.
Ad Hoc Trends
You can now view your KPIs using Ad Hoc Trends. Ad Hoc Trends can be saved as a Favorite, for easy repeat usage.
Trend Legends
Now you can configure the Visual KPI web site to include a legend on the Trend page. If configured to show, a legend will also be displayed on the Ad Hoc Trend page.
Web Pages Automatically Adjust to Screen Size
Web pages now adjust automatically to fill up the available screen size. You no longer need to specify the size limitations, simply resize your browser and the Visual KPI web site adjusts to the new size.
Search For KPI Data
The Visual KPI web site now includes a search feature that allows you to search for Views, Scorecards and KPIs. The search results are displayed on a single page, organized by type.
Excel Editor Enhancements Membership pages now include orphaned KPIs and Scorecards. Any KPI that does not
belong to a Scorecard, or Scorecard that does not belong to a View, displays in the Membership list as “Orphaned.”
Visual KPI 3.1 Server
The Visual KPI Server Manager now includes a Status report for your Visual KPI Servers. The report can be saved as an HTML document, allowing you to easily forward the report to others in your organization.
The Visual KPI Server allows you to define a system Administrator who can be notified if the Visual KPI Cache Server experiences a non-standard event.
Added support for additional BlackBerry devices, such as the BlackBerry Storm and BlackBerry Bold.
Support for OSIsoft’s 64-bit PI-SDK.
The Visual KPI Server allows you to specify Regional Settings for each Visual KPI web site.
The ODBC interface supports multiple configurable parameters in GetCurrentDataQuery & GetTrendDataQuery.
Visual K PI C
om ponents
V I S U A L K P I C O M P O N E N T S Visual KPI consists of several components. The following is a brief overview of each of the Visual KPI components.
♦ Visual KPI Server The Visual KPI Server component consists of web pages and services that form a Service Oriented Architecture (SOA) used for accessing the KPI data from an external system. The Visual KPI Server allows you to retrieve real-time data from an external system through your configured Views, Scorecards and KPIs.
♦ Visual KPI Server Manager The Visual KPI Server Manager allows you to install the Visual KPI Server, manage your current installation, and migrate your Visual KPI 3.0 installations to Visual KPI 3.1. Using the Visual KPI Server Manager you can easily perform side-by-side deployments, allowing you to continue to use your live system while you test your new system.
♦ Visual KPI Website The Visual KPI Website presents varying levels of detail of your KPI data. The Visual KPI Website uses certificate-based authorization of inbound devices, ensuring access by only qualified, known users. Your users can access this data via the Internet using a standard browser, as well as any number of mobile devices such as PDAs, Smart Phones, Blackberry Phones, Tablet PCs, and SharePoint Web Parts.
♦ Visual KPI Database The Visual KPI Database is the storage location for the View, Scorecard, and KPI definitions. The Visual KPI Server retrieves the definition data from the Visual KPI Database, allowing the Visual KPI Server to determine the system and tag from which KPI data is retrieved.
♦ Visual KPI Alert Server The Visual KPI Alert Server notifies users via SMTP (e-mail) when certain events occur. When the Visual KPI Alert Server determines that a limit boundary has been crossed for a KPI, a message is sent to the e-mail address specified for the KPI. Alerting can be defined for each KPI; you need to define the Notification Type and e-mail address in the KPI.
♦ Visual KPI Cache Server The Visual KPI Cache Server caches data, as it is accessed, resulting in a significant increase in performance after it has run the first time. The Visual KPI Cache Server runs as a Windows service.
♦ Visual KPI Interfaces Interfaces allow Visual KPI to communicate with and gather data from external systems. There are a number of interfaces for use with Visual KPI – ODBC, SQL Server, SmartSignal and Excel Services (MOSS 2007 Server as data source).
♦ Visual KPI Excel Editor The Visual KPI Excel Editor is used to define your KPI data. Because the Visual KPI Excel Editor is in a familiar environment – Microsoft Excel – you can quickly and easily define your KPI data. The Excel Editor is a special spreadsheet that allows you to communicate with your Visual KPI Server, allowing you to retrieve, review and upload your Visual KPI definitions data.
♦ Visual KPI Web Editor The Visual KPI Web Editor is a browser-based editor you can use to define your KPI data.
PI
G E T T I N G S T A R T E D W I T H V I S U A L K P I The following is a brief overview of the steps required to start using Visual KPI.
♦ Install Visual KPI Ensure your system meets the minimum requirements. Once you’ve installed the Visual KPI Server, configure the error logging requirements on the server’s components.
♦ Configure Security, if Required Visual KPI supports all forms of standard security implementations used on an application server. This document provides instructions for implementing Active Directory security using multiple Visual KPI web sites.
♦ Install and Configure Visual KPI Interfaces The Visual KPI Interfaces are used to allow the Visual KPI Server to communicate with the external system that contains your KPI data. These interfaces can be easily installed using the Visual KPI Server Manager.
♦ Configure Visual KPI Alert Server If you want to use alerting, you will need to configure the Visual KPI Alert Server to work with your Visual KPI Server.
♦ Define Visual KPI Configuration Data You need to define your Interfaces to specify the external systems from which your real-time data will be retrieved. You can configure Trend Ranges, including the Default Range. You can also specify your own custom logo and alternate text for the logo in the Logo Properties.
♦ Define your KPI Data The Visual KPI Editors are used to define your Views, Scorecards and KPIs. Views and Scorecards allow you to organize your KPI data in a manner that makes sense for your organization. You can configure multiple Scorecards, each of which can include one or more KPIs. A KPI references multiple tags or database values that define the KPI’s target value, range specifications and status.
♦ View Your Data using the KPI Website The Visual KPI website is made up of several web pages that present varying levels of detail of your KPI data. You can access this data via the Internet, or any number of mobile devices.
2
Using Mobile KPI
The Visual KPI Website allows you to track your composite KPIs, from any where, as long as you have Internet access. The website is accessible and viewable via many mobile devices, as well as the standard desktop machine. Below is a list of devices that can access the Visual KPI Website:
♦ Desktop or laptop running Microsoft Internet Explorer
♦ Smart phone running Windows Mobile 2003 2nd Edition, and higher
♦ Pocket PC running Windows Mobile 2003 2nd Edition, and higher
♦ Play Station Portable
♦ SharePoint Web Parts
N A V I G A T I N G I N T H E V I S U A L K P I W E B S I T E You can access the Visual KPI website by entering the Visual KPI website URL into your browser, or your mobile device. The Visual KPI website’s URL is dependent upon your specific installation. Contact your Visual KPI administrator if you are unsure of the URL. In general, the URL will follow this format: http://yourserver:yourport/VisualKPI
The Visual KPI Website is made up of pages that allow you to drill into the details of your KPI data. At the top left of each page is a menu that includes a link for the pages that you navigated through to get to the current page. For Example, Home | RegionNE | Exton. You can click any of these links to return to that page. The Home link returns you to the Home page. The RegionNE link is the Scorecard link and returns you to the RegionNE Scorecard page. The Exton link is the KPI link and returns you to the Exton KPI page. The icons at the upper left allow you to set the Status Filter and Attribute Grouping, or move to other pages: View Map, View List, or View Bar Chart. The icons at the upper right of the page allow you to execute an Export to CSV, Ad Hoc Trend, Search for a specific View, Scorecard or KPI, Send an e-mail to Transpara, or see information regarding the Visual KPI system.
N av
ig at
in g
in th
e Vi
su al
K PI
W eb
si te
Adding Visual KPI Pages to your Favorites When you frequently visit the same web site, you are likely to add that web site to your browser’s Favorites list, making it very easy to return to the same page at a later time. Visual KPI pages, including the Ad Hoc Trends, are no different – they can also be added to your browser’s Favorites. Not only is the page location saved in your Favorites, the Date and Status Filters, Trend Ranges, and Pens (for Ad Hoc Trends) are saved along with the page’s URL. This means you can define the reports you want to see, such as MTD, QTD or YTD, save them to your Favorites and then review them at anytime by selecting them from your Favorites. The reports will reflect not only your defined date ranges, but will dynamically include any edits to the data at the moment you open the page.
For example, say you have a particular trend that you refer to regularly. Each time you view this trend, you need to review its month-to-date and year-to-date progress. You have to navigate through the Views to the Scorecards then to the KPIs and finally to the Trend page. Then, you’ll need to define the Custom Range for the Trend page, twice (once for MTD and once for YTD). This entire process could be avoided once the page is added to your Favorites. So, once you define the Custom Range for your MTD report, add the page to your Favorites, naming it something descriptive. Then you define the Custom Range for your YTD report and add it to your Favorites. The next time you want to review the MTD or YTD report for the same KPI, you select it from your Favorites. The page is loaded displaying the current data for that KPI along with the custom range you previously defined.
Portrait and Landscape Views The Visual KPI Website supports the use of Landscape or Portrait views. While viewing the web pages in your hand held device you can switch between portrait and landscape, as needed. The Visual KPI Website pages will adjust to take advantage of the available screen space.
Auto Adjust to Window Size Beginning with version 3.1, the Visual KPI Server automatically resizes the screen contents to display within the current size of your browser. As the browser’s window size decreases, the contents are scaled down to fit. As the browser’s window size increases, the contents are scaled up to fit. In previous releases of Visual KPI, you were required to specify the height and width of your scorecards and views; this is no longer the case.
Using Mobile KPI
Links and Trends on the Visual K PI W
ebsite
L I N K S A N D T R E N D S O N T H E V I S U A L K P I W E B S I T E Links are pre-configured compact URLs generated from complex URLs. Trends are pre-configured custom trends. Links and Trends provide you with quick and easy access to your most frequently used information. Links and Trends can belong to a specific View and/or Scorecard, or multiple Views and/or Scorecards. Multiple pages within the Visual KPI website can include Links and/or Trends, depending on how your system is configured. The main page for Links and Trends is the Site Links & Trends page.
Site Links & Trends Page The Site Links & Trends page displays a list of the configured Links and Trends. The Site Links & Trends page is available by clicking Info icon from the Home page, All Views page and the All Scorecards page, as long as there is at least one Link or Trend with the Display in Links/Trends Page option set to True.
♦ Click the Info icon, , to move to the System Configuration Details page.
U S I N G T H E H O M E P A G E The Visual KPI website Home page presents a list of Views and a True Roll Up™ of all of the KPIs belonging to each view. Only those Views with a Show attribute set to a non-zero value as of the timestamp shown are included in the list. The True Roll Up™ provides a quick view of the statuses of the KPIs included in the View. The True Roll Up™ view can be disabled in the Web Site Configuration. Each View rollup is a link that takes you to the KPI Map page for that View.
Desktop Browser SmartPhone Browser
U si
ng th
e H
om e
Pa ge
♦ If supported by your device, mouse over the KPI Rollup to see statistics on the KPIs included in the View.
♦ Click any of the View names to move to the Scorecards page for the selected View.
♦ Click the View Map icon to move to the KPI Map page. The KPI Map includes all KPIs defined within each displayed View.
♦ Click the All Views link to display a list of Scorecards included in all of the Views, along with a True Roll Up™ of all of the KPIs by Scorecard.
♦ Click the Filter icon to move to the Status Filter page, where you can specify the statuses you want to include in the Visual KPI pages, as well as the Attribute Grouping and KPI Map Type to be used.
♦ Click the Ad Hoc trend icon to move to the Ad Hoc Trend page.
♦ Click the Search icon to move to the Search page.
♦ Click the Send E-mail icon to prepare to send an e-mail to Transpara that includes a link to the current page.
♦ In the Trend area, click a link to open the Trend page.
♦ In the Link area, click a link to open the URL in the current browser instance.
♦ Click the Info icon, , to move to the Site Links & Trends page, if Links and Trends are configured to be displayed for the site. Otherwise, the System Configuration Details page displays.
Using Mobile KPI
U sing the Scorecards Page
U S I N G T H E S C O R E C A R D S P A G E The Scorecards page presents a list of Scorecards and a True Roll Up™ of the KPIs for each Scorecard. The True Roll Up™ provides a quick view of the statuses of the KPIs included in each Scorecard. Each Scorecard name in the list is a link that takes you to the KPI page for that Scorecard. The True Roll Up™ view can be disabled in the Web Site Configuration. Each Scorecard rollup is a link that takes you to the KPI Map page for that Scorecard.
♦ If supported by your device, mouse over the KPI Rollup to see statistics on the KPIs included in the Scorecard.
♦ Click any of the Scorecard names to move to the KPI page for the selected Scorecard. Only those Scorecards that have a create date on or after the date and time shown are included in the list.
♦ Click any of the Scorecard rollups to move to the KPI Map page for the selected Scorecard. Only those Scorecards that have a create date on or after the date and time shown are included in the list.
♦ Click the View Map icon to move to the KPI Map page. The KPI Map includes all KPIs defined within each Scorecard in the selected View.
♦ Click the All Scorecards link, or the View List icon, to move to the KPI page, which includes a listing of the Scorecards’ KPIs, and their Target and Actual values. This list of KPIs is grouped by the attribute specified in the Default Attribute Grouping, or custom Attribute Grouping.
♦ Click the View Bar Charts icon to move to the Bar Chart page, which includes a listing of the Scorecards’ KPIs, their Actual values, and a bar chart for each.
♦ Click the Filter icon to move to the Status Filter page, where you can specify the statuses you want to include in the Visual KPI pages, as well as the Attribute Grouping and KPI Map Type to be used.
♦ Click the Ad Hoc trend icon to move to the Ad Hoc Trend page. ♦ Click the Search icon to move to the Search page. ♦ Click the Send E-mail icon to prepare to send an e-mail to Transpara that includes a link to
the current page. ♦ In the Trend area, click a link to open the Trend page. ♦ In the Link area, click a link to open the URL in the current browser instance. ♦ Click the Info icon, , to move to the View Configuration Details page displays. ♦ Click the Home link to return to the Home page.
Using Mobile KPI
16 Transpara Corporation
U si
ng th
e K
PI P
ag e
U S I N G T H E K P I P A G E The KPI page presents the current status information for the KPIs defined in the selected Views or Scorecards. Included in the KPI page are the KPI name, Status symbol, Sparkline, and Actual and Target values for each KPI in the Scorecard.
A sparkline is a small graphic that provides a visual display of a KPI’s values over time. The Default Time Range defined for the web site is the range used for the sparklines. On the right-most end of the sparkline is a red dot, which reflects the snapshot value of the KPI.
♦ Click any of the KPI names to move to KPI Configuration Detail page for the selected KPI.
♦ Click any of the KPI Status symbols to move to the Trend page for the selected KPI.
♦ Click the View Map link to move to the KPI Map page for the selected Scorecard.
♦ Click the Filter icon to move to the Status Filter and Attribute Grouping page, where you can specify the statuses you want to include in the Visual KPI pages, as well as the Attribute Grouping and KPI Map Type to be used.
♦ Click a Trend link to open the Trend page.
♦ Click a Link link to open the URL in the current browser instance.
♦ Click the Info icon, , to move to the Scorecard Configuration Details page.
♦ Click the Home or scorecard link to return to the selected page.
♦ If supported by your device, mouse over the Status symbol to see the Status text (for example, High or Low Low).
NOTE: On the KPI page, the Status symbol is followed by an asterisk if a custom status calculation is being used for the associated KPI.
Using Mobile KPI
U sing the Status Filter &
A ttribute G
rouping Page
U S I N G T H E S T A T U S F I L T E R & A T T R I B U T E G R O U P I N G P A G E In the Status Filter and Attribute Grouping page, you can customize the way the Visual KPI pages display. The filter settings remain in effect during your current browser session, or until you change the filter settings again.
You can customize the following settings: Status Filters Standard Attribute Grouping Custom Attribute Grouping KPI Map Type Trend Scale Type
If no custom Filtering & Grouping has been selected, the Filter icon is not filled in, otherwise the icon is filled in.
1. Click the Filter icon. The Status Filter and Attribute Grouping page displays.
2. Select one or more of the statuses that you want displayed on the Visual KPI pages. Only the statuses selected will be displayed.
3. If you want to change the way your data is grouped, you can override the system defined Default Attribute Grouping. Select either a standard attribute (options include Default, None, Status, View, or Scorecard) or custom attribute (options include any custom attributes defined within the Visual KPI system). Selecting a Standard Attribute causes any selection made in the Custom Attribute Grouping section to be removed. Alternatively, selecting a Custom Attribute causes any selection made in the Standard Attribute Grouping section to be removed.
4. If you want to override the system defined KPI Map Type, select from Standard, Break and Break + Name.
5. If you want to override the Trend Scale Type (set for each KPI), select from Single Scale and Multi-Scale. Default causes the the KPI’s defined Trend Scale Type to be used.
6. Click the Apply button. You are returned to the previous page. Only those KPIs with statuses that were selected are displayed. All KPI pages are grouped according to the selection you made.
Using Mobile KPI
U si
ng th
e K
PI M
ap P
ag e
U S I N G T H E K P I M A P P A G E The KPI Map page provides a visual representation of the current status of the KPIs in the View(s) or Scorecard(s) displayed in the current page. The KPI Map page displays a table of colored cells where each cell represents a single KPI. The default status colors are Green, Yellow, Red, Gray, Black or White, based on the KPI’s status. Green = Good, Yellow = Suspect, Red = Bad, Gray = Unknown, Black = Not In Service, White = N/A. You can mouse over a cell to see the following information in a tool tip: Grouping Attribute Name and its value within the KPI, Scorecard name, KPI name, Description, Top Text, Bottom Text, Status text, Target value, and Actual Value.
The KPI Map page can be accessed from any Visual KPI page. The contents of the KPI Map page are dependent on the page from which you selected the View Map icon. For example, if you selected the View Map icon from the Scorecard page, then all KPIs defined in the currently selected View are included in the map and a black outline is used to indicate the boundaries of the individual scorecards. If you selected the View Map icon from the KPI page, then only those KPIs defined in the currently selected Scorecard are included in the KPI Map.
If Top Text and/or Bottom Text have been defined for a KPI, they are displayed in the KPI cell. The text may be truncated, or removed, if there isn’t enough available space in the KPI cell. The complete text is displayed when you mouse over the KPI in the KPI map.
The KPI Map can be displayed as one of three types: Standard, Break, and Break + Name. The Standard KPI Map displays KPIs starting at the top left corner wrapping from left to right, then from right to left on the next line, and so on. The KPIs are grouped by the attribute selected in the Filter & Grouping page, with a black border surrounding each group. The Break KPI map displays KPIs starting at the top left corner from left to right on each line, and a new line is started for each group. The Break + Name KPI map displays KPIs starting at the top left corner from left to right on each line, and a new line is started for each group. On the row above each group is the name of the group.
♦ Click any of the KPI cells to show the KPI Map Detail page.
♦ Click the KPI name to move the KPI Configuration Details page.
♦ If supported by your device, mouse over a cell to see the following information in a tool tip: Scorecard name, KPI name, Description, Top Text, Bottom Text, Status text, Target value, and Actual Value.
♦ Click the About icon to move to the: 1) View Configuration Details page, if the KPI Map includes an entire View; 2) Scorecard Configuration Details, if the KPI Map includes a single Scorecard.
♦ Click the View List icon to move to the KPIs page, which includes a listing of the KPIs, and their Target and Actual values.
♦ Click the View Bar Charts icon to move to the Bar Chart page, which includes a listing of the KPIs, their Actual values, and a bar chart for each.
Using Mobile KPI
U sing the K
PI M ap Page
♦ Click the Home or scorecard link to return to that page.
♦ Click the All Scorecards link to move to KPI page.
KPI Map of View KPI Map Type = Standard and Attribute Grouping = None
Using Mobile KPI
U si
ng th
e K
PI M
ap P
ag e
KPI Map of View KPI Map Type = Break and Attribute Grouping = None
KPI Map of View KPI Map Type = Break + Name and Attribute Grouping = Scorecard
Using Mobile KPI
U sing the K
PI M ap Page
KPI Map of Scorecard KPI Map Type = Standard and Attribute Grouping = None
KPI Map of Scorecard KPI Map Type = Break and Attribute Grouping = None
KPI Map of Scorecard KPI Map Type = Break + Name and Attribute Grouping = Scorecard
Using Mobile KPI
e
U S I N G T H E K P I M A P D E T A I L P A G E Clicking a KPI cell on the KPI Map page causes the KPI Map Detail page to display. The KPI Map Detail page includes the KPI Map plus a table that shows the details for the selected KPI. The KPI detail includes the owning Scorecard name, KPI name, Status symbol, and Actual and Target values for the KPI.
♦ Click the Scorecard name in the detail table to move to the Scorecard page for the selected KPI.
♦ Click the KPI name in the detail table to move to the KPI Configuration Detail page for the selected KPI.
♦ If the selected KPI has a defined URL, an arrow displays in the status symbol’s column header. If supported by your device, you c an mouse over the arrow icon to see the defined URL Descriptor, or click the arrow icon to move to the KPI’s defined URL.
♦ If supported by your device, you can mouse over a cell in the map to see the following information in a tool tip: Scorecard name, KPI name, Description, Top Text, Bottom Text, Status text, Target value, and Actual Value.
♦ If supported by your device, you can mouse over the Status symbol in the table to see the Status text (for example, High High, or Low).
♦ Click the About icon to move to the: 1) View Configuration Details page, if the KPI Map includes an entire View; 2) Scorecard Configuration Details, if the KPI Map includes a single Scorecard.
♦ Click the KPI Status symbol in the detail table to move to the Trend page for the selected KPI.
♦ Click a KPI cell to show that KPI in the KPI Map Detail table.
♦ Click the View Scorecard icon to move to the Scorecard page, which includes a listing of the Scorecards’ KPIs, and their Target and Actual values.
Using Mobile KPI
U sing the K
PI C onfiguration D
etail Page
U S I N G T H E K P I C O N F I G U R A T I O N D E T A I L P A G E The KPI Configuration Detail page displays configuration and current status information for the selected KPI, including the date and time the value was last updated. The page is separated into sections: Responsible Person, Details, Custom Attributes and Member Of.
You can Access the KPI Configuration Detail page, select a KPI name link from
The Responsible Person section displays a pre-defined Name, E-mail address, Phone number and Info URL, allowing you to quickly access contact information for the person responsible for any particular KPI.
The Details section displays the details of the KPI, which includes a column for each of the following: KPI’s attribute name; current status/value; sparkline; attribute definition; date and time the attribute was last updated. If the KPI attribute has not been defined, the status and definition will display N/A. If the KPI value is underlined, you can click it and manually change the value using the Manual Entry page.
A sparkline is a small graphic that provides a visual display of a KPI’s values over time. The Default Time Range defined for the web site is the range used for the sparklines. On the right-most end of the sparkline is a red dot, which reflects the snapshot value of the KPI.
The Attributes section displays the details of any custom attributes defined for the KPI, which includes columns for the Attribute Name and the Attribute Definition. If the KPI attribute has not been defined, the status and definition will display N/A.
If you have configured your system to Suppress Unused Fields or Suppress Unused Columns, then fields and columns that do not have data in them will not be shown in the KPI Configuration Detail page. Otherwise, the fields without data will display with “N/A” as the data.
The Member Of section provides a list of the Scorecards in which the KPI is currently a member. The Scorecard Name, Description and KPI Selection Query are included in this section. The Scorecard Name is a link to the Scorecard’s Configuration Detail page.
♦ Click the Email link in the Responsible Person section to quickly create an e-mail that can be sent to the Responsible Person. The specified e-mail address is copied into the e-mail, along with “Visual KPI-[KPIName]” in the Subject line and a link to the current KPI Configuration Detail page in the body of the e-mail.
♦ Click the Phone link in the Responsible Person section to dial the number listed for the Responsible Person; this link is only valid if used in phone-enabled devices.
Using Mobile KPI
ry P
ag e
♦ Click the Info URL link in the Responsible Person section to open the specified web page/document. This link can be used to direct the user to a location that can include detailed instructions on what to do should the KPI’s status become unacceptable.
♦ Click the Status symbol in the Details section to move the Trend page for the selected KPI.
♦ Click any of the underlined values in the Details section to move to the Manual Entry page for the selected KPI, where you can then manually assign a value for the selected KPI.
♦ Click the Scorecard Name link in the Member Of section to move to the Scorecard Configuration Detail page.
♦ Click the View Map icon to move to the KPI Map page for the current Scorecard.
♦ Click the View List icon to move to the Scorecard page, which includes a listing of the Scorecard’s KPIs, and their Target and Actual values.
♦ Click the View Bar Charts icon to move to the Bar Chart page, which includes a listing of the current Scorecard’s KPIs, their Actual values, and a bar chart for each.
♦ Click the browser’s Back button to return to the previous page.
U S I N G T H E M A N U A L E N T R Y P A G E The Manual Entry page allows you to enter values for KPIs that support manual data entry. You can specify the KPI value, as well as the date and time to be associated with the KPI value. Using the Manual Entry page, you can enter historical data to be used for a KPI.
The Manual Data interface must be configured correctly to allow for manual data entry via the Manual Entry page. (Refer to the Manual Data Interface section in the Visual KPI 3.1 User’s Guide for detailed information.) You must also be a member of the Manual Data interface’s Update Group to be allowed access to the Manual Entry page.
The Manual Entry page displays the KPI’s name, the KPI’s Alias (such as Actual, Low, High High, etc.), the current KPI Value and the current Date and time on the Visual KPI Server.
Using Mobile KPI
U sing the Scorecard C
onfiguration D etail Page
Entering KPI Values Using the Visual KPI Website 1. When you open the KPI Configuration Detail page, any KPI values that support manual data
entry are underlined.
2. Click the value to be edited. The Manual Entry page displays.
3. Enter a new Value and make any required changes to the Date and time. Click Update to add the value to the Visual KPI Server. Otherwise, click Cancel to cancel the update and return to the KPI Configuration Detail page.
4. Repeat steps 2 and 3 for any additional values you need to add.
NOTE: You will lose all historical data associated with a KPI attribute if you remove the Manual Data interface from any of the KPI’s configuration and save the KPI. Refer to Manual Data Interface section in the Visual KPI 3.1 User’s Guide for additional information.
U S I N G T H E S C O R E C A R D C O N F I G U R A T I O N D E T A I L P A G E The Scorecard Configuration Detail page displays configuration information for the current Scorecard, including the date and time the configuration values were last updated. The page is separated into sections: Details, Custom Attributes, and Member Of. Additionally, all configured Links and Trends related to this scorecard are displayed at the bottom of the page.
The Details section includes a column for each of the following: Attribute Name; Current Value; Attribute Definition; Date and Time the attribute was last updated. If the Scorecard attribute has not been defined, the current value and definition will display N/A.
The Attributes section displays the details of any custom attributes defined for the Scorecard, which includes columns for the Attribute Name and the Attribute Definition. If the KPI attribute has not been defined, the status and definition will display N/A.
Using Mobile KPI
ag e
If you have configured your system to Suppress Unused Fields or Suppress Unused Columns, then fields and columns that do not have data in them will not be shown in the Scorecard Configuration Detail page. Otherwise, the fields without data will display with “N/A” as the data.
The Member Of section provides a list of the Views in which the Scorecard currently is a member. The View Name and Scorecard Selection Query are included in this section. The View Name is a link to the View’s Configuration Detail page.
♦ Click the View Name link in the Member Of section to move to the View Configuration Detail page.
♦ Click the View Map link to move to the KPI Map page for the current Scorecard.
♦ Click the View List icon to move to the Scorecard page, which includes a listing of the Scorecard’s KPIs, and their Target and Actual values.
♦ Click the View Bar Charts icon to move to the Bar Chart page, which includes a listing of the current Scorecard’s KPIs, their Actual values, and a bar chart for each.
U S I N G T H E V I E W C O N F I G U R A T I O N D E T A I L P A G E The View Configuration Detail page displays configuration information for the current View, including the date and time the configuration values were last updated.
The page includes a column for each of the following: Attribute Name; Current Value; Attribute Definition; Date and Time the attribute was last updated. If the View attribute has not been defined, the current value and definition will display N/A.
Using Mobile KPI
U sing the System
etail Page
If you have configured your system to Suppress Unused Fields or Suppress Unused Columns, then fields and columns that do not have data in them will not be shown in the View Configuration Detail page. Otherwise, the fields without data will display with “N/A” as the data.
♦ Click the View Map link to move to the KPI Map page for the current View.
♦ Click the View List icon to move to the Scorecard page, which includes a listing of the View’s KPIs, and their Target and Actual values.
♦ Click the View Bar Charts icon to move to the Bar Chart page, which includes a listing of the current View’s KPIs, their Actual values, and a bar chart for each.
U S I N G T H E S Y S T E M C O N F I G U R A T I O N D E T A I L P A G E The System Configuration Detail page displays configuration information for the current system. The page includes sections with details on the Application Status, Application Information, Application Statistics, Client Information and Browser Information.
The Application Status section displays the current status of the Visual KPI application and any defined interfaces.
The Application Information section includes version and license information, as well as the contact information for the Visual KPI System Administrator.
The Application Statistics section provides a count for the total number of Views, Scorecards, KPIs, and Interfaces.
The Client Information displays information regarding the current client, including the type of client, the current screen width and height, and the number of sessions.
The Browser Information displays basic information regarding the browser used.
Using Mobile KPI
e
♦ Click the Administrator’s name link in the Application Information section to quickly create an e-mail that can be sent to the Visual KPI Administrator.
♦ Click the View Map link to move to the KPI Map page for the current View.
♦ Click the View List icon to move to the Scorecard page, which includes a listing of the View’s KPIs, and their Target and Actual values.
♦ Click the View Bar Charts icon to move to the Bar Chart page, which includes a listing of the current View’s KPIs, their Actual values, and a bar chart for each.
Using Mobile KPI
U sing the Trend Page
U S I N G T H E T R E N D P A G E The Trend page provides a graphical view of the selected KPI’s Actual values, and includes the Low Low, Low, High and High High values. By default, the trend displays the previous seven days of data. You can change the amount of data you see by selecting from any number of pre-defined date ranges, or by entering a custom date range. The currently selected From and To dates and times are displayed below the trend graph.
You can scroll backward and forward on the Trend page by using the Left and Right arrows. As you scroll through the trend, the dates at the bottom corners of the trend update to indicate the current date range. If you are viewing non-historian data, scrolling into the future allows you to view trends of your projected data. If no Actual values are displayed on the trend, a message displays: “No Actual data in selected range”.
Trend Scrolled into Future – No Actual Data Available
NOTE: Refer to Using Interactive Trends for details on interacting with trends.
Using Mobile KPI
U si
ng th
e Tr
en d
Pa ge
KPI Trend Types KPIs can be configured to use one of the following Trend Types: Interpolated, Step, Symbol, Interpolated + Symbol, or Step + Symbol. If you do not set a KPI’s Trend Type, it will default to Interpolated. The following are examples of the same tag using each of the Trend Types.
Trend Type = Interpolated (0)
Trend Type = Step (1)
Trend Type = Symbol (2)
U sing the Trend Page
Trend Type = Interpolated + Symbol (3)
Trend Type = Step & Symbol (4)
Using Mobile KPI
U si
ng th
e Tr
en d
Pa ge
KPI Trend Scales KPIs can be configured to use Single Scale or a Multi-Scale Trend Scale. The following are examples of the same trend using each of the Trend Scales.
Trend Scale = Single Scale
The Legend Entries are not underlined and cannot be selected. Selecting a different KPI in the legend causes the Y Axis Scale to change to represent the selected KPI. An asterisk displays to the left of the KPI that is currently represented on the Y Axis.
Trend Scale = Multi-Scale
The Legend Entries are underlined and can be selected. Selecting a different KPI in the legend causes the Y Axis Scale to change to represent the selected KPI. An asterisk displays to the left of the KPI that is currently represented on the Y Axis.
♦ If the Visual KPI Web Site is configured to display the Legend (see Configuring Your Web Site in the Visual KPI 3.1 User’s Guide), you can mouse over Legend entries to display the range attribute’s definition in a tooltip.
Using Mobile KPI
U sing the A
d H oc Trend Page
♦ Click the Defined Ranges button to move to the Defined Ranges page where you can select from a list of pre-defined ranges for the trend; these ranges are defined using either of the Visual KPI Editors.
♦ Click the Custom Range button to move to the Custom Ranges page where you can specify custom From and To dates for the trend.
♦ Click the Back button to scroll back in time; the trend updates to reflect the new time range.
♦ Click the Forward button to scroll forward in time; the trend updates to reflect the new time range.
♦ Refer to Using Interactive Trends for details on interacting with trends.
♦ Click the KPI name to move to the KPI Configuration Detail page for the selected KPI.
♦ Click the About icon to move the KPI Configuration Details page.
♦ Click the Export to CSV icon to save the current trend data to a CSV file, or display a static screen of the data on a handheld.
♦ Click the Home, view, scorecard, or KPI link to return to that page.
U S I N G T H E A D H O C T R E N D P A G E The Ad Hoc Trend page allows you to build a custom Trend page at any time. An Ad Hoc Trend can include up to ten pen definitions, each of which includes a value, a pen color, an interface, and an offset. The values can be a tag name, a calculation, a constant value, or tag for manually entered data. The Visual KPI Server retrieves, or calculates, the values associated with each pen based on the time range specified for the Ad Hoc Trend. Ad Hoc Trends support the following trend types: Interpolated, Step, Symbol, Interpolated + Symbol, or Step + Symbol.
An Ad Hoc Trend page can be added to your Favorites list, allowing you to view the page at any time, without having to reconfigure it each time. When an Ad Hoc Trend is added to your Favorites list, the complete definition is saved, including the Time Range, Pen configurations and any calculations you may have included. Refer to Adding Visual KPI Pages to your Favorites for additional information.
Using Calculations in an Ad Hoc Trend Ad Hoc Trends support the use of calculations in any of the Lookup values. Ad Hoc Trend calculations must comply with the rules defined in the Supported Operations in Attribute Calculations section in the Visual KPI 3.1 User’s Guide. If a tag name is referenced in a calculation, the Interface from which the value will be retrieved must also be specified. If multiple tag names are referenced, they must all be from the same system, as only one Interface can be specified per pen.
Using Mobile KPI
e
Using an Ad Hoc Trend Offset The Ad Hoc trend supports the use of an Offset, which allows you to compare trends using different start dates/times. When you configure an Offset for a value, the start date/time of that value’s trend is different than the start date/time being used for the values without an Offset. For example, you may want to review seasonal variations in the number of power outages between two Summers. You can review the two trends by defining two pens (each of which reference the same tag), and assigning an Offset of “-12month” to one of the pens, then setting a custom range once the Ad Hoc trend is drawn.
When defining an Offset, use the following notations:
[+/-][integer][timeperiod], where [timeperiod] is a member of the following set: minute, hour, h, day, d, month, year
Examples:
♦ An Offset of -6month causes the starting date for the value’s trend to be 6 months prior to the date/time being used on the current Ad Hoc trend.
♦ An Offset of -12h causes the starting date/time for the value’s trend to be 12 hours prior to the date/time being used on the current Ad Hoc trend.
NOTE: Refer to Using Interactive Trends for details on interacting with trends.
Using Mobile KPI
U sing the A
d H oc Trend Page
Building an Ad Hoc Trend Page 1. On any Visual KPI web page, click the Ad Hoc Trend button.
The Ad Hoc Trend configuration page displays.
If the Ad Hoc Trend is initiated from the KPI Configuration Detail page or Trend page, up to eight pens are configured on the Ad Hoc Trend definition, one for each of the KPI’s following range attributes that have been defined: Min, LowLow, Low, Actual, Target, High, HighHigh and Max. By default, the Min and Max attributes are not selected.
If the Ad Hoc Trend is initiated from any page other than the KPI page, one pen with the default configuration is added to the Ad Hoc Trend definition.
2. From the Trend Type list, select the type of trend you want to create. You can select from the following types: Interpolated, Step, Symbol, Interpolated + Symbol, or Step + Symbol.
3. From the Pen Count list, select the number of values to be included on the trend. For each additional pen added, a new Pen section is added to the page.
4. In the first Pen section, select the check box associated with the pen if you want the attribute to be displayed on the Ad Hoc Trend. Remove the check mark if you want to keep the attribute available for future use in the Ad Hoc Trend, but you do not want it displayed.
5. From the Interface list, select the interface from which the data for the Lookup value will be retrieved. The list includes all interfaces defined for the current Visual KPI Server, or you can select Constant Value.
Using Mobile KPI
6. In the Lookup field, do one of the following:
a. Add a tag name – you must specify the Interface to be used to retrieve the value.
b. Add a single value – the Interface must be set to Constant Value.
c. Add a calculation using a combination of tag names, alias names, and/or constants – the calculation must conform to the rules defined in the Supported Operations in Attribute Calculations section in the Visual KPI 3.1 User’s Guide.. If you specify a tag name, you must also specify the Interface to be used to retrieve the value. If multiple tag names are referenced, they must all be within the same system, as you can set only one Interface per pen.
7. Specify an Offset, if you want the value’s trend to be displayed using a start date/time different than that used on the current Ad Hoc trend. Use the following notations for the Offset:
[+/-][integer][timeperiod], where [timeperiod] is a member of the following set: minute, hour, h, day, d, month, year
8. Accept the default Pen Color or select a new color from the list.
9. Repeat steps 4-8 for each Pen included in the Ad Hoc Trend.
10. When you have defined each of the KPIs for the Ad Hoc trend, click the Trend button. Or, you can click Cancel to return to your previous page.
♦ If the Visual KPI Web Site is configured to display the Legend (refer to Configuring Your Web Site section in the Visual KPI 3.1 User’s Guide for additional information), you can mouse over Legend entries to display the Lookup value’s definition in a tooltip.
♦ Refer to Using Interactive Trends for details on interacting with trends.
♦ If you want to make changes to the current Ad Hoc Trend configuration, click the Ad Hoc Trend icon. You are returned to the Ad Hoc Trend configuration page, with the current configuration data.
♦ Click the Defined Ranges button to move to the Defined Ranges page where you can select from a list of pre-defined ranges for the trend; these ranges are defined using either of the Visual KPI Editors.
Using Mobile KPI
U sing Interactive Trends
♦ Click the Custom Range button to move to the Custom Ranges page where you can specify custom From and To dates for the trend.
♦ Add to your Favorites. This will save the Ad Hoc Trend configuration, allowing you to easily revisit this trend at any time.
♦ Click the Export to CSV icon to save the current trend data to a CSV file.
♦ Click the Home, view, scorecard, or KPI link to return to that page.
U S I N G I N T E R A C T I V E T R E N D S Interactive Trends allow you to view more information in your trend pages. In a trend, you can mouse over any part of the trend and see the value in a tooltip, as well as in the upper-left corner of the trend. You can also lock a specific value and then mouse over other points and see both values in the upper-left corner of the trend. Finally, you can zoom in on a section of a trend to see a closer view of the existing detail.
NOTE: Interactive Trends are supported only on the desktop version of Visual KPI.
Viewing Values in a Trend In any trend, move the mouse over the trend, pausing where you want to see the value associated with that point in time. The Attribute name, point value, and date and time, display in a tooltip and in the upper-left corner of the trend page.
Using Mobile KPI
U si
ng In
te ra
ct iv
e Tr
en ds
Comparing Values in a Trend In any trend, locate the value you want to lock, and click that point on the trend. A red dot is placed on that point, and the value and its attribute, along with the date and time, is shown in the upper-left corner of the trend with the indication of “(Locked)” after the value. Above the locked value is the same info for the value being compared to the locked value.
After locking a value, move the cursor along the trend to compare other values to the locked value. As you move along the trend, the value’s information displays in the tooltip, as well as above the locked value’s information in the upper-left corner of the trend.
You can change the locked value by clicking another point; the red dot is moved to the new location and the value’s information displays in the upper-left corner of the trend.
Refreshing the trend causes the locked value to be unlocked.
Using Mobile KPI
Comparing Values on Different Trends You can create an Ad Hoc trend and use the Offset value to compare values of the same tag across times. Once the Ad Hoc trend is displayed, you can lock a value on any of the trends, then move the cursor over another trend to compare the values. The locked value’s information, along with the information of the current mouse over point are displayed in the upper-left corner of the trend. If the Legend is displayed, you can see the offset amount in the legend, to the right of the Pen’s information.
Changing the Active Y Axis Scale On A Trend Multi-scale trends allow you to switch Y Axis scales by simply clicking different KPIs in the Legend. Each time you click a different KPI in the Legend, the Y Axis scale changes to reflect the selected KPI, and each trend updates to reflect the new Y Axis scale.
Example
The following is an example showing three different views of the same trend using the same time period. Each view shows the trend with a different Y Axis scale.
In this view, the current Y Axis scale is based on cdt158, which is Pen 1. Notice the Y Axis scale is 50 to 260.
Using Mobile KPI
U si
ng In
te ra
ct iv
e Tr
en ds
In this view, the current Y Axis scale is based on sinusoid, which is Pen 2. Notice the Y Axis scale is now 0 to 105.
In this view, the current Y Axis scale is based on the calculated value of sinusoid/sinusoidu, which is Pen 3. Notice the Y Axis scale is now 0 to 105.
Using Mobile KPI
Zooming In A Trend You can zoom in on a trend, enlarging the selected area. To zoom in, hold the left mouse button down and drag the cursor across a section of the trend, letting go of the left mouse button when you have selected the complete area to include in the zoom. As you drag the cursor across the trend, the selected area is shaded, making it easy to see the zoom area being selected. Alternatively, you can use your mouse wheel to zoom in and out on the trend. When you have reached the maximum zoom level, a message displays. If you zoom too far into the trend, it will no longer be interactive; you can zoom out and it becomes interactive again. Refreshing the page causes the trend to return to original size; any locked value will be unlocked.
Once you have selected the zoom area, the trend redraws and displays the current detail of the selected area of the trend. If you had a locked value prior to zooming in, the value is still locked.
Using Mobile KPI
C SV
You can still compare values while zoomed in on a trend.
U S I N G E X P O R T T O C S V The Export to CSV option allows you to export trend data to a CSV file, when using the Desktop version of Visual KPI. The Export to CSV option, when used on a handheld, sends the data to a static screen that contains a table of raw data and timestamps, allowing you to scroll through the data in the table.
From any Visual KPI trend page (including an Ad Hoc Trend), you have the option to Export to CSV the displayed trend data. The exported data includes the KPI name, tag name, timestamps and values for each KPI in the trend. One reason to export the data is to use the exported data to create your own custom charts in Microsoft Excel.
Using Mobile KPI
U sing Export to C
SV
Export To CSV Example Using Visual KPI Desktop Version The following is an example of creating a Scatter Plot Chart in Microsoft Excel of data from a Visual KPI trend. This Visual KPI Trend includes the High High, High, Target, Actual, Low, and Low Low values for the trended KPI, TransEnergy_EXCT1grMW.
Click the Export to CSV icon, , to open the File Download dialog. You have the option to save or open the trend.csv file.
Using Mobile KPI
C SV
Whether the file is saved or opened, once it is open in Excel it includes the KPI name, tag name, timestamps and values for each KPI in the trend.
Select the data for which you want to create an Excel Chart. In this example, the Actual data is selected, including the KPI name and tag name. The selection starts at Row 22 in Column A and includes both columns A and B and continues down to the last row of data for TransEnergy_EXCT1grMW.
Using Mobile KPI
U sing Export to C
SV
With the data selected, insert the type of chart you want to create. In this example, a Scatter chart with lines and markers is being created.
The Scatter Plot is added to the spreadsheet with the default settings.
Format the Scatter Plot to suit your own needs.
Using Mobile KPI
C SV
Export To CSV Example Using Visual KPI Mobile Version The following shows a trend before it is exported to CSV on a handheld.
The following shows the data table that displays when Export to CSV is used on the trend above, on a handheld.
Using Mobile KPI
U sing the B
ar C harts Page
U S I N G T H E B A R C H A R T S P A G E The Bar Charts page provides a visual representation of the current status of your KPIs. The Bar Charts page includes the KPI Name, Actual value, Target value, and a bar chart depicting how the Actual value compares with the KPI’s defined range data (Min, LL, L, T, H, HH, Max). The bar’s color is based on the KPI’s status. If the Visual KPI Web Site is configured to display the Legend (refer to Configuring Your Web Site section in the Visual KPI 3.1 User’s Guide for additional information) the legend icons display at the bottom of the page.
If you selected the View Bar Charts link from the View page, all KPIs defined in the currently selected View are included on the page. If you selected the View Bar Charts link from the KPI page, then only those KPIs defined in the currently selected Scorecard are included.
Bar Charts Page - Accessed from Scorecard Page
♦ If supported by your device, you can mouse over a bar chart to see the following information in a tool tip: KPI name, Status, Description, Min value, Low Low value, Low value, Target value, Actual value, High value, High High value and Max value.
Using Mobile KPI
ge
♦ Click the Scorecard name in the detail table to move to the Scorecard page for the selected KPI.
♦ Click the KPI name in the detail table to move to the KPI Configuration Detail page for the selected KPI.
♦ Click the Bar Chart in the detail table to move to the Trend page for the selected KPI.
♦ In the Trend area, click a link to open the Trend page.
♦ In the Link area, click a link to open the URL in the current browser instance.
♦ Click the About icon to move to the: View Configuration Details page, if the Bar Chart includes an entire View; Scorecard Configuration Details, if the Bar Chart includes a single Scorecard.
♦ Click the View Map icon to move to the KPI Map page. The KPI Map will include all KPIs defined within each Scorecard in the selected View.
♦ Click the View List icon to move to the Scorecard page, which includes a listing of the Scorecards’ KPIs, and their Target and Actual values.
A KPI’s definition affects the structure of the bar chart; the more range fields defined in the KPI, the more complete the bar chart. From left to right, the following range fields are denoted on the bar chart: Min, Low Low, Low, Target, High, High High, and Max. With the exception of the Min and Max values, the range values are denoted by hash marks on the bottom of the bar chart. If the Min value is defined, it is the left-most end of the chart. The Max value, when present, is the right-most end of the chart.
Using Mobile KPI
U sing the B
ar C harts Page
The following examples also include red text denoting the range fields included on the chart (bar charts do NOT include this text). The KPIs represented in these examples include a different group of defined range fields, values and statuses.
NOTE: For KPIs with no range fields defined, the bar chart will not be displayed.
Using Mobile KPI
e
U S I N G T H E S E A R C H P A G E The Search page allows you to search for objects that are currently displayed within the Visual KPI web pages: Views, Scorecards and KPIs.
1. Click the Search icon to open the Search page.
2. Enter the name, or part of the name, of the object you want to locate and click the Search button. Clicking Cancel will return you to the previous page.
3. A message displays, if no objects were found. Otherwise, the search results are returned. The search results are presented differently, depending on what was found.
For example, if only KPIs were found, the search results display the following information for each KPI that is returned: KPI Name, Status icon, Actual Value, and Target Value. However, if Scorecards and KPIs were found, the search results display the Scorecard’s Rollup view, along with the KPI information.
4. In the Search Results, you can click links to move to other pages, mouse over status icons and Rollups to see current information, in the same manner you would in other Visual KPI web pages.
Using Mobile KPI
U sing the D
efined R anges Page
U S I N G T H E D E F I N E D R A N G E S P A G E The Defined Ranges page allows you to select from a list of pre-defined date ranges to be used for the Trend page. The list of Defined Ranges is configured in either of the Visual KPI Editors.
1. Click the Defined Range link.
The Defined Ranges page displays.
2. Click the link for the range you want to use in the Trend page. You are returned to the Trend
page and the selected date range is used for the trend. The From and To dates below the Trend are updated to reflect the new range selection.
Using Mobile KPI
ge
U S I N G T H E C U S T O M R A N G E S P A G E The Custom Ranges page allows you to specify custom dates to be used for the Trend page.
1. Click the Custom Range link.
The Custom Ranges page displays.
2. Enter a valid date, date and time, or relative timestamp using the following time notations:
Absolute Date and Time:
Date: 8/1/06, or 08/01/2006 (will default to midnight, if no time is specified)
Date and Time: 8/1/06 12:00 AM, or 08/01/2006 08:00:00
Note: When entering an absolute date and time using the Excel Editor, you must prefix the date/time entry with an apostrophe. Example: '1/1/2010 12:00 AM
Relative Date and Time:
* = Current time
*[+/-][integer][timeperiod], where [timeperiod] is a member of the following set: minute, hour, h, day, d, month, year
Examples:
♦ A Start Time of 08/01/2006 and an End Time of 08/31/2006 23:59 will include all data starting at midnight on August 1, 2006 up to and including 11:59 PM on August 31, 2006.
♦ A Start Time of *-7d and an End Time of * means to include all data from seven days prior to the current time, up to and including the current time.
3. Click the Apply button to set the Custom Date range and return to the Trend page. The Trend updates to the display data for the specified date range.
Index
A Ad Hoc Trend page
building · 35 Custom Calculations · 33 using · 33
asterisk used in website · 16
B Bar Charts
KPI Configuration Detail page · 23 Scorecard Configuration Detail page · 25
Custom Ranges page using · 52
D Defined Ranges page
using · 51 Details
KPI Configuration Detail page · 23 Scorecard Configuration Detail page · 25 System Configuration Detail page · 27 View Configuration Detail page · 26
E Export to CSV · 42
F Favorites
using · 17
URL · 22 URL Descriptor · 22
KPI Components KPI Web Editor · 9 Visual KPI Alert Server · 9 Visual KPI Cache Server · 9 Visual KPI Excel Editor · 9 Visual KPI Interfaces · 9
KPI Configuration Detail page using · 23
KPI Map page · 18 KPI Map Page
using · 18 KPI Map Type
Break example · 20, 21
Break + Name example · 20
Standard example · 19
KPI Page sparklines · 16, 23 using · 16
L landscape view · 12
M manual data entry
Visual KPI Website · 24 Manual Entry Page · 24 Map Detail Page
using · 22 Multi-Scale example · 32
N navigating Visual KPI website · 11
O Offset · 34, 36 Offset value · 34
Index
P pen color · 36 pen count · 35 portrait view · 12
R reports
KPI Configuration Detail page · 23
S Scorecard Configuration Detail page
using · 25 Scorecards Page
using · 15 Search page
using · 50 Single Scale example · 32 sparklines · 16, 23 System Configuration Detail page · 27
T Trend Line - Future Data
example · 29 Trend Line Type - Interpolated
example · 30 Trend Line Type - Interpolated + Symbol
example · 31 Trend Line Type - Step
example · 30 Trend Line Type - Symbol
example · 30 Trend Line Type Step + Symbol - None
example · 31 Trend page
Future Date · 29 No Actual data in selected range · 29 Scrolling · 29 using · 29
Trend Scale Type – Multi-Scale example · 32
Trend Scale Type – Single Scale example · 32
U URL
using · 26, 27 Visual KPI Components
Visual KPI Database · 9 Visual KPI Server · 9 Visual KPI Server Manager · 9 Visual KPI Website · 9
Visual KPI website navigating · 11
Visual KPI Website · 11
W Website
Ad Hoc Trend page · 33 Bar Charts page · 47 Custom Ranges page · 52 Defined Ranges page · 51 Filter & Grouping Page · 17 Home Page · 13 KPI Configuration Detail page · 23 KPI Map Detail page · 22 KPI Map Page · 18 KPI Page · 16 Map Detail page · 22 menu system · 11 Scorecard Configuration Detail page · 25 Scorecards Page · 15 Search page · 50 Trend page · 29 View Configuration Detail page · 26, 27
window size web pages auto adjust · 12
Using Mobile KPI
Adding Visual KPI Pages to your Favorites
Portrait and Landscape Views
Links and Trends on the Visual KPI Website
Site Links & Trends Page
Using the Home Page
Using the Scorecards Page
Using the KPI Page
Using the KPI Map Page
Using the KPI Map Detail Page
Using the KPI Configuration Detail Page
Using the Manual Entry Page
Entering KPI Values Using the Visual KPI Website
Using the Scorecard Configuration Detail Page
Using the View Configuration Detail Page
Using the System Configuration Detail Page
Using the Trend Page
Using Calculations in an Ad Hoc Trend
Using an Ad Hoc Trend Offset
Building an Ad Hoc Trend Page
Using Interactive Trends
Changing the Active Y Axis Scale On A Trend
Zooming In A Trend
Using Export to CSV
Using the Bar Charts Page
Using the Search Page

visual kpi mobile user's guide

Documents