FactoryKPIsTM for iOS - Software Toolbox2.3 U SING F ACTORY KPI S ... xConnect using 3G/4G or Wi-Fi – works with VPNs - no need to be out of touch with your manufacturing operationsftp.softwaretoolbox.com/.../FactoryKPIs_User_Guide.pdf ·

www.factorykpi.com User and Administrator’s Guide

FactoryKPIsTM Page | i

FactoryKPIsTM for iOS®

User and Administrator’s Guide

©APEX Software Development 2009-2012

Software Toolbox and logo are trademarks of Software Toolbox, Inc. FactoryKPIs name, logo, and Apex Software Development logo are trademarks of ApexSoftware Development, LLC.

Brought to you by Software Toolbox Developed by APEX Software Development


FactoryKPIsTM Page | ii

Table of Contents

1 INTRODUCTION ............................................................................................................................................................. 1

2 GETTING STARTED WITH FACTORYKPIS ......................................................................................................................... 1

2.1 FACTORYKPIS FOR IOS OVERVIEW................................................................................................................................... 12.2 INSTALLING FACTORYKPIS ............................................................................................................................................. 32.3 USING FACTORYKPIS.................................................................................................................................................... 3

2.3.1 FactoryKPIs Basics ........................................................................................................................................ 32.3.2 Navigating the FactoryKPIs App .................................................................................................................... 62.3.3 Metric Types ................................................................................................................................................. 7

2.3.3.1 Value Display ................................................................................................................................................ 72.3.3.2 State Display ................................................................................................................................................. 72.3.3.3 Goal Display .................................................................................................................................................. 72.3.3.4 Message Display ............................................................................................................................................ 72.3.3.5 Elapsed Time Display ..................................................................................................................................... 7

2.3.4 Using the Demo Application .......................................................................................................................... 82.3.4.1 Production Rate KPI....................................................................................................................................... 92.3.4.2 Browse to a User-Defined Web-link ..............................................................................................................102.3.4.3 Get Notified of Manufacturing Events ...........................................................................................................102.3.4.4 Sharing Manufacturing KPis by Email ............................................................................................................17

2.4 CONFIGURING FACTORYKPIS ........................................................................................................................................ 182.4.1 Features and Functions Common to all KPIs and Metrics ............................................................................. 18

2.4.1.1 FactoryKPIs App Settings ..............................................................................................................................182.4.1.2 KPIs..............................................................................................................................................................282.4.1.3 Metrics ........................................................................................................................................................46

2.4.2 Manually Configuring FactoryKPIs............................................................................................................... 582.4.2.1 Value Display ...............................................................................................................................................582.4.2.2 State Display ................................................................................................................................................592.4.2.3 Goal Display .................................................................................................................................................602.4.2.4 Message Display ...........................................................................................................................................632.4.2.5 Elapsed Time Display ....................................................................................................................................64

3 SYSTEM REQUIREMENTS ............................................................................................................................................. 65

3.1 KPISERVER REQUIREMENTS ......................................................................................................................................... 653.2 IOS DEVICE REQUIREMENTS......................................................................................................................................... 66

4 KPISERVER ................................................................................................................................................................... 66

4.1 INSTALLING THE KPISERVER ......................................................................................................................................... 674.1.1 Installing KPIServer ..................................................................................................................................... 684.1.2 Upgrading KPIServer from a Previous Version ............................................................................................. 71

4.2 REGISTERING YOUR FACTORYKPIS (LICENSING) ................................................................................................................. 714.3 CONFIGURING THE KPISERVER...................................................................................................................................... 75

4.3.1 KPIServer Configurator Menu Options ......................................................................................................... 764.3.2 Managing Users and Assigning Passwords .................................................................................................. 78

4.3.2.1 Manage Users ..............................................................................................................................................78


FactoryKPIsTM Page | iii

4.3.2.2 Passwords ....................................................................................................................................................784.3.2.3 Delete all Notifications .................................................................................................................................79

4.3.3 Managing, Adding, and Deleting Historian-based Data Sources................................................................... 804.3.3.1 Testing a Data Source ...................................................................................................................................814.3.3.2 Testing a Tag ................................................................................................................................................814.3.3.3 Editing a Tag ................................................................................................................................................824.3.3.4 Importing and Exporting Tags .......................................................................................................................83

4.3.4 Managing, Adding, and Deleting OPC-based Data Sources .......................................................................... 864.3.4.1 Testing a Data Source ...................................................................................................................................874.3.4.2 Testing a Tag ................................................................................................................................................874.3.4.3 Editing a Tag ................................................................................................................................................874.3.4.4 Adding a Tag ................................................................................................................................................894.3.4.5 Importing and Exporting Tags .......................................................................................................................90

4.3.5 Assigning FactoryKPI Metrics User Licenses ................................................................................................. 934.3.5.1 Using Concurrent Licensing Mode .................................................................................................................944.3.5.2 Using SeatLicensing Mode ............................................................................................................................944.3.5.3 Using Mixed Licensing Mode ........................................................................................................................96

4.3.6 Designating a Server Port (if necessary) ...................................................................................................... 984.3.7 Managing FactoryKPI Configurations .......................................................................................................... 984.3.8 Stopping and Starting Service ................................................................................................................... 1014.3.9 Checking for Updates ................................................................................................................................ 101

5 TROUBLESHOOTING .................................................................................................................................................. 102

5.1 FACTORYKPI ERROR MESSAGES .................................................................................................................................. 1025.2 TESTING CONNECTIONS IN KPISERVER CONFIGURATOR ..................................................................................................... 104

5.2.1 Testing Data Sources ................................................................................................................................ 1045.2.2 Testing Tags ............................................................................................................................................. 104

5.3 CONTACTING SUPPORT ............................................................................................................................................. 1055.3.1 Software Toolbox Support ......................................................................................................................... 105

6 DOCUMENT REVISION HISTORY ................................................................................................................................ 106

APPENDIX A – LICENSING AGREEMENT ............................................................................................................................ 106


FactoryKPIsTM Page | 1

1 INTRODUCTION

Whether you’re in the office, walking the plant floor, or traveling the globe - anywhere you can connect to theinternet - you can monitor your manufacturing operations with FactoryKPIs™ for iOS®.

FactoryKPIs™ on Apple® iPad®, iPad® mini, iPhone®, and iPod® touch devices deliver easy-to-read, near real timedata, such as production rates, energy usage, goal progress, yield, safety, lab, quality, and asset utilization— toname just a few. Below are key FactoryKPIs for iOS features and benefits:

Always with you on your iOS device – no need to be tethered to a computerAt-a-glance KPIs and Metrics – minimizes information overload and helps you react quicklyAffordable pricing – starter systems are usually well below capital expenditure approval levelsConnects to your OPC and Wonderware Historian data sources locally and throughout your enterprise –monitor your manufacturing KPIs wherever they are, from wherever you areConnect using 3G/4G or Wi-Fi – works with VPNs - no need to be out of touch with your manufacturingoperationsFactoryKPI metrics alert you to conditions requiring your attention, using standard iOS notificationsounds, vibrations, banners, alerts, and the Notification Center – no need to constantly keep your eyeson KPIsConfigurable units of measure and text on each FactoryKPI metric – your information in your termsConfigurable color behavior on each FactoryKPI metric - it’s easy to see changes at a glanceFactoryKPI metrics link to any content accessible by Safari, such as reports, dashboards,maintenance/repair procedures, and HMI screens – leverage your installed data sources and make KPIsaffordably available to more decision-makersFactoryKPIs are read-only – no unexpected process setting changesDisplays the calculations in your existing systems – no redundant calculations or alteration of your dataFactoryKPIs update at user-specified intervals - minimizes your network traffic and data plan chargesSimple, centrally-managed licensing – makes IT administrators’ and managers’ jobs easierUniversal iOS app and KPIServer app are easy to set up - you can be viewing your manufacturing KPIsand taking optimization measures in minutes – fast ROI

2 GETTING STARTED WITH FACTORYKPIS

2.1 FactoryKPIs for iOS Overview

FactoryKPIs for iOS is a free app downloaded from the iOS App Store. Upon installation, as long as your devicehas Internet access, it will automatically connect to, and display data from, a, secure, remote, demo-only,simulated manufacturing data source, called KPIServer™.

FactoryKPIs for iOS get their data from KPIServer, which, for your actual pilot test or production use, ispurchased separately from Software Toolbox at www.factorykpi.com or from your local Software Toolboxdistributor. No-charge, trial versions are also available. The iOS app itself is always free, and can be installed on

http://www.factorykpi.com/



as many iOS devices as you like. They can connect simultaneously to the demo KPIServer as well as to yourinstalled KPIServers. The KPIServer, in turn, gets its information from your OPC-accessible datasources and/orthe Wonderware Historian.

FactoryKPIs for iOS is the newest addition to our manufacturing KPI software family, succeeding our firstproduct, FactoryWidgets® for Windows. FactoryKPIs for iOS provide even more value and functionality than theWindows version, while meeting the pent-up demand for useful and affordable Mobile Manufacturing Metrics.

Future products designed for Apple iOS, OS X, and Microsoft Windows-based platforms will also utilize theKPIServer.



2.2 Installing FactoryKPIs

From your iOS device, open App StoreSearch for “FactoryKPI” or “FactoryKPIs”Follow App Store instructions to install

2.3 Using FactoryKPIs

Note: The illustrations in this guide show iPad screenshots. Landscape and portrait orientation views on iPhoneand iPod touch will differ according to their display sizes. However, functionality is identical for all compatible iOSdevices.

2.3.1 FactoryKPIs Basics

The downloaded app installs to the iOS device’s Multi-Touch Display like any other iOS application.

Downloaded FactoryKPIs app installed on iPad Multi-Touch Display

KPIs, which can consist of up to five metrics, are shown in the KPI List in the left-hand window. Its metrics aredisplayed in The Metric Field on the right. A metric can be used in as many different KPIs as desired.



Unpopulated KPI List and Metric Field on iPad - landscape view



The figure below shows an app configured with four KPIs in the KPI List. In this example, the bottom-most KPI’smetrics are in view. The top metric of a KPI is called the Designated Metric, and it represents the KPI in the KPI

List. Tapping on a KPI in the KPI List shows its metrics in the Metric Field. A selected KPI has a symboldisplayed on it.

Each KPI can be assigned a unique title.

A selected KPI's metrics in view in the Metric Field



2.3.2 Navigating the FactoryKPIs App

Add KPIs – tap “+”Remove KPIs from KPI List – tap “Edit” or swipe left in a Designated MetricTo see all KPIs in the KPI List – Scroll up or down with one or more fingersManual refresh – tap refresh iconView version number, support link, and contact info - tap “Info” iconConfigure KPIs and Metrics – tap “settings” icon or swipe up in Metric FieldRemove a metric from Metric List – swipe leftSend selected KPI’s metrics’ data via Email – tap “Share” iconBrowse to a web-page – double-tap a metric that has been configured to display a web-page

Not shown:

To set app Refresh Rate – go to device “Settings”, tap FactoryKPIs icon and select desired settingTo enable and configure app notifications - go to device “Settings”, select “Notifications”, tapFactoryKPIs icon and select desired settings.



2.3.3 Metric Types

2.3.3.1 Value Display

The Value Display displays manufacturing andprocess data. It changes background text colorsaccording to configurable data threshold levels.

2.3.3.2 State Display

The State Display displays the on/off state of acomponent or system. It changes colors and textaccording to the state.

2.3.3.3 Goal Display

The Goal Display displays manufacturingand process data. It shows performanceversus a goal. The progress bar changescolor according to configurable datathreshold levels.

2.3.3.4 Message Display

2.3.3.5 Elapsed Time Display

The Message Display displays dynamicmanufacturing and process text messages.

The Elapsed Time Display displays totalelapsed time of manufacturing or processsteps. Timing starts, stops, resumes, andresets based on state changes of discreteevents.



2.3.4 Using the Demo Application

If this is your first use of the downloaded app, tapping on the FactoryKPIs icon will open the demo app to a pre-configured view of manufacturing KPIs and an empty Metric Field.

The KPIs and metrics will automatically connect to a demo-only KPIServer on a remote server.

The top three KPIs demonstrate some practical uses of KPIs and their metrics. The “Intro to FactoryKPIs” willopen a list of metrics, each having a link to a relevant section in the online User and Administrator’s Guide.

iPad view of first launch of FactoryKPIs app



iPhone view of first launch of FactoryKPIs app

2.3.4.1 Production Rate KPITapping the “Production Rate” KPI will display its associated metrics. In this case, all five metric types are shown.They will refresh (update) every five seconds.

A selected KPI and its five metrics in view - iPad



2.3.4.2 Browse to a User-Defined Web-linkDouble-tapping the “Production Rate” or “Plant Status” metrics will launch Safari and browse to a samplemanufacturing report published to a web-page. Note: your existing manufacturing software, such as HMI, EMI,dashboards, portals, or other reporting systems provides actual published reports.

If your company has no current reporting/publishing systems in place, Software Toolbox has affordable solutionsthat enable this functionality. Go to www.softwaretoolbox.com or contact [email protected] tolearn more.

See example below:

Production report published by existing MES System

2.3.4.3 Get Notified of Manufacturing EventsFactoryKPI metrics can alert you to conditions requiring your attention, using standard iOS notification sounds,vibrations, banners, alerts, and the Notification Center. To test this functionality, do the following:

Select the “Plant Production Metrics” KPI by tapping on its Designated Metric, “Plant Production Status”in the KPI ListSwipe up in the Metric Field

http://www.softwaretoolbox.com/

mailto:[email protected]



Tap Metric5: “State: Plant Status”

The monitored tag, “Asset4”, will change state every few minutesTap “Notifications”



Tap “Enabled” to set notification to “ON”Tap “Notify When State is” to set to “OFF”

Exit FactoryKPIs for iOS app:o Tap “State Settings”o Tap “KPI Settings”o Tap “Done”

Tap “Settings” icon on Multi-Touch Display



Tap “Notifications” – on first use, FactoryKPIs will not be in the Notification Center

Scroll to, and tap on, “FactoryWidgets” – on first use, Notifications will be unconfigured

Arrows point to notifications type behavior



Select the notification behavior you prefer



Press the device “Home” button and return to the Multi-Touch Display, or open another app. Dependingon how you configured notifications, when “Plant Status” changes to “off” one of the followingnotifications types will display:

Tapping on a visible banner will launch the FactoryKPIs app

Alerts require you to tap "Close" or “Launch” to proceed



Notification Center showing last 5 notifications

Note: Notifications are intended to be convenient general indicators of your manufacturing status. They arenot to be relied upon as your only indication of your manufacturing process conditions.



2.3.4.4 Sharing Manufacturing KPis by EmailSelect a KPI so that it’s metrics are in view in the Metric Field

Tap the button in the upper right corner

Your device’s default Mail account will launch and automatically contain a text “snapshot” of theselected KPI

Standard email functionality – you can edit and annotate before sending



2.4 Configuring FactoryKPIs

Each FactoryKPI installed on your device is easy and fast to configure. During configuration, there arecustomizable features to enable each KPI and metric to display data in the way that makes sense to you andyour business. You can save KPIs and metrics for reuse by yourself and others.

2.4.1 Features and Functions Common to all KPIs and Metrics

2.4.1.1 FactoryKPIs App Settings

2.4.1.1.1 Refresh RateAll FactoryKPIs and their metrics update at the same rateTap “Settings” icon on Multi-Touch Display



Scroll to FactoryKPIs in the Settings list

Tap “Refresh Rate”Select an automatic refresh rate

If “Manual Refresh Only” is selected, KPIs and Metrics will refresh only when is pressed



Refresh rates can also be configured to switch to “Manual Only After” a specific number of automatic refreshesoccur.

Scroll to FactoryKPIs in the Settings listTap “Manual Only After”Select the number of automatic refreshes to occur before switching to manual refreshing



2.4.1.1.2 NotificationsNotifications are configured for the app in in your device’s “Settings” and enabled in individual metrics.

Notifications will display the title, alert triggering condition, and the time and date of the alert.

To configure the app for Notifications:

Tap “Settings” icon on Multi-Touch Display

Tap “Notifications” – on first use, FactoryKPIs will not be in the Notification Center



Scroll to, and tap on, “FactoryWidgets” – on first use, Notifications will be unconfigured

Arrows point to notifications type behavior

Select the notification behavior you prefer



2.4.1.1.3 KPIServer Connecting to Manufacturing Data SourcesFactoryKPIs for iOS get their manufacturing data from one or more KPIServers.

Different KPIs and metrics on the same device can connect to different servers and datasources. A single KPI canget data from up to five separate (one per metric) KPIServers throughout your manufacturing enterprise.

2.4.1.1.3.1 Adding new KPIServer ConnectionAdding new KPIServers to the iOS app can be accomplished in either the KPI or metrics popovers. This exampleshows the KPI popover.

In the Metric Field, swipe up or tap settings button to call bring the configuration popover in view.Tap either “Load KPI Settings” or “Save KPI Settings”

Adding new servers can be done from any KPI or metric configuration popover.



Tap “+”

Add a friendly/arbitrary name for the KPIServerAdd the name of the computer or IP address of the computer where the KPIServer is installed andconfigured. See Section 4.1 for KPIServer installation/configuration instructions.Add username and password that matches those configured on the KPIServer. See Section 2.4.1.2.3.4for FactoryKPIs password configuration on your iOS device.



2.4.1.1.3.2 Editing an existing KPIServer ConnectionEditing existing KPIServers in the iOS app can be accomplished in either the KPI or metrics popovers. Thisexample shows the KPI popover.

In the Metric Field, swipe up or tap settings button to call bring the configuration popover in view.Tap either “Load KPI Settings” or “Save KPI Settings”Tap “Edit”Select the server to be editedEdit “Server Name” to reflect the IP address or computer name where the KPIServer is installed andconfigured.

Note: all KPIs and metrics using the new Server Name will be connected to that server. To direct differentmetrics in the same FactoryKPI to different KPIServers, simply choose one from the Select Server popover.

2.4.1.1.4 Using FactoryKPIs with VPNIf access to your company’s KPIServers require using a VPN, below is an example iOS VPN configuration.

Note: Consult with your IT administrator for the configuration required for your infrastructure.







2.4.1.2 KPIs

2.4.1.2.1 Configuring new and existing FactoryKPIs

New - Tap “+” in the upper right corner of the KPI List to call up the FactoryKPIs configuration menu.Existing – swipe up or tap settings button in the Metric Field

Enter a title – it will appear in the title bar of that KPI’s Metric Field.



Set the background color



2.4.1.2.2 Loading saved FactoryKPI

Tap “+” in the upper right corner of the KPI ListTap “Load KPI Settings”

Tap “Server”



Select a KPIServer (if not in the list, enter the name, or IP address, of the computer where theKPIServer is installed in the “Server Name” field)

Select a KPI and tap “Finish”

Tap “Done” – the KPI and its metrics will be added to the KPI List and Metric Field



2.4.1.2.3 Configuring KPI for the first time

Tap “+” in the upper right corner of the KPI List to call up the FactoryKPIs configuration menu.

Tap an unconfigured metric



Select a metric type

A metric can be configured manually or loaded from a saved configuration



2.4.1.2.3.1 Manual metric configuration

See Section 2.4.2 for complete instructions for each metric type

Unconfigured State Display metric

2.4.1.2.3.2 Loading saved metric to KPI

Tap an unconfigured metric

Select a metric type



Tap “Load Settings”



Tap “Server” then “Next”

Select a saved metric then tap “Finish”



Tap “KPI Settings”

Tap “Done”



Your new KPI is created. To add more metrics from this view, touch a blank “Tap to Add Metric” metric,repeat the above instructions until you have configured the KPI with as many metrics, up to five, as youprefer.

2.4.1.2.3.3 Deleting KPIsThere are two ways delete KPIs from the iOS device. (Saved KPIs can be easily restored using the Loadprocedures described above.) Note: if the KPI has been saved to a KPIServer, it can be reloaded to the device.

Tap “Edit” at the upper left of the KPI List

Tap the radio button for the KPI to be deleted, the red “Delete” button, and then “Done”



Or

Swipe left or right on the KPI to be deleted, then tap the red “Delete” button



2.4.1.2.3.4 PasswordsIn order for KPIs and metrics to display data from KPIServer(s) each must be configured to match a usernameand password that has been set-up on the KPIServer(s) being accessed.

2.4.1.2.3.4.1 Changing or entering KPI password

Swipe up in the Metric Field, or tap the settings iconTap “Load KPI Settings”



Tap “Server”

Select the KPIServer you wish to access, then tap “Edit”



Edit the Username and Password to match the username/password configured on the associatedKPIServer.

Tap “Done”, “Load Settings”, “KPI Settings”, then “Done”



2.4.1.2.3.5 Saving KPIsKPis’ configurations can be saved to a KPIServer for reuse by yourself and others.

Swipe or tap the settings button to edit a FactoryKPITap “Save KPI Settings”

If the correct server is already selected, then tap “Next”, otherwise tap “Server”



Select the server to which you wish to save the KPI, then tap “Save Settings”, “KPI Settings”, and “Next”

Enter a name for the KPI, an optional description, and then tap “Save”



Go to “Load KPI Settings” to verify your KPI was saved.



2.4.1.3 Metrics

2.4.1.3.1 Color Configuration

All FactoryKPIs metrics have color attributes, some static, and some dynamic, that can be configured.

Swipe up or tap the settings button on the Metric Field title bar, then tap on a color “swatch” of a metric

Dynamic color behavior of a State Display – Metric and text color change according to the state of the tag being monitored



Tap a solid color on the list on the right, and then adjust the hue and shade sliders for the desired colorof the metric or text.

Color configuration is common to all KPIs and metrics

Value Display metrics/text and Goal Display progress bars change color at configurable values



2.4.1.3.1.1 PasswordsIn order for KPIs and metrics to display data from KPIServer(s) each must be configured to match a usernameand password that has been set-up on the KPIServer(s) being accessed.

2.4.1.3.1.1.1 Changing or entering metric password

Swipe up in the Metric Field, or tap the settings button, and select a metric to configureTap “Server”



Select the KPIServer you wish to access, then tap “Edit”



Edit the Username and Password to match the username/password configured on the associatedKPIServer.

Tap “Done”, “Load Settings”, “KPI Settings”, then “Done”



2.4.1.3.1.2 Configuring Tagnames

All metrics display data contained in “tags” configured in a KPIServer.

Open a metric for editing/configurationSelect the Server on which the tag is configuredEnter the name of the Datasource where the tag is configuredEnter the Alias or fully qualified name of the tag as configured in the Datasource on the KPIServer.

2.4.1.3.1.3 User-defined Web LinkDouble-tapping a metric with a configured user-defined Web Link (URL) will launch Safari and open abrowseable web page. Common uses include browsing to a corporate portal, maintenance or repairinstructional pages, viewing web-based HMIs, and manufacturing reports published to a web pages.

Note: your existing manufacturing software, such as HMI, EMI, dashboards, portals, or other reporting systemsprovides the actual published reports.



If your company has no current reporting/publishing systems in place, Software Toolbox has affordable solutionsthat enable this functionality. Go to www.softwaretoolbox.com or contact [email protected] tolearn more.

2.4.1.3.1.3.1 Configuring Web LinkSelect a metric to edit/configureTap “http://” to select Web Link ProtocolEnter the URL to which the metric will browse when double-tapped.

http://www.softwaretoolbox.com/




See example below:

Production report published by existing MES System



2.4.1.3.1.4 Saving MetricsMetrics’ configurations can be saved to a KPIServer for reuse by yourself and others.

Swipe or tap the settings button to edit/configure a metricSelect the KPIServer to which the metric will be saved

If the correct server is already selected, then tap “Next”, otherwise tap “Server”



Select the server to which you wish to save the metric, then tap “Save Metric Settings”, and “Next”

Enter a name and optional description of the metric to be saved, then tap “Save”



Go to “Load Metric Settings” to verify that your metric was saved.



2.4.1.3.1.5 Deleting metricsMetrics can be removed from a KPI. Note: if the metric was previously saved to a KPIServer, it can be reloadedto the device.

Swipe a metric in the Metric Field from right-to-left, then tap the “Delete” Button

Or

Open a KPI in the edit/configure mode, swipe the metric o be removed, then tap the “Delete” button



2.4.2 Manually Configuring FactoryKPIs

2.4.2.1 Value Display

The Value Display displays manufacturingand process data in real time. It changesbackground and text colors according toconfigurable data threshold levels.

Settings Menu

Load Settings Select to load saved metrics.

Save Settings Select to save a configured metric.

Server Select your server Friendly Name.

Title Enter the title you have selected for this metric.

User-defined Web Link Select the appropriate protocol, and then enter a URL to which you would like to link from thismetric.

Note that because you have selected the protocol in the picker, you do not have to enter thatagain as part of the Web address.

When the metric is running on your device, double-tap on it to browse to the link you defined.Datasource Enter a data source name here as it appears in the KPIServer Configurator. Double-check for

misspellings if you receive an “invalid” error upon entry.Port (on Select Server

menu)This is the TCP/IP port number on which the KPIServer is listening. The default is 4700. Youshould only change the port number here if you have changed the default on the KPIServer.

Tagname Enter your tagname. It must be an alphanumeric value. If you created an Alias for your tags in theKPIServer Configurator, you can enter that here. Note that the Alias as entered in the KPIServerConfigurator is case-sensitive.

Double-check for misspellings if you receive an “invalid” error upon entry.Notifications Enable or disable notifications for this metric. Set the logical conditions (=, ,<, or > entered

value) for which a notification will occur. To minimize nuisance alerts, enable Deadband, selectType, and the value or percentage deviation from the notification value.

Unit of Measure Enter any unit of measure you require for the data you are tracking (EUs, units, %, etc.).

Display Value Format Select the decimal format you want the metric to recognize and use for your data values.

Color Configuration

Use the color picker to set the value limits, and the text and background color of the metric when the valueexceeds or drops below the specified limit. You can enter positive and negative value limits. The highest valuemust be in the High High limit field, the next highest value must be in the High limit field, and so on, with thelowest value being in the Low Low limit field.

High High



Text Click inside the text color box to display the color-picker. Select the color of text you would liketo display on the metric when it is at or above the “High High” level.

Metric Background Select the color you would like the metric background to display when it is at or above the“High High” level.

Limit Enter a limit. When the data source value exceeds this threshold value, the metric changes textand background color according to the settings you have indicated for this “High High” limit.

High

Text Click inside the text color box to display the color-picker. Select the color of text you would liketo display on the metric when it is at or above the “High” level.

Metric Background Select the color you would like the metric background to display when it is at or above the“High” level.

Limit Enter a limit. When the data source value exceeds this threshold value, the metric changes textand background color according to the settings you have indicated for this “High” limit.

Normal

Text Click inside the text color box to display the color-picker. Select the color of text you would liketo display on the metric when it is at or above the “Normal” level.

Metric Background Select the color you would like the metric background to display when it is at the “Normal”level.

Low

Text Click inside the text color box to display the color-picker. Select the color of text you would liketo display on the metric when it is at or below the “Low” level.

Metric Background Select the color you would like the metric background to display when it is at or below the“Low” level.

Limit Enter a limit. When the data source value drops below this threshold value, the metric changestext and background color according to the settings you have indicated for this “Low” limit.

Low Low

Text Click inside the text color box to display the color-picker. Select the color of text you would liketo display on the metric when it is at or below the “Low Low” level.

Metric Background Select the color you would like the metric background to display when it is at or below the “LowLow” level.

Limit Enter a limit. When the data source value drops below this threshold value, the metric changestext and background color according to the settings you have indicated for this “Low Low” limit.

2.4.2.2 State Display

The State Display displays the on/offstate of a component or system in realtime. It changes color according to thestate.

Settings Menu







User-defined Web Link Select the appropriate protocol, then enter a URL to which you would like to link from thismetric.






Double-check for misspellings if you receive an “invalid” error upon entry.Notifications Enable or disable notifications for this metric. Set the condition (ON or OFF) for which a

notification will occur.On State Text Enter the text to display on the metric when the tag is on.

Off State Text Enter the text to display on the metric when the tag is off.

Color Configuration

Use the color picker to set the background and text colors of the State Display for “on” and “off” states.

On State

On State Text Color Click inside the text color box to display the color-picker. Select the color of text you would liketo display on the metric when it is on.

On State BackgroundColor

Select the color you would like the metric background to display when it is on.

Off State

Off State Text Color Click inside the text color box to display the color-picker. Select the color of text you would liketo display on the metric when it is off.

Off State BackgroundColor

Select the color you would like the metric background to display when it is off.

2.4.2.3 Goal Display

The Goal Display displays manufacturingand process data in real time. It showsperformance versus a goal. The progressbar changes color according toconfigurable data threshold levels.



Settings Menu










Tagnames Enter your tagnames for the displayed variable and server-based setpoint, if enabled. They mustbe alphanumeric values. If you created an Alias for your tags in the KPIServer Configurator, youcan enter that here. Note that the Alias as entered in the KPIServer Configurator is case-sensitive.

Double-check for misspellings if you receive an “invalid” error upon entry.Notifications Enable or disable notifications for this metric. Set the Goal progress’ logical conditions (=, ,<,

or > entered value) for which a notification will occur. To minimize nuisance alerts, enableDeadband, select Type, and the value or percentage deviation from the notification value.

Unit of Measure Enter any unit of measure you require for the data you are tracking (EUs, units, %, etc.).

Display Value Format Select the decimal format you want the metric to recognize and use for your data values.

Display Goal Format Select the decimal format you want the metric to recognize and use for your data values.

Setpoint Type Indicate what kind of Goal Display setpoint you are using by selecting Server Tag or Manual.

Then enter the appropriate Goal setpoint. If using a server tag, the setpoint will be a setpointtagname. If using a manual Goal setpoint, the value may be positive or negative.

Display Goal This checkbox is set “ON” by default. You can set to “OFF” if you do not want to show the GoalDisplay setpoint when the metric is running.

Color Configuration

Use the color picker to set the background colors for the metric and the progress bar, and the value limits of theprogress bar when the value exceeds or drops below the specified limit. You can enter positive and negativevalue limits. The highest value must be in the High High limit field, the next highest value must be in the Highlimit field, and so on, with the lowest value being in the Low Low limit field.

Static Colors



Text Click inside the text color box to display the color-picker. Select the color of text you would liketo display on the metric. Once you have selected a color, it displays in the text box.

Progress Background Select the color you would like the progress bar background to display.Metric Background Select the color you would like the metric background to display.

Dynamic Colors

High High

Progress Select the color you would like the progress bar to display when it is at or above the “HighHigh” level.

Limit Enter a limit. When the data source value exceeds this threshold value, the metric changesprogress bar color according to the settings you have indicated for this “High High” limit.

High

Progress Select the color you would like the progress bar to display when it is at or above the “High”level.

Limit Enter a limit. When the data source value exceeds this threshold value, the metric changesprogress bar color according to the settings you have indicated for this “High” limit.

Normal

Progress Select the color you would like the progress bar to display when it is at or above the “Normal”level.

Limit Enter a limit. When the data source value exceeds this threshold value, the metric changesprogress bar color according to the settings you have indicated for this “Normal” limit.

Low

Progress Select the color you would like the progress bar to display when it is at or below the “Low”level.

Limit Enter a limit. When the data source value drops below this threshold value, the metric changesprogress bar color according to the settings you have indicated for this “Low” limit.

Low Low

Progress Select the color you would like the metric background to display when it is at or below the “LowLow” level.

Limit Enter a limit. When the data source value drops below this threshold value, the metric changesprogress bar color according to the settings you have indicated for this “Low Low” limit..



2.4.2.4 Message Display

The Message Display displaysmanufacturing and process text messages.Messages can be fixed or dynamic.

Settings Menu










Double-check for misspellings if you receive an “invalid” error upon entry.Notifications Enable or disable notifications for this metric. The notification can be configured to occur when

the message does (or does not) contain a configured string found in any position in the messagetag. It is case sensitive.

Color Configuration

Text Click inside the text color box to display the color-picker. Select the color of text you would liketo display on the metric.

Metric Background Select the color you would like the metric background to display.



To display dynamic data values in a fixed text message, the Message Display can dislay a message generated by ascript instruction from a control system, HMI or PLC software.

For example, the following is a script from Wonderware InTouch HMI software:

MessageTagName = “Current plant OEE is “ + TEXT(KPI_OEE, “#”) + “%”;

MessageTagName is the name of a message tag defined in InTouch.KPI_OEE is an analog tag also defined in InTouch that contains the calculated value of overallequipment effectiveness (OEE).This script displays the fixed text (“Current plant OEE is “ and “%”), converts the numerical value ofKPI_OEE to text, displays it in integer format, concatenates it to the fixed text message.The value of KPI_OEE updates dynamically and is embedded in the fixed text message.

By using the MessageTagName as the tagname in the Data Source tab when configuring Message Display, theFactoryKPITM displays ”Current plant OEE is ##%” with the OEE value updating when the value is updated inInTouch.

2.4.2.5 Elapsed Time Display

The Elapsed Time Display displays total elapsedtime of manufacturing or process steps. Timingstarts, stops, resumes, and resets based onstate changes of discrete events.

Settings Menu









Time while / is Enter a tagname. It must be an alphanumeric value. If you created an Alias for your tags in theKPIServer Configurator, you can enter that here. Note that the Alias as entered in the KPIServerConfigurator is case-sensitive.

Double-check for misspellings if you receive an “invalid” error upon entry.



Select True from the selector. This indicates that you want the metirc to time the period whenthe data associated with this tagname is running (true). Or conversely, select False to time whenthe data associated with the tagname is stopped (false).

Reset when /transitions to

Enter a tagname. It must be an alphanumeric value. If you created an Alias for your tags in theKPIServer Configurator, you can enter that here. Note that the Alias as entered in the KPIServerConfigurator is case-sensitive.

Double-check for misspellings if you receive an “invalid” error upon entry.

Select True from the selector. This indicates that you want the metric to reset the Elapsed TimeDisplay when the data associated with this tagname transitions from stopped (false) to running(true). Or conversely, select False to reset the Elapsed Time Display when the data associatedwith the tagname transitions from running (true) to stopped (false). This parameter is optional.

Notifications Enable or disable notifications for this metric. The notification can be configured to occur whenthe message does (or does not) contain a configured string found in any position in the messagetag. It is case sensitive.

Color Configuration

Text Click inside the text color box to display the color-picker. Select the color of text you would liketo display on the metric.

Metric Background Select the color you would like the metric background to display.

Note: All Elapsed Time Displays that use the same “Time while” and “Reset when” tags and states, areconsidered to be the same Elapsed Time Display. All users of the same Elapsed Time Display on that KPIServerwill view identical elapsed times on their respective devices.

3 SYSTEM REQUIREMENTS

To install and run FactoryKPIs, your system must meet the following requirements.

3.1 KPIServer Requirements

Note: KPIServer is the server-based component that connects FactoryKPIs on iOS devices to your manufacturingdata sources. It was formerly called “WidgetServer”. Some illustrations in this guide may still refer to theKPIServer by its former name. This guide will be updated in future versions to reflect the current name.

.NET Framework 3.5 SP1Access to Wonderware Historian (InSQL) 9.0 or higher and/or OPC serversOperating systems:

o Windows Server 2003, Windows Server 2008, Windows Server 2008 r2, Windows Server 2012o Windows XP Pro SP3, Windows Vista Business, Windows Vista Enterprise, Windows Vista

Ultimate, Windows 7 Professional, Windows 7 Ultimate, Windows 8*30 MB disk space to install and store configuration files



50 MB free memory not in use by operating system or other applications

* If you run the KPIServer on a Windows desktop class operating system, the operating system may limit the number ofconcurrent network connections to the KPIServer to 10, which may limit the number of FactoryKPI metrics connected to theKPIServer at one time to 10. Run the KPIServer on a supported server class operating system to avoid these operatingsystem-imposed limitations.

3.2 iOS Device Requirements

iPad, iPhone, or iPod touch with 3G/4G or Wi-FiiOS 5.0 or newer

Note: Illustrations in this User Guide show screenshots from an iPad. iPhone and iPod touch app functionality isidentical.

4 KPISERVER

Note: If you’ve downloaded FactoryKPIs for iOS and want to evaluate its functionality, using samplemanufacturing data, go to Section 2.3.

The KPIServer is a service that runs on a computer, connects to the Wonderware Historian and/or OPC datasources, and serves live data to FactoryKPI metrics. The KPIServer also manages the persistence (type, quantityused, user, etc.) of FactoryKPI metric instances and implements the FactoryKPI metric licensing.

Different KPIs and metrics on the same device can connect to different servers and datasources. A single KPIcan get data from up to five separate (one per metric) KPIServers in your manufacturing enterprise.

Note: This document assumes Historian or OPC data sources are alreadyinstalled and configured on your system. Configuring an OPC server isoutside the scope of this document, however, this Software Toolbox linkprovides resources and recommendations for DCOM, OPCEnum andOPCServer settings:

http://www.softwaretoolbox.com/dcom

http://www.softwaretoolbox.com/dcom



4.1 Installing the KPIServer

This section covers installing and configuring a KPIServer to connect to your manufacturing data sources. To seehow to configure FactoryKPIs to connect to a KPIServer, see Section 2.4.1.1.3

An installation wizard walks you through the steps to install the KPIServer. If this is the first time you haveinstalled the KPIServer, proceed now to section 4.1.1, Installing a New KPIServer.

If you have previously installed an earlier version of the WidgetServer/KPIServer, you will need to uninstall theprevious version before installing the new version.

If you need to uninstall the previous version, but try to install a new version without uninstalling, you will see anerror message similar to one of the following.

If you see this message, click OK and then proceed to section 3.1.2 to uninstall the previous version firstbefore upgrading to the new version.



4.1.1 Installing KPIServer

1. If you downloaded the installation file to your server, double-click the setup file, FactoryKPIs.msi(Windows Installer Package file), to install the KPIServer. If you received FactoryKPIs on a CD, the CD willplay automatically when inserted into your CD drive. (If it does not, click setup.exe from the rootdirectory of the CD.)

The installation program starts and the Welcome window appears.

2. Click Next. The end-user license agreement appears.



3. Review the agreement (you can click Print to print it), then check to accept the terms of the licenseagreement, and click Next. The Custom Setup window appears.

4. When you are ready to install, click Install. Installation may take a few minutes.



Firewall exception:

Click Next to complete the installation.

5. Click Finish.



Continue to the next section to register your FactoryKPI app, and then configure your FactoryKPI and metrics.

4.1.2 Upgrading KPIServer from a Previous Version

If you have previously installed an earlier version of the KPIServer, and you have determined that you mustuninstall the previous version before installing the new version, use these steps.

Windows Server 2008 users:

1. Go to the start menu, click Settings, click Control Panel, and then click Programs and Functions.2. Select FactoryKPIs KPIServer in the list of programs, and then click Uninstall.

Windows Server 2003 users:

1. Go to the start menu, click Control Panel, and click Add or Remove Programs.2. Select FactoryKPIs KPIServer from the list of programs, and then click Remove.

After removing the previous version, return to section 4.1.1 to follow those steps to install the new version.

4.2 Registering your FactoryKPIs (Licensing)

If you purchased the KPIServer in a download, you will receive an email with a serial number that you will needto “unlock” your FactoryKPIs in order to register and use them. If you received your KPIServer on a CD, the serialnumber is displayed on the front of the CD case, as well as being delivered by email (provided you supplied avalid email address when ordering).

Registering your FactoryKPIs is a quick, two-step process:Step one: Enter your serial numberStep two: Unlock and register FactoryKPIs

Step one: Enter your serial number

1. Open the License Manager by doing one of the following:

Open the KPIServer Configurator, go to the Help menu, and select License Manager.OR

Go to your start menu, click Programs (Windows XP, Windows Server 2003 and 2008) or AllPrograms (Windows Vista, Windows 7), click FactoryKPIs, and then click License Manager.

Note: If you are opening License Manager from the start menu on acomputer running Windows Vista, Windows 7, or Windows Server2008, and User Account Control (UAC) is enabled, right-click LicenseManager from the start menu > Programs > FactoryKPIs menu, andthen select Run as Administrator.



2. Select KPIServer from the License drop-down menu. Your computer ID number will appear in theComputer ID field.

3. Enter your serial number (provided in the download email) in the Serial Number field. Once the serialnumber is accepted, the other information boxes will clear for entry.



4. Enter your information in the personal information fields.

Step two: Unlock and register FactoryKPIs

1. Go to the Unlock and Register menu in the License Manager to unlock and register your FactoryKPIs.You can unlock and register FactoryKPIs automatically if you have Internet access, or you can unlock andregister manually from the Unlock and Register menu if you do not have Internet access.

2. For computers connected to the Internet, select Automatically via Internet. If you get a “success”message, you are now registered and can continue to the next section to configure your KPIServer.

If your registration did not go through successfully, or if your computer is not connected to the Internet,do the following:

a. Copy down your Computer ID and your Serial number as shown in the License Manager screen.b. Go to a computer this is connected to the Internet and go to (FactoryKPIs do not need to be installed

on this computer): http://registration.softwaretoolbox.comc. Click Register Now, then select FactoryKPIs from the list of products, and then complete the

registration form for FactoryKPIs. When you submit the form, your unlock code will display on-screen.

d. Record the code and return to the computer where you have the KPIServer installed.e. Open License Manager again, if it is not still open, go to the Unlock and Register menu, and select

Manually.

http://registration.softwaretoolbox.com/



f. Enter the code you just received online in the Unlock Code field. Make sure there are no extraspaces after the number in the field, and then click Register. You are now registered.

Note: If you still are unable to unlock and register your FactoryKPIs, click Helpin the License Manager to contact support, or [email protected].

Figure 1: Contact support

Note: For additional information about the license agreement, see the entireagreement in Appendix A of this document.




4.3 Configuring the KPIServer

After you have installed and registered the KPIServer, configure your KPIServer to serve data to the FactoryKPImetrics, to test your data sources, and to administer your FactoryKPIs to your users per your licensingarrangement.

Open the KPIServer, if it is not already open: go to the Windows Start menu, click Program or All Programs,click FactoryKPIs, and then click KPIServer Configurator. The KPIServer will open, showing the Data Sources

tab, and the KPIServer icon will display in your system tray ( ).

The Data Sources tab displays upon first opening the KPIServer Configurator. This tab displays all currentlyconfigured data sources: data source name, server name, server type and server status. You cannot edit the datain this tab, but you can sort the entries in each of the columns by clicking the column header.

If this is the first time you have installed the KPIServer and you have not yet configured a data source, this tabwill be empty.

You can modify the information that displays in this tab data source information in the Historian and OPC tabs,which are discussed later in this section.

Note: When the KPIServer Configurator opens, the status bar across the bottom of the windowshows the service status, the license capacity, and the KPIServer version.



4.3.1 KPIServer Configurator Menu Options

The KPIServer Configurator has six menus. Review these items below to understand the menu structure andwhich tasks you can accomplish from these menus.

File menu

From the File menu, you can click Exit to exit and close the KPIServer Configurator. It will still run in thabackground as a service.

Edit menu

From the Edit menu, you can select Options to open the Options tab, where you can distribute the FactoryKPIlicenses to users, and designate a server port, if necessary.

View menu

The View menu leads to several tabs where you will probably spend the majority of your time.

Select Data Sources to open the Historian or OPC tabs, where you can configure and manage your Historian-based or OPC-based data sources.Depending up on the mode you elect to use to distribute your FactoryKPI licenses to users, you can clickActive Users or Manage Users to distribute FactoryKPIs and assign usernames and passwords to users.Finally, click Settings to open the Metric Settings or KPI Settings tab, where you can manage FactoryKPI andmetrics configurations.

Service menu

You can manually stop, start or restart the service.



Refresh

Click Refresh to see the most recently saved configurations in the KPIs and Metrics Settings tabs (View menu).

Help menu

There are several options available from the Help menu.

Click Help File to access a PDF of this document, the FactoryKPIsTM for iOS Users’ and Administrator’sGuide.Click Buy More Licenses to purchase additional metrics from the FactoryKPIs Web site.Click License Manager to register and activate your KPIServer.Click About to see your KPIServer version number.Click Check for Updates to see if there is an update to your current version of the KPIServer.




4.3.2 Managing Users and Assigning Passwords

4.3.2.1 Manage UsersFrom the View menu, select Manage Users

4.3.2.2 Passwords

To add a password:o In a blank line, enter the iOS Device Name (found on the device at “Settings Name”)o Enter a Username and Passwordo Check the “Is Enabled” box

To delete a password:o Right-click on the row that contains the username and password to be deleted and click

“Delete”



Click “Yes” to delete. Deleting a username/password can’t be undone, but can be reentered quickly, ifdesired.An alternative to deletion is to uncheck the “Is Enabled” box

Note: the default Username/Password combination is “Demo/Demo”. Using “Demo” credentials can be enabledand disabled from the Edit/Options menu.

4.3.2.3 Delete all NotificationsNotifications are launched from a separate, Apple-compliant notification server. There are no user settings for it.

Notifications are deleted from the notification server after a metric is deleted from the iOS device (either fromOptions/Settings, or from the active KPI view, or a KPI (and thus all of the its metrics)). It takes up to 15 secondsfor the notification settings to be deleted from the server after deleting a metric/KPI (or in the case of beingdeleted from Options/Settings, the delete happens only after tapping the “Done” button).

You can also manually delete all notification settings for a given user (as a sort of failsafe, such as when an app isdeleted from the iOS device, with notifications saved on the server. The notification server cannot detect whenan app is uninstalled from the iOS device or when the app is reinstalled and starts receiving notifications fromthe previous install.

If a metric is reinstalled and notification is enabled for it, notifications and alerts will resume as normal.

Select a user whose notifications will be deletedClick “Delete All Notifications”Click “OK” (the confirmation dialog will not appear if there were no notifications to be deleted for tatuser.)



4.3.3 Managing, Adding, and Deleting Historian-based Data Sources

FactoryKPI metrics communicate with Historian and OPC data sources. Each type of data source has its own tabunder Data Sources in the View menu. Manage, add and delete Historian-based data sources in the Historiantab. You may also test tag names for use with your Historian-based data source(s), and associate friendly namesto your valid tag names for use with the FactoryKPI metrics.

Click the View menu, select Data Sources, and then click Historian.



Field Description

Data Source Name Enter the name of your choice for the Wonderware Historian data source. The KPIServercan access multiple Wonderware Historians, so if you have multiple data sources, you canenter “friendly” data source names that provide more context for you and your business.

Server Enter or browse for the name of the server PC on which the Historian data source resides.

If the KPIServer is not installed on the same domain as the data source, you can enter theIP address of the server PC hosting the data source.

Username & Password Enter the username and password. This is a SQL server login, not your Windowsauthentication login.

Note: The suggested username/password are wwUser/wwUser. This is aprofile that is installed with Wonderware Historian that has read-only rights.

4.3.3.1 Testing a Data SourceOne you have entered a row in the Historian tab that defines your data source, test the data source you have enteredto verify that it is valid. If the data source makes a successful connection, a green “success” message appears,indicating the data source to which you connected is valid. If a red “failure” message displays, the data source isinvalid. Check your data source and your spelling and try again.

One you have entered a row in the Historian tab that defines your data source, server, and username andpassword, click Test Data Source in that same row to test the data source to verify that it is valid.

4.3.3.2 Testing a TagAfter you have verified your data source and have made a successful connection, test the tags that you want touse with that data source.

1. In the same row in the Historian tab where you tested the data source, now click Test Tag to make sure thetags you want to use with this data source are valid.

2. In the Test Tag tab, enter either the Alias name or the Historian tag name and click Test.

If the tag name is valid, the parameters associated with that tag will display. If the tag name is not valid, a “Tag NotFound” message displays. An invalid tag name is either not in use with the data source with which you are testing the



tag, or the tag name contains a typo. Double-check the spelling of the tag name and try again. NOTE: All tag namesare case sensitive.

4.3.3.3 Editing a TagAfter you have verified a valid tag name for use with the data source, you can assign a friendly name or “Alias” to thattag.

1. In the same row in the Historian tab where you have tested your data source and tested your tags, click EditTags.

2. Enter a friendly name in the Alias field and enter the existing tag name in the Tag Name field. Then, pressEnter.

Now, you can use the Alias name in the FactoryKPI metrics. To double-check that the Alias name is correctlyassociated with a tag, test the Alias name with Test Tag.



4.3.3.4 Importing and Exporting Tags

Because many systems have hundreds, or even thousands, of tags, entering them into Historian data sourcescan be cumbersome and time-consuming. Many systems engineers use tools such as Excel or other text editorsto create lists of tags, in comma-separated-variable (*.csv) format, for use in their HMI or PLC programs. Thesame technique can be used with FactoryKPIs. Once you have created the .csv file, you can import that file intothe KPIServer Configurator so that you do not have to manually enter each tag.

To import tag names to the KPIServer Configurator:

1. Create the .csv file.

Note: The example shows Excel as the text editor, with spreadsheets saved in *.csvformat. If using Excel, Alias Names must be in Column A and Tag Names inColumn B. Spreadsheet columns must not have headers.

2. Click Import Tags in the Edit Tags tab and browse to locate the .csv file. Once located, click Open.



A preview of what will be imported is presented to you asking you to Confirm or Cancel. Click Confirm.

When the file has imported successfully the tags will be displayed in the Edit Tags tab.



To export tag names from the KPIServer Configurator:

1. In the Edit Tags tab, click Export Tags to export your current tags for a selected data source. Browse toselect the location where you want to save the .csv file and click Save.

2. When the .csv files has successfully saved, a message displays, “Exported Tags Successfully.” Click OK.



4.3.4 Managing, Adding, and Deleting OPC-based Data Sources

FactoryKPI metrics communicate with Historian and OPC data sources. Each type of data source has its own tabunder Data Sources in the View menu. Manage, add and delete OPC-based data sources in the OPC tab. Youmay also test tag names for use with your OPC-based data source(s), and associate friendly names to your validtag names for use with the FactoryKPI metrics.

Click the View menu, select Data Sources, and then click OPC.

Field Description

Data Source Enter the name of your choice for the OPC data source. If you have multiple data sources,you can enter “friendly” data source names that provide more context for you and yourbusiness.

Computer Name Enter or browse for the name of the computer on which the OPC server resides.

If the KPIServer is not installed on the same domain as the data source, enter the IPaddress of the server PC hosting the data source.

OPC Server Select the OPC server from the drop-down list.

Field Description

Group Name The group name increments chronologically. You can modify the group names to yourneeds if you use groups.

Scan Rate The scan rate defaults to 1000 milliseconds. You can modify this rate at which the OPCserver checks for new data.



4.3.4.1 Testing a Data SourceOne you have entered a row in the OPC tab that defines your data source, you can test the data source you haveentered to verify that it is valid. If the data source makes a successful connection, a green “success” message appears,indicating the data source to which you connected is valid. If a red “failure” message displays, the data source isinvalid. Check your data source and your spelling and try again.

One you have entered a row in the OPC tab that defines your data source, computer name, OPC server, andoptionally, a group name and scan rate, click Test Data Source in that same row to verify that it is valid.

4.3.4.2 Testing a TagAfter you have verified your data source and have made a successful connection, test the tags that you want touse with that data source.

1. In the same row in the OPC tab where you tested the data source, now click Test Tag to make sure the tagsyou want to use with this data source are valid.

2. In the Test Tag tab, enter either the Alias of OPC tag name, and click Test. You can also use Lookup Tag tobrowse to the tag.

If the tag name is valid, the parameters associated with that tag display or a message saying, “Valid Tag” displays. Ifthe tag name is not valid, a “Tag Not Found” message displays. An invalid tag name is either not in use with the datasource, or the tag name contains a typo. Double-check the spelling of the tag name and try again. NOTE: All tagnames are case sensitive.

4.3.4.3 Editing a TagAfter you have verified a valid tag name for use with the data source, you can assign a friendly name or “Alias” to thattag.

1. In the same row in the OPC tab where you have tested your data source and tested your tags, click Edit Tags.



2. Enter a friendly name in the Alias field and enter the existing tag name in the Tag Name field. Then, pressEnter.

Now, you can use the Alias in FactoryKPI metrics. To double-check that the Alias is correctly associated with a tag, testthe Alias with Test Tag. When doing so the full OPC Item name will populate in the Tag to Test textbox.



4.3.4.4 Adding a TagIf there is tag that you want to use, but that is not currently associated with your data source, add the tag fromthe Edit Tag tab.

1. To add a tag, click the Add Tags button in the Edit Tags tab and browse to locate the tag(s) to add.

2. Once located, click to select the tag in the right pane and then click OK at the bottom of the window. You canadd tags individually or several at a time, using Ctrl+click or Shift+click. Once added, the selected tag(s)appear(s) in the Edit Tags window in the KPIServer Configurator.

Once added, you can test the tags to ensure they work with your data source and you may associate an Aliaswith them.



4.3.4.5 Importing and Exporting TagsBecause many systems have hundreds, or even thousands, of tags, entering them into OPC data sources can becumbersome and time-consuming. Many systems engineers use tools such as Excel or other text editors tocreate lists of tags, in comma-separated-variable (*.csv) format, for use in their HMI or PLC programs. The sametechnique can be used with FactoryKPIs. Once you have created the .csv file, you can import that file into theKPIServer Configurator so that you do not have to manually enter each tag.

To import tag names to the KPIServer Configurator:

1. Create .csv file with tag names.

Note: The example shows Excel as the text editor, with spreadsheets saved in *.csvformat. If using Excel, the Alias must be in Column A and Tag Names in ColumnB. Spreadsheet columns must not have headers.

Note: OPC Tag Names need to contain fully-qualified names as used in the specificOPC Server application.



2. Click Import Tags in the Edit Tags tab and browse to locate the .csv file. Once located, click Open.

3. A preview of what will be imported is presented to you asking you to Confirm or Cancel. Click Confirm.



1. When the file has imported successfully the tags will be displayed in the Edit Tags tab.

To export tag names to the KPIServer Configurator:

1. Click Export Tags to export your current tags for a selected data source. Browse to select the locationwhere you want to save the .csv file and click Save.

2. When the .csv files has successfully saved, a message displays, “Exported Tags Successfully.” Click OK.



4.3.5 Assigning FactoryKPI Metrics User Licenses

Click the Edit menu to open the Options tab, where you can select the licensing mode to assign yourFactoryKPI metrics licenses to users.

Note: The Search box at the top of the tab is simply to let you search for the licensingand service parameters.

Field Description

LicenseTimeout This is the default time for a license to expire after last active use. If a user deletes aFactoryKPI metric from their device (is no longer actively using it), the metric is “released”for use by another when the time entered in this field expires.

Enter time in this format: hh:mm:ss. The default is 5 minutes.

LicenseMode There are three licensing modes to choose from:

ConcurrentLicensing: Concurrent licensing allows any user to connect as manyFactoryKPI metrics as they want, up to the licensing limit.SeatLicensing: Seat licensing uses the configured user licenses to allocate licenses peruser.MixedConcurrentSeatLicensing: Mixed licensing allows for both licensing modes to bein use. For example:

o If a user is assigned a certain number of FactoryKPI metrics per seat licensing,but there are additional FactoryKPI metrics in the “pool” per the concurrentmethod, then the user may configure additional available FactoryKPI metricsfrom that pool; however, when that user’s metrics are not in use, theFactoryKPI metrics obtained from the pool return to the pool.

o If a user is not allocated any FactoryKPI metrics per seat licensing, that user



Field Description

may configure any available FactoryKPIs from the concurrent “pool.”

4.3.5.1 Using Concurrent Licensing ModeIf you elect to use ConcurrentLicensing, the users can connect to as many FactoryKPI metrics as they want, up tothe licensing limit.

Go to the Active Users tab in the View menu to see the tab automatically update to display active usersand the FactoryKPIs and FactoryKPI metrics they have installed and configured.

The list of active users is automatically updated at five second intervals.

Field Description

Device Name Automatically updates when user installs and configures FactoryKPIs on an iOS device.

Username Automatically updates when user installs and configures FactoryKPIs on an iOS device.

Active Metrics Automatically updates when user actively uses FactoryKPIs on an iOS device. When theuser closes the app or shuts off the device, the FactoryKPI metrics are no longer consideredactive and are returned to the pool for another user.

iOS or Desktop Displays number of FactoryKPI metrics for iOS and/or FactoryKPIs for Windows on theirrespective platforms

Release All Metrics Click Release All Metrics to release all of a specific user’s FactoryKPI metrics back to thepool.

4.3.5.2 Using SeatLicensing ModeIf you elect to use SeatLicensing, the users can use FactoryKPI metrics per the licenses allocated to them.

Go to the User Licenses tab in the View menu to enter the user information and the number ofallocated FactoryKPI metrics.



Note: The User Licenses tab is not accessible in ConcurrentLicensing mode.

For each user, enter the following in the fields provided:

Field Description

Device Enter the iOS Device name.

Username Enter the username.

Allowed Metrics Enter the total number of FactoryKPI metrics the user is allowed.

The default value is -1. It simply means that no specific number of widgets have beenallocated to the user.

If you change the number of FactoryKPI metrics allocated to a user or users, you mustrestart the KPIServer service. After changing the allocation, and upon pressing Enter orclicking in a different row, a warning message appears as a reminder: “WARNING: Allowedmetrics per user will not be applied until KPIServer is restarted.”

It is recommended that you make all allocation changes and then restart the KPIServer inorder to avoid interrupting existing users multiple times. (See section 3.3.7 for restartingservice.)



4.3.5.3 Using Mixed Licensing ModeIf you elect to use the MixedConcurrentSeatLicensing option, this means you can use a combination of the twolicensing modes.

First, remember, the status bar at the bottom of the KPIServer Configurator shows the number of licenses theKPIServer is licensed for and how many of those licenses your users are currently using.

Now, consider the following scenario as a means of explanation for using both (mixed) licensing modes.

The KPIServer in the image above is licensed for 10 FactoryKPI metrics.Employee A is allowed five FactoryKPI metrics per SeatLicensing mode.

Since Employee A has five, there are five FactoryKPI metrics still available. These can either be assignedto additional user(s) per seat licensing mode, or they can be made available to additional user(s) perconcurrent licensing mode.

When using the mixed licensing mode, users can take advantage of both kinds of licensing modes to use moreFactoryKPI metrics. This means that if no other users are using FactoryKPI metrics, Employee A is free to use anyor all of the remaining five licenses available per the concurrent mode, over and above the five he is alreadyallowed per seat licensing mode.

In this scenario, Employee A is now using all current licenses. This means that no other users can use FactoryKPImetrics until Employee A closes his “concurrent” metrics or shuts down his iOS Device.

If Employee B had been using a license yesterday in concurrent mode, but powered down her device at the endof the day, then her metric license is returned to the “pool.” When she logs in today, while Employee A has all10 licenses, the FactoryKPI metric on her device will display, “No Licenses Available,” and she will not be able touse it.

When Employee A does shut down his device, the five licenses granted to him per seat licensing remain his, butthe five he claimed through concurrent licensing will return to the “pool” for other users.

Note: When using MixedConcurrentSeatLicensing mode, if you change the number ofFactoryKPI metrics allocated to a user or users in the User Licenses tab, youmust restart the KPIServer service. After changing the allocation, and upon



pressing Enter or clicking in a different row, a warning message appears as areminder: “WARNING: Allowed metrics per user will not be applied untilKPIServer is restarted.”

It is recommended that you make all allocations changes and then restart theKPIServer in order to avoid interrupting existing users multiple times. (Seesection 3.3.7 for restarting service.)



4.3.6 Designating a Server Port (if necessary)

Click the Edit menu to open the Options tab, where you can designate a server port, if necessary.

Note: The Search box at the top of the tab is simply to let you search for the licensingand service parameters.

Figure 2: Port Designation

Field Description

Port Designate a KPIServer TCP port number. This should be a value greater than 1024 and lessthan 65535, and it should not be in use by any program or service.

The default is 4700. You can click the arrows in the right side of the Port field to incrementor decrement the port number.

Note: If you change the port, the KPIServer will prompt you torestart service.

4.3.7 Managing FactoryKPI Configurations

To manage FactoryKPI configurations, go to the View menu and click Settings to open the KPI and MetricSettings tabs.

Note: a FactoryKPI is actually a “convenience grouping” of FactoryKPI metrics. A metric connects to a data sourceand displays its behavior per its configuration. One metric can “belong” to multiple FactoryKPI. Metrics belongingto a FactoryKPI can each connect to datasources on different KPIServers. This means that one FactoryKPI candisplay data from multiple KPIServers.

These tabs each contain a list of global configurations and user-created metric configurations for eachFactoryKPI and metric connected to that server. The configuration data is entered and saved in the FactoryKPIand metric itself, and then it is reflected here. Once in the Settings tab, you can edit the configuration name anddescription. You can also designate a configuration as “global,” meaning all users have access to theconfiguration. Other users can load a global configuration, but they cannot overwrite it.



Among other uses, a global configuration is helpful to use as a baseline FactoryKPI and/or metric configuration.When users add new metrics and KPIs to their devices, they can quickly configure some basic settings by loadinga global configuration, and then add to their configurations from there. This saves time over manually adding allconfiguration data by hand each time they add a new FactoryKPI/metric.

Select Settings from the view Menu

Select “Metric Settings” or “KPI Settings” as appropriate

Metrics Settings View

KPI Settings View



Field Description

Name The name given to the configuration when saved in the KPI or metric itself.

Description A description given to the configuration when saved in the KPI or metric. This is optional.

Global Check this box if the configuration is to be a global configuration, available to all users.Users cannot overwrite global configurations.

The choice will not be retained until you move to another line in the grid.Metric Type The metric type displays (Value Display, State Display, Goal Display, or Elapsed Time

Display).

Username The name of the device and the name of the user who configured the KPI or metric.

Refresh While in the Settings tab, click the Refresh tab in the KPIServer Configurator’s top levelmenu in order to refresh the data to see the most recent saved configurations.

Service After changing a KPI’s or metric’s global status, be sure to restart the KPI Server servicefrom the “Service” dropdown.



4.3.8 Stopping and Starting Service

Generally, the KPIServer will prompt you any time you need to stop, start, or restart service. For example, if youhave made a change to your configuration, like changing the port number, you will be prompted to restartservice and the KPIServer will do it for you when you acknowledge the message.

You can also manually stop, start and restart service by selecting the appropriate action from the Service menu.

4.3.9 Checking for Updates

When a KPIServer update is available, you will receive an email. Go to the KPIServer Configurator’s Help Menuand select the option to Check for Updates.

Note: If you have opted out of receiving global emails from Software Toolbox, youmay not receive notice of these updates.

The most current version of FactoryKPIs will always display on the FactoryKPIsTM Web site.




4.3.9.1.1.1 KPIServer Tips and Tricks

5 TROUBLESHOOTING

If see errors with the FactoryKPIs, review the error messages below for guidance about how to resolve them. Ifyou are having issues connecting to valid data sources, you can test your data source connection and your tagnames using the KPIServer Configurator. Contact Support if you cannot resolve errors or issues.

5.1 FactoryKPI Error Messages

You may see any of the following error messages if, when configuring the FactoryKPIs, some data was notentered, or invalid data was entered. Review the messages below for more explanation about what theyindicate and how to resolve them.

Error Message Description/RemedyBAD DATA QUALITY The data stream from the data source is not available. This means the

input/output (I/O) server providing data to the control system is experiencingan issue. Check the status of that server.

DATA SOURCE NOTCONFIGURED

There is no data source name entered in the FactoryKPI or metric menu. Enter avalid data source in the Data Source Name field.

INVALID DATA SOURCE NAMEOR DATA SOURCE NOTAVAILABLE

The data source name entered is invalid (misspelled or does not exist), or the datasource is not currently available. Check the entry in the Data Source Name field.

INVALID SETPOINT If you have the setpoint type set to Manual in the Goal Display setpoint entry fieldand it is invalid (misspelled or does not exist). Check the entry in your setpointentry field.

INVALID SETPOINT TAGNAME If you have the setpoint type set to Server Tag in the Goal Display, and thesetpoint tagname entered is invalid (misspelled or does not exist). Check the entryin your Setpoint Tagname field.

INVALID TAGNAME The tagname entered in the metric is invalid (misspelled or does not exist). Checkthe entry in your Tagname field.

INVALID TIMESTAMP The UTC time (time zone adjusted) clocks on the client computer and thecomputer where KPIServer is running are out of synch by more than five minutes.Set up the computers to synchronize their clocks with a common time source. Ifthis is not possible, contact technical support for details on an alternativeworkaround solution.

INVALID KPISERVER NAME ORKPISERVER NOT CONFIGURED

The KPIServer name entered in the metric is invalid (misspelled or does not exist),or there is no name entered. Check your entry in KPIServer Name field.

NO CONNECTIVITY TO DATA The device has lost its network connection. Check wireless connectivity.NO LICENSES AVAILABLE There is not a license available for the FactoryKPITM metric you are trying to

configure on the device. Go to the Options menu in the KPIServer Configuratorand assign an open license or purchase an additional license.

No metric settings found.Please check your server name

You are trying to load a configuration to your FactoryKPITM that does not exist. Ifyou select an existing configuration to load, you must click Load to first load that



Error Message Description/Remedyand settings name, and tryagain.

configuration with its existing name; then, click Save Settings, change the SettingsName to something else, and click Save. If you select a configuration to load, andthen modify the name before clicking Load, you will receive this error.

USER NOT FOUND You may see this error message when the KPIServer is configured for “SeatLicensing” mode, and the user is not in the database (that is, they have not yetbeen added to the KPIServer Configurator’s User Licenses tab). Users areautomatically added to the database if you are using “Concurrent Licensing” mode,but they are not automatically added when using “Seat Licensing” mode. Makesure the user is added to the User Licenses tab in the KPIServer Configurator.

KPISERVER ANDFACTORYKPI/METRIC VERSIONMISMATCH

The KPIServer version number does not match the FactoryKPI version number. Youcan see the version number of the KPIServer by checking the status bar in theKPIServer Configurator, and you can see the FactoryKPITM version number bytapping the “I” button at the bottom of the KPIList. Make sure you have the samenewest version of both the KPIServer and FactoryKPI.



5.2 Testing Connections in KPIServer Configurator

If you are having issues connecting to a valid data source, you can test your data source and KPIServer using theKPIServer Configurator.

Open the KPIServer Configurator.

5.2.1 Testing Data Sources

1. To test the data source, enter the following information.a. For a Historian-type data source, go to the View > Data Source > Historian tab and enter the

following information in a row:

o Data source nameo Servero Usernameo User password

b. For an OPC-type data source, go to the View > Data Source > OPC tab and enter the followinginformation in a row:

o Data source nameo Computer nameo OPC server

2. Click Test Data Source. A new tab opens to display the results of the test.

If a successful connection is made, “success” message in green displays, indicating the data entered isvalid. If a “failure” message in red displays, the data entered in one or more of the four fields youconfigured is invalid, the data source is not available, or network configuration issues prevent you fromconnecting to the data source. Check your data and your spelling and try again.

5.2.2 Testing Tags

1. To test a tag, you must have already tested and verified your data source in the View > Data Source >Historian or OPC tabs. If you have not already done so, test your data source before proceeding.

2. Now, in the same row where you verified the data source, click Test Tag. A new tab opens to test a tagname.

3. Enter a tag name and click Test or press Enter.

If the tag name is valid, the parameters associated with that tag or a “Valid Tag” message display. If thetag name is not valid, a “Tag Not Found” message displays. An invalid tag name is one that is either not



in use with the data source, or the tag name contains a typo. Double-check the spelling of the tag nameand try again.

5.3 Contacting Support

When you contacting Software Toolbox for support, having the following information ready:

Customer and order informationProduct serial number (provided at the time of purchase)The serial number of your FactoryKPIs license, which is listed in the KPIServer.

As much of the following information that you can provide is also very helpful and helps technicians to help youresolve issues more quickly:

Nature of the problem (e.g., installation, configuration, functionality of a FactoryKPI)Version of KPIServer, which is listed in KPIServer Configurator status bar in the lower right. It canalso be found by clicking Help > About in the KPIServer Configurator.Operating System on which you are running the KPIServer.Version of the affected FactoryKPI(s), which is found by opening the FactoryKPI Options window,and clicking About.Operating system of the client system(s) if issue involves a FactoryKPI on a client computer.Description of the symptom in the form of “actual behavior” vs. “expected behavior,” errormessages you are seeing, and if possible, steps to replicate the issue.Email address to which you have access and a phone number where you can be reached.

5.3.1 Software Toolbox Support

Phone

1-704-849-2773

Normal business hours: Monday to Friday, 8 AM to 5 PM, Eastern Std. Time (GMT -5)

Email

Please submit an inquiry via our support portal at http://support.softwaretoolbox.com. This insuresfastest handling as all of our staff monitors this for any type of inquiry.

Web

Technical Support: http://support.softwaretoolbox.com

http://support.softwaretoolbox.com./

http://support.softwaretoolbox.com/



6 DOCUMENT REVISION HISTORY

Revision DateFirst publication – FactoryKPIs version 4 November 2012

APPENDIX A – LICENSING AGREEMENT

APEX Software Development LLC License Agreement

PLEASE READ THIS AGREEMENT CAREFULLY. BY INSTALLING OR OTHERWISE USING THE APEXSOFTWARE, YOU AGREE TO THE TERMS OF THIS AGREEMENT. IF YOU DO NOT AGREE WITH THESETERMS, DO NOT DOWNLOAD, INSTALL OR USE THE APEX SOFTWARE. THE APEX SOFTWARE MAYNOT BE SOLD, TRANSFERRED, OR FURTHER DISTRIBUTED EXCEPT AS AUTHORIZED BY APEXSOFTWARE DEVELOPMENT LLC.

This APEX Software License Agreement (this “Agreement”) is a legal agreement between you (an entity or aperson) and APEX Software Development LLC (“APEX”). The software product identified in the title of thisAgreement, media (if any), and accompanying documentation (collectively, the “Software”) is protected by thecopyright laws and other laws and treaties of the United States (“U.S.”) and other countries and is subject to theterms of this Agreement. If you do not agree with the terms of this Agreement, do not download, install, orotherwise use the Software and, if applicable, return the entire unused package to APEX with your invoice andproof of payment for a full refund. The Software is licensed to you, not sold.

The Software may include or be bundled with other software programs licensed under different terms and/orlicensed by a vendor other than APEX. Use of any software programs accompanied by a separate licenseagreement is governed by that separate license agreement. Any third party software that may be provided withthe Software is included for use at your option. APEX is not responsible for any third party’s software and shallhave no liability for your use of third party software.

1. Grant of License. Subject to the terms and conditions of this Agreement, APEX grants to you a non-exclusive and non-transferable license, without right to sublicense (the “License”), to install, use, execute, anddisplay one copy of the KPIServer™ component of the Software on a single computer at a single location. TheFactoryKPI™ components of the Software can be installed on a single or multiple computers, or mobile devices,provided the total number of FactoryKPIs™ installed does not exceed the total number of FactoryKPI™ licensespurchased. For purposes of this Agreement, a “Computer” is defined as a single physical computer, mobile



device, or a single instance of a virtual PC, virtual server, whether it be implemented using Microsoft Virtual PC,Virtual Server, Hypervisor, VMWare, or other virtual computing software applications that enable multiple isolatedoperating system instances to be run on a single hardware platform.

1.2 Multiple Computers. If you plan to run the KPIServer component of the Software on multiplecomputers (whether virtual or physical) or servers (whether virtual or physical) a license is required for eachinstance of the computer or where the KPIServer component Software will be installed. If you also plan toinstall the KPIServer component Software in the host operating system of the computer where the virtualmachines are running, a license will also be required for the host operating system. The FactoryKPI™components of the Software can be installed on a single or multiple computers/mobile devices, provided thetotal number of FactoryKPIs™ installed does not exceed the total number of FactoryKPI™ licensespurchased.

1.3 Demonstration Mode. If you are running the Software in a demonstration, unlicensed mode, youmay not automate the stopping and starting of the Software in demo mode or use any other method toattempt to circumvent the demonstration mode timeout period, if any.

1.4 Additional Uses. In order to authorize additional uses of the FactoryKPI™ software you mustpurchase additional FactoryKPI™ licenses for use on computers and/or mobile devices. A user may notaccess the Software unless it has a valid license.

1.5 Dual-Media Software. You may receive the Software in more than one medium. Regardless ofthe type or size of medium you receive, you may use only one medium that is appropriate for the Computer ormobile device. You may not use or install the other medium on another computer. You may not loan, rent,lease, or otherwise transfer the other medium to another user, except as part of the permanent transfer (asprovided above) of the Software.

2. License Restrictions. APEX reserves all rights not expressly granted to you under this Agreement. Youmay not (a) reverse engineer, decompile, or disassemble the Software, except and only to the extent it isexpressly permitted by applicable law; (b) modify, alter, rent, timeshare, or lease the Software or sublicense anyof your rights under this Agreement; or (c) transfer the Software or your license rights under this Agreement, inwhole or in part.

3. Third Party Licenses. With respect to any portion of the Software licensed by APEX from third parties,you shall be bound by the terms and conditions of the license received by APEX from such third parties.

4. Support and Upgrades. APEX’s initial free warranty and technical support period is 90 days fromthe purchase date of the Software. Technical support is provided by Software Toolbox, Inc., which providesunlimited e-mail technical support for all Software whether a demo or registered license in the first 90 days afterpurchase. Software Toolbox Inc. will provide a total of up to four hours per month of free phone technical supportduring the initial 90 days to the licensed and registered user provided the applicable license fees for use of theSoftware have been paid. Software Toolbox Inc. will provide unlimited email technical support and up to fourhours per month of free phone technical support beyond the initial 90 day warranty period provided. No onsitesupport is provided. Upgrades are not included with the initial purchase of the Software. Additional technicalsupport, beyond that described herein, plus Software upgrades, is available at an extra cost. Terms of thatsupport are covered under separate agreement.

5. Client Access Licenses. Many software and database vendors require users to purchase licensesthat allow them to connect to, and access data from, their products. These are sometimes known as ClientAccess Licenses (CALs). If you use KPIServer™ and/or FactoryKPIs™ to access such data sources, you musthave the appropriate CALs, as required and available from that software or database vendor.

6. Ownership. No title to or ownership in the Software is transferred to you. APEX retains ownership of allSoftware and copies thereof and you acknowledge that all right, title, and interest in and to the Software and anyand all trademarks, trade names, copyrights, patents, and other intellectual property rights used or embodied in or



in connection with the Software are and shall at all times remain the sole and exclusive property of APEX.

7. Return Policy The original licensee of the Software can return it within thirty (30) days of purchase. Pleasecontact us for a Return Material Authorization Number. Returns after 30 days of purchase may require arestocking fee. Any extensions of this return period must be pre-approved by Software Toolbox technical supportand documented in writing, where e-mail is considered to be in writing. No returns are accepted without a ReturnMaterial Authorization Number.

8. Warranty; Liability.

8.1 Limited Warranty. For thirty (30) days from your date of purchase, APEX warrants that (a) anymedia on which the Software is delivered is free from physical defects; and (b) the Software will substantiallyconform to the documentation accompanying the Software. If the defective items are returned to APEX, or if youreport the nonconformity to APEX, within thirty (30) days from the date of purchase APEX will, at its solediscretion, either resolve the nonconformity or refund the purchase price you paid for the Software. Any misuse orunauthorized modification of the Software voids this warranty. THE SOFTWARE IS ONLY COMPATIBLE WITHCERTAIN COMPUTERS, MOBILE DEVICES, AND OPERATING SYSTEMS. THE SOFTWARE IS NOTWARRANTED FOR NON-COMPATIBLE SYSTEMS. Contact APEX for information about compatibility.

8.2 Non-APEX Products. The Software may include or be bundled with hardware or other softwareprograms licensed or sold by a vendor other than APEX (“Bundled Services”). Without limiting the disclaimer ofwarranties and limitations on liability set forth in this Agreement, you recognize and agree that (a) APEX shallhave no liability for the quality or performance such Bundled Services, (b) APEX shall not be deemed to havemade any representation or warranty concerning Bundled Services or the provider of Bundled Services, (c) APEXshall use commercially reasonable efforts to enforce its rights under any written agreement it may have with theprovider of such Bundled Services; provided, that APEX shall have no liability whatsoever for the failure of aprovider of Bundled Services to perform its obligations with respect thereto, and (d) whenever possible, APEXshall pass through or assign to you any third party service level agreement or warranty which APEX receives inconnection with any Bundled Services.

8.3 Warranty Disclaimer. EXCEPT AS OTHERWISE RESTRICTED BY LAW, APEX DISCLAIMSAND EXCLUDES ANY AND ALL IMPLIED WARRANTIES INCLUDING ANY WARRANTIES OFMERCHANTABILITY, TITLE, NON-INFRINGEMENT, OR FITNESS FOR A PARTICULAR PURPOSE. APEXMAKES NO WARRANTY, REPRESENTATION OR PROMISE NOT EXPRESSLY SET FORTH IN THIS LIMITEDWARRANTY. APEX DOES NOT WARRANT THAT THE SOFTWARE WILL SATISFY YOUR REQUIREMENTSOR THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED. APEX DOES NOTGUARANTEE THE UPTIME OF THE DATA OR NOTIFICATION SERVERS. THE SOFTWARE IS NOT TO BEDEPENDED ON AS THE SOLE INDICATOR OR NOTIFIER OF MANUFACTURING INFORMATION ORCRITICAL MANUFACTURING EVENTS. Some jurisdictions do not allow certain disclaimers and limitations ofwarranties, so portions of the above limitations may not apply to you. This limited warranty gives you specificrights and you may also have other rights, which vary from state to state.

8.4 LIMITATION OF LIABILITY. NEITHER APEX NOR ANY OF ITS LICENSORS, SUBSIDIARIES,DISTRIBUTORS, OR EMPLOYEES WILL IN ANY CASE BE LIABLE FOR ANY SPECIAL, INCIDENTAL,CONSEQUENTIAL, INDIRECT, TORT, ECONOMIC, OR PUNITIVE DAMAGES ARISING OUT OF THE USE OFOR INABILITY TO USE THE SOFTWARE, INCLUDING WITHOUT LIMITATION, LOSS OF PROFITS,BUSINESS, DATA, GOODWILL, OR ANTICIPATED SAVINGS, EVEN IF ADVISED OF THE POSSIBILITY OFTHOSE DAMAGES. IN NO EVENT WILL APEX’S AGGREGATE LIABILITY FOR DIRECT DAMAGES TOPROPERTY OR PERSON (WHETHER IN ONE INSTANCE OR A SERIES OF INSTANCES) EXCEED THEAMOUNT PAID BY YOU FOR THE SOFTWARE OUT OF WHICH SUCH CLAIM AROSE. In those jurisdictionsthat do not allow the exclusion or limitation of damages, APEX’s liability shall be limited or excluded to themaximum extent allowed within those jurisdictions.

9. Confidentiality.



9.1 Confidential Information. You hereby acknowledge that you may have access to informationthat is confidential to APEX (“Confidential Information”). Confidential Information shall include the Software,including all related source and object codes, any documentation included with the Software, the terms andpricing under this Agreement, and trade secrets and intellectual property relating to APEX and the Software.Confidential Information also includes information relating to APEX’s business or financial affairs, such asfinancial results, business methods, pricing, competitor and product information, and all other informationdesignated as confidential by the disclosing party. Confidential Information shall not include any information that(a) becomes part of the public domain through no act or omission of the other party; (b) is lawfully acquired by theother party from a third party without any breach of the third party’s obligations to the disclosing party; or (c) isdisclosed by the disclosing party to a third party without any obligation of confidentiality by the third party. Youagree to maintain the confidentiality of the Confidential Information and to protect as a trade secret any portion ofAPEX’s Confidential Information by preventing any unauthorized copying, use, distribution, installation, or transferof possession of such information. You agree to maintain at least the same procedures regarding APEX’sConfidential Information that you maintain with respect to your own confidential information. Without limiting thegenerality of the foregoing, you shall not permit anyone to remove any proprietary or other legend or restrictivenotice contained or included in any material provided by APEX.

9.2 Injunctive Relief. You acknowledge that any use or disclosure of APEX’s ConfidentialInformation in a manner inconsistent with the provisions of this Agreement may cause APEX irreparable damagefor which remedies other than injunctive relief may be inadequate, and you agree that APEX shall be entitled toseek from a court of competent jurisdiction injunctive or other equitable relief to restrain such use or disclosure inaddition to other appropriate remedies.

9.3 Survival. The terms and provisions of this Section 9 shall survive any termination of thisAgreement for any reason.

10. U.S. Government Restricted Rights. If you are licensing the Software on behalf of any unit or agency ofthe United States Government, the following applies: The Software is provided with RESTRICTED RIGHTS. Use,duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraphs (a)through (d) of the Commercial Computer-Restricted Rights clause at 48 CFR 52.227-19, or in subparagraph(c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013, as applicable,and in similar clauses in the NASA FAR Supplement. Contractor/ Manufacturer is APEX Software DevelopmentLLC, 1770 State St. Suite 261, Boise, ID 83702, USA. Tel: +1 (208) 344-5535.

11. Indemnification. You shall defend, indemnify, and hold APEX, its officers, directors, and employees,Software Toolbox, Inc, and APEX’s distributors harmless from and against any and all claims, damages, losses,costs, or other expenses (including reasonable attorneys’ fees) that arise directly or indirectly out of your willfulmisconduct or unpermitted use of the Software.

12. General Terms.

12.1 Term. This Agreement becomes effective on the date you legally acquire the Software and willautomatically terminate if you breach any of its terms. Upon termination of this Agreement, you must destroy theoriginal and all copies of the Software or return them to APEX and delete the Software from your systems.

12.2 Export. You agree that you do not intend to and will not, directly or indirectly, export or transmitthe Software or related documentation and technical data to any country to which such export or transmission isrestricted by any applicable U.S. regulation or statue, without the prior written consent, if required, of the Bureauof Export Administration of the U.S. Department of Commerce, or such other governmental entity as may havejurisdiction over such export or transmission. You represent and warrant that you are not located in, under thecontrol of, or a national or resident of any such country.

12.3 Governing Law. This Agreement shall be construed in accordance with the laws of the State ofIdaho (without reference to choice of law principals) and the United States of America.

12.4 Entire Agreement. This Agreement sets forth the entire understanding and agreement betweenyou and APEX and may be amended only in a writing signed by both parties. NO VENDOR, DISTRIBUTOR,



DEALER, RETAILER, RESELLER, SALES PERSON, OR EMPLOYEE IS AUTHORIZED TO MODIFY THISAGREEMENT OR TO MAKE ANY REPRESENTATION OR PROMISE THAT IS DIFFERENT FROM, OR INADDITION TO, THE TERMS OF THIS AGREEMENT.

12.5 Waiver. No waiver of any right under this Agreement will be effective unless in writing, signed bya duly authorized representative of the party to be bound. No waiver of any past or present right arising from anybreach or failure to perform will be deemed to be a waiver of any future right arising under this Agreement.

12.6 Severability. If any provision in this Agreement is found to be invalid or unenforceable, thatprovision will be construed, limited, modified, or, if necessary, severed, to the extent necessary, to eliminate itsinvalidity or unenforceability, and the other provisions of this Agreement will remain unaffected.

12.7 Assignment and Successors in Interest. Neither this Agreement nor any rights grantedhereunder to you may be assigned or delegated by you, without the written consent of APEX. Without derogatingfrom the aforesaid, this Agreement shall inure to the benefit of and be binding upon the successors or assigneesof the parties (unless the assignment thereof is prohibited hereunder).

13. Trademarks.

KPIServer™, FactoryKPIs™ and FactoryKPI™ are trademarks of APEX Software Development LLC.Microsoft® is a registered trademark, and Windows™ is a trademark of Microsoft Corporation. iPad®, iPhone®,and iPod® touch are registered trademarks of Apple, Inc. SoftwareToolbox® is a registered trademark ofSoftware Toolbox Inc. All other trademarks are the property of their respective owners.

Documents

FactoryKPIsTM for iOS - Software Toolbox2.3 U SING F ACTORY KPI S ... xConnect using 3G/4G or Wi-Fi – works with VPNs - no need to be out of touch with your manufacturing operationsftp.softwaretoolbox.com/.../FactoryKPIs_User_Guide.pdf ·