Pltmt Um001 en p

USER GUIDE

Rockwell Automation Publication PLTMT-UM001K-EN-P-December 2012

Supersedes Publication PLTMT-UM001J-EN-P-December 2011

Customer Support Telephone — 1.440.646.3434 Online Support — http://www.rockwellautomation.com/support

© 2013 Rockwell Automation Technologies, Inc. All rights reserved.

This document and any accompanying Rockwell Software products are copyrighted by Rockwell Automation Technologies, Inc. Any reproduction and/or distribution without prior written consent from Rockwell Automation Technologies, Inc. is strictly prohibited. Please refer to the license agreement for details.

FactoryTalk, Rockwell Automation, Rockwell Software, the Rockwell Software logo are registered trademarks of Rockwell Automation, Inc.

The following logos and products are trademarks of Rockwell Automation, Inc.:

RSBizWare, FactoryTalk Metrics, and FactoryTalk Transaction Manager.

Microsoft, SQL Server, Event Viewer, Windows, Windows Server 2003, and Windows Server 2008 are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

Adobe, Acrobat, and Reader are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries.

All other trademarks are the property of their respective holders and are hereby acknowledged.

This product is warranted in accordance with the product license. The product’s performance may be affected by system configuration, the application being performed, operator control, maintenance and other related factors. Rockwell Automation is not responsible for these intervening factors. The instructions in this document do not cover all the details or variations in the equipment, procedure, or process described, nor do they provide directions for meeting every possible contingency during installation, operation, or maintenance. This product’s implementation may vary among users.

This document is current as of the time of release of the product. However, the accompanying software may have changed since the release. Rockwell Automation, Inc. reserves the right to change any information contained in this document or the software at anytime without prior notice. It is your responsibility to obtain the most current information available from Rockwell when installing or using this product.

Contact Rockwell Automation

Copyright Notice

Trademark Notices

Other Trademarks

Warranty

http://www.rockwellautomation.com/support

Rockwell Automation Publication PLTMT-UM001K-EN-P-December 2012 3

Table of Contents

Chapter 1

What Is FactoryTalk Metrics? ................................................................. 11 Features and Benefits ............................................................................ 12

Intended Audience ...................................................................................... 12 RSBizWare Administrator .................................................................. 12 Report Designer ..................................................................................... 13 Report User ............................................................................................. 13

Where Can I Go for Help? ....................................................................... 13 Reference the Release Notes ................................................................ 13 Reference the Administration Guide ................................................ 14 Reference the Online Help .................................................................. 14 Get RSBizWare Training ..................................................................... 14 Get Web Support ................................................................................... 15 Get Phone Support ................................................................................ 15 Get Consulting Services ....................................................................... 16 Contact Us .............................................................................................. 16

Chapter 2 Introducing BizBikes .................................................................................. 17 How BizBikes Are Manufactured ........................................................... 17 BizBikes Business Problems ...................................................................... 18 How FactoryTalk Metrics Will Help Solve the BizBikes Production Problems ........................................................................................................ 19 Tutorial Prerequisites ................................................................................. 19

Chapter 3

The RSBizWare Architecture .................................................................. 21 Connecting to the Information Services Manager .............................. 22

Using Microsoft Internet Explorer .................................................... 22 Using the Configuration Console ..................................................... 23

Exploring the User Interface ..................................................................... 24 The Report Explorer ............................................................................. 25 The Report Design and Display Work Area ................................... 25 Shortcut Menus ...................................................................................... 25

Welcome to FactoryTalk Metrics

The BizBikes Factory

Getting Started

Table of Contents

4 Rockwell Automation Publication PLTMT-UM001K-EN-P-December 2012

Chapter 4

Collecting Part Count Data When the Metrics Server Manager Is Stopped .......................................................................................................... 27 What Is the OEE Rating? .......................................................................... 28 What Are Fault Metrics? ........................................................................... 30

Mean Time Between Failure ............................................................... 30 Mean Time To Repair .......................................................................... 31

Configure the Plant Model ....................................................................... 31 Configure an Activity Area Schedule ..................................................... 34

Step 1: Define Time Patterns .............................................................. 35 Work Week Time Pattern ............................................................. 41

Step 2: Configure Composites ............................................................ 42 Step 3: Schedule Exceptions ................................................................ 43

Configure OEE Performance Parameters For an Activity Area ...... 45 Step 1: Configure the Data Collection Parameters ....................... 47 Step 2: Configure the Ideal Cycle Time and Part Id Parameters 47 Step 3: Configure User-defined Summarization Criteria Parameters................................................................................................ 51 Step 4: Configure the Part Count Parameter .................................. 53

Configure a Formula ........................................................................ 55 Step 5: Configure the Scheduled Availability Parameters ............ 58 Step 6: Configure the Monitored Availability Parameters .......... 61 Step 7: Modify the Default Availability Behavior .......................... 64 Step 8: Configure the Running State Parameter ............................ 65 Step 9: Generate Performance Parameter Events ........................... 67

View the Performance Parameter Events for an Activity Area ......... 67 System-generated Events ...................................................................... 67 User-defined Events .............................................................................. 68 The Recycle Bin ...................................................................................... 69

Configure and Use Machine States ......................................................... 70 Machine States at Sample Enterprise ................................................ 71 Step 1: Configure the Machine States ............................................... 73 Step 2: Map Machine States To User-defined Events ................... 77

Map a Machine State To a Single Monitored Value Data Point ............................................................................................................... 77 Map a Machine State To a Monitored Bit Data Point ............ 83

Collecting Performance Data

Table of Contents


Map a Machine State To a Formula That Resolves To a Single Bit ......................................................................................................... 86

Step 3: Determine Availability and Running State From Machine State ........................................................................................................... 90

Use Machine State To Determine Monitored Availability .... 90 Use Machine State To Determine Running State .................... 91

Configure FactoryTalk Metrics To Perform Downtime Tracking. 92 Running Versus Downtime ................................................................. 93 User-defined Downtime Events ......................................................... 94

Downtime Tracking With User-defined Events in the BizBikes Demo Application ........................................................... 95

Machine State ......................................................................................... 96 Enable Data Collection For the Activity Area ..................................... 97 Review Performance Parameters Event Status ..................................... 97 Review Sample Activity Areas ............................................................... 100 Start and Stop Data Collection ............................................................. 100 Manual Data Collection ......................................................................... 101

Chapter 5 FactoryTalk Metrics UDT ..................................................................... 105

UDT Data Points and FactoryTalk Metrics Performance Parameters............................................................................................. 106

Part ID .............................................................................................. 107 Ideal Cycle Time ............................................................................ 107 Good Parts ....................................................................................... 107 Scrap Parts ....................................................................................... 108 Total Parts ....................................................................................... 108 Scheduled Availability .................................................................. 108 Running ........................................................................................... 109 Monitored Availability ................................................................. 109 Custom Events - Monitored Value ........................................... 109 Custom Events - Digital ............................................................... 110 Custom Events - Analog .............................................................. 111 Flex Fields - String ......................................................................... 112 Flex Fields - Integer ....................................................................... 113 Flex Fields - Boolean ..................................................................... 114

Automated Configuration

Table of Contents


Using FactoryTalk Metrics Configuration Tool to Perform an Automated Configuration ..................................................................... 114

Configuring FactoryTalk Metrics: New vs. Update ................... 116 Configuring FactoryTalk Directory ............................................... 116

Adding FactoryTalk Users .......................................................... 116 Configuring RSLinx Enterprise as the OPC Server .............. 117

Configuring the Service Console .................................................... 120 Configuring Servers....................................................................... 120 Assigning User Privileges, Licensing and Activation ............ 122 Enabling Flex Fields ...................................................................... 123

Creating the Plant Model ................................................................. 125 Adding the FactoryTalk Metrics UDT ......................................... 126 Configuring FactoryTalk Transaction Manager ......................... 129

Loading the Plant Model from the Database .......................... 129 Creating and Importing the FactoryTalk Transaction Manager Configuration ............................................................... 130

Registering the FactoryTalk Transaction Manager Configuration for Data Collection ............................................................................. 135 Configuring the FactoryTalk Metrics ............................................ 135 Modifying Performance Parameters ............................................... 137 Configuring Reports .......................................................................... 139 Starting a Data Collection ................................................................ 140

Chapter 6

Create a New RSBizWare Report ........................................................ 141 Insert Text, Pictures, and Hyperlinks Into Your Report ................ 142 View Your Report In Preview Mode ................................................... 143 Save Your Report ...................................................................................... 143 Add a Saved Report Object To Your Report..................................... 146

Adjust the Time Range For a Time-based Report Object ........ 149 Configure the Report Object To Use Global Credentials ............. 151 Create a New Chart ................................................................................. 154

Step 1: Plan the Chart ........................................................................ 155 Step 2: Select the Data On Which To Report ............................. 156 Step 3: Choose a Chart Type ........................................................... 156 Step 4: Describe the Data .................................................................. 156

Analyzing FactoryTalk Metrics Data

Table of Contents


Step 5: Select Summary or Detail .................................................... 157 Step 6: Select the Fields To Be Charted ........................................ 157 Step 7: Enter the Chart Title ........................................................... 159 Step 8: Filter the Data ........................................................................ 159 Step 9: Insert Your New Chart Into the Report ......................... 162

Create a New Text Report Object ....................................................... 163 Step 1: Start the Text Report Object Wizard .............................. 163 Step 2: Select the Data On Which To Report ............................. 164 Step 3: Group the Records ................................................................ 165 Step 4: Sort the Records .................................................................... 165 Step 5: Format the Table ................................................................... 167 Step 6: Name the Report Object ..................................................... 169 Step 7: Filter the Data ........................................................................ 169 Step 8: Insert Your New Table Into the Report .......................... 169

Create an OEE Box Chart...................................................................... 170 Step 1: Start the BizBikes Project .................................................... 171 Step 2: Insert Your New Chart Into the Report ......................... 171 Step 3: Select an Activity Area ......................................................... 171 Step 4: Specify the Layout of the Chart ......................................... 172 Step 5: Create a Filter ......................................................................... 173 Step 6: Customize the OEE Bar Colors ........................................ 174 Step 7: Preview Your OEE Box Chart ........................................... 175

Create a FactoryTalk Metrics Detail Chart ....................................... 176 Export the Report To HTML............................................................... 178 Load Report From File ............................................................................ 179

Chapter 7 Customizing Charts ................................................................................ 181

Working With the Component Parts of a Chart ....................... 182 Resize a Component ..................................................................... 182 Move a Component ...................................................................... 182 Delete a Component ..................................................................... 182 Edit the Chart Title or Text Field ............................................. 183 Change Chart Component Properties ..................................... 183

Working With Chart “Pens” ........................................................... 183 Customizing Text Report Objects ....................................................... 183

Customizing RSBizWare Charts and Tables

Table of Contents


Show and Hide Columns .................................................................. 184 Resize Table Columns ....................................................................... 185

To resize a column: ........................................................................ 185 To remove a column by resizing it: ............................................ 185

Aggregate, Group, Format, Sort, Chart, and Rename Columns ................................................................................................................. 185

Aggregate ......................................................................................... 186 Group ............................................................................................... 186 Format .............................................................................................. 187 Sort .................................................................................................... 187 Chart ................................................................................................. 188 Rename ............................................................................................. 188

Quick Filter .......................................................................................... 188

Chapter 8

The Excel Add-in ..................................................................................... 189 Scheduling Report Objects and Reports ............................................. 193

Schedule a Report Object .................................................................. 194 Schedule a Report ............................................................................... 198 View the History of the Scheduled Task ....................................... 198

Analyzing Non-RSBizWare Data ........................................................ 199 Create an External Data Source....................................................... 199 Create a Report Data Source ............................................................ 200

Step 1: Start the Report Data Source Wizard ......................... 200 Step 2: Give the Report Data Source a Name ......................... 201 Step 3: Select a Database Table or View ................................... 202 Step 4: Choose the Columns That Will Be Included ........... 203 Step 5: Enable the Time Selection Toolbar ............................. 205 Step 6: Specify the Format of the Table or View.................... 206 Step 7: Specify the Role That Each Field Plays In Time-Series Analysis ............................................................................................ 208 Step 8: Create a Data Point Configuration Table ................. 209

User-derived Fields .................................................................................. 210 Create Detailed Derived Fields ........................................................ 211 Create Summary Derived Fields ...................................................... 215

Advanced Reporting Topics

Table of Contents


Chapter 9

Plant Model Element State Icons ......................................................... 219 Performance Parameter Event State Icons ......................................... 220

Chapter 10 Report Permissions .................................................................................. 222 Report Object Permissions .................................................................... 222 Filter Permissions ..................................................................................... 223 Report Data Source Permissions .......................................................... 223

Appendix A The FactoryTalk Metrics Workcell History Report Data Source 225 The FactoryTalk Metrics Event History Report Data Source ...... 226 The FactoryTalk Metrics Machine State Data Report Data Source ....................................................................................................................... 228

FactoryTalk Metrics Icon Definitions

Object Permissions

Workcell History, Event History, and Machine State Data

Table of Contents



Chapter 1

Welcome to FactoryTalk Metrics

Companies in the discrete and repetitive manufacturing industries are being challenged by management to maximize production from existing lines, to meet required cycle-times and delivery dates for each product, and to reduce costs. To meet this challenge, production management is striving to operate the equipment at its highest efficiency.

Real-time identification of production assets that are not performing to a standard is critical to maintaining world-class efficiency. A thorough understanding of the details behind production performance will allow you to identify sources of production inefficiencies and to maximize asset utilization.

The RSBizWare software is a suite of tools and services aimed at increasing your manufacturing floor effectiveness and profitability with solutions that target performance analysis and improvement and with data acquisition and integration. FactoryTalk Metrics is just one of the applications that is available within the RSBizWare software. FactoryTalk Metrics builds on the report, analysis, and management capabilities of the RSBizWare software by providing a powerful, yet simple set of tools to analyze the performance of production assets.

FactoryTalk Metrics provides ratings—Overall Equipment Effectiveness (OEE), Mean Time Between Failure (MTBF), and Mean Time to Repair (MTTR)—that will allow you to evaluate the performance of your production assets. A production asset (or activity area) can be anything from a single piece of equipment to a complete manufacturing plant. These ratings provide a simple way to determine quickly whether a production asset is performing adequately based on data collected from the control system.

What Is FactoryTalk Metrics?

Chapter 1 Welcome to FactoryTalk Metrics


FactoryTalk Metrics offers the following features and benefits:

• Rich reporting, graphing, analyzing, and querying functionality provide a complete and easy-to-use solution for performance analysis.

• High-level analysis tools to easily identify poorly performing assets, including the ability to drill into the underlying detail to identify the causes of production inefficiencies.

• The ability to evaluate every production asset based on OEE, MTBF, and MTTR ratings.

• The ability to isolate each asset so that its rating is not affected by upstream or downstream performance.

• The ability to connect most of the OEE parameters to either a data point or a formula, providing flexibility in the configuration of the OEE rating.

• The ability to embed a report object in any Microsoft ActiveX container, such as Visual Basic or Internet Explorer.

The FactoryTalk Metrics User Guide is designed to help you understand how to access and use the FactoryTalk Metrics product. This document focuses on the end-user functions of FactoryTalk Metrics and does not cover installation and operation of underlying system services.

This document is intended for the following three types of users of the FactoryTalk Metrics software:

This is the individual who configures the RSBizWare system so that it can capture performance data for use by report designers and report users. This individual should be familiar with:

• Control systems, process information (line and plant), and databases.

Features and Benefits

Intended Audience

RSBizWare Administrator

Welcome to FactoryTalk Metrics Chapter 1


• Microsoft Windows operating systems.

• The location and structure of external databases that will be analyzed within FactoryTalk Metrics.

This is the individual who creates the reports that will be used by report users. This individual should be familiar with:

• Process information (the physical line and plant).

• The Microsoft Windows operating system that is running on the machine being used.

• Windows UI operations such as drag-and-drop and using right-click shortcut menus.

• Query logic (how to write a database query).

• Web publishing tools such as Microsoft FrontPage.

• If the report designer will be using FactoryTalk Metrics to report on custom data models, he should be familiar with the location and structure of those databases.

This is the individual who makes use of the reports created by the report designer to perform his job. This individual should be familiar with:

• The Microsoft Windows operating system that is running on the machine being used.

Our commitment to your success starts with the suite of learning aids and assistance we provide with FactoryTalk Metrics. Consult the following resources for additional information about this product:

The electronic release notes provide a list of the hardware and software that are necessary to use the FactoryTalk Metrics software effectively, as well as a list of known issues, issue fixes, and features

Report Designer

Report User

Where Can I Go for Help?

Reference the Release Notes



that are available in the current release of the software. The release notes are available from the RSBizWare software installation DVD and from within the online help system.

The Administration Guide is designed to help the RSBizWare administrator install and configure the software and to understand the components that make up the RSBizWare suite of products. The first chapter of the guide provides an overview of the software components that make up the RSBizWare suite and describes the architecture on which they are built. The remaining chapters describe the installation steps and available options when deploying the RSBizWare software.

An electronic copy of the guide is available from the RSBizWare software installation DVD.

The online help provides general overview information, comprehensive step-by-step procedures, quick-start topics, and context-sensitive control definitions (for example, text boxes, drop-down lists, and option buttons) for working with all of the features in FactoryTalk Metrics.

To view online help while running the FactoryTalk Metrics software:

• Select Help > Configuration Console Help from the menu in the Configuration Console.

• Click the Help button on any FactoryTalk Metrics dialog box.

• Tab to a control in the dialog box and press F1.

One of the best ways to increase your proficiency at using Rockwell Software products is to attend Rockwell Software training programs. Our training programs can help you master the basics and show you how to unleash the full potential of our software.

Reference the Administration Guide

Reference the Online Help

Get RSBizWare Training

Welcome to FactoryTalk Metrics Chapter 1


We offer a wide range of training programs, from regularly scheduled classes conducted at Rockwell Automation facilities to custom-tailored classes conducted at your enterprise. The size of each class is kept small intentionally to maximize student engagement.

If you would like more information about our training programs, visit the Rockwell Software site on the World Wide Web or contact the Rockwell Software Training Coordinator. Our World Wide Web address and telephone numbers appear on the inside of the front cover of this document.

TIP For web-based product support, and for detailed information on technical support resources, please visit the support site.

Access the Rockwell Automation Knowledge base for 24/7 technical information and assistance. You can also download software patches and new software versions, ask questions via email, participate in user forums, and access other useful problem-solving tools.

The support resources available vary depending upon the product purchased. The latest information can be obtained from the Rockwell Automation Technical Support website.

A current TechConnect Support contract may be required to use some online features.

To speak with a Technical Support representative in North America, call 1-440-646-3434.

For information on how to contact Technical Support in other locations worldwide, please visit the support site.

A current TechConnect Support contract may be required to obtain phone support.

Get Web Support

Get Phone Support



Rockwell Automation provides expert consulting and turnkey implementation of this product. Please contact your local representative for more information.

We strive to help all of our customers become successful in their manufacturing improvement efforts. Toward this objective, we invite you to contact your local representative or Rockwell Automation at any time that we may be of service to you.

Get Consulting Services

Contact Us


Chapter 2

The BizBikes Factory

This chapter describes a sample company, BizBikes, Inc., whose manufacturing system will be referred to in upcoming tutorials. BizBikes manufactures bicycles that are sold to independent bicycle shops. The BizBikes factory was selected because it contains representative key features of the RSBizWare product suite, including FactoryTalk Historian Classic, FactoryTalk Metrics, FactoryTalk Transaction Manager, and FactoryTalk Transaction Manager.

Roll up your sleeves and take a walk through the factory with us as we study the system and how it operates. Let’s start by learning about the business environment, and then we’ll spend some time getting familiar with the manufacturing process.

BizBikes produces bicycles in two different styles—Standard (SSD) and High Performance (SHP)—and in two different colors (red and blue). With the exception of the frames, the two models and color variations use all the same manufactured and purchased components.

The BizBikes manufacturing facility can be broken into these logical areas:

• Machining and Fabrication

• Paint Shop

• Subassembly

Introducing BizBikes

How BizBikes Are Manufactured

Chapter 2 The BizBikes Factory


• Final Assembly and Ship

There is also an Original Equipment Manufacturer (OEM) resident on the BizBikes campus who manufactures bicycle seats. BestSeats supplies the finished bicycle seats to BizBikes for final assembly.

In the machining and fabrication area, BizBikes manufactures the frames, seat posts, handlebars, and neck posts. These component parts are produced by processing raw material through a series of work cells that cut, bend, machine, and weld components. After parts complete the machining and fabrication steps, the frames are batched and sent to the paint shop, and the other component parts go into inventory where they can be pulled from stock as needed to meet demand in the assembly area. In the next stage, each bicycle is assembled based on customer order requirements with parts and subassemblies (both manufactured and purchased) supplied from inventory. In the last step, the bicycle (with its wheels and handlebar removed) is packed in a corrugated box and shipped.

BizBikes has been losing market share to competitors due to both pricing pressure and problems with on-time delivery. Business conditions have forced a transition from make-to-stock to make-to-order, and the bicycle shops that receive the goods are complaining about frequent late deliveries. Thin margins and decrease in market share have produced losses for the past two quarters. A task force was set up to analyze the problem and to recommend a solution that will improve key performance indicators, such as lowering our manufacturing costs, shortening our production time, and improving our on-time delivery.

Challenges:

• Essential to quote accurately and meet delivery dates.

• Access to the Internet puts competitor information and alternative suppliers at customers’ fingertips.

BizBikes Business Problems

The BizBikes Factory Chapter 2


• Must provide accurate, up-to-the-minute information on order and shop-floor resource status to the rest of the organization.

• Critical to monitor, analyze, and improve the manufacturing processes through up-to-date software and information technology.

• Must drive down the cost of manufacturing while maximizing resource utilization and machine uptime.

BizBikes will deploy FactoryTalk Metrics in the Machining and Fabrications areas of the plant, as well as in the Paint Shop. These areas have a high level of automation, and BizBikes seeks to maximize the resource utilization and machine uptime in these areas, which will drive down manufacturing costs. BizBikes also hopes that monitoring and analyzing performance in these areas will help improve the manufacturing process.

The BizBikes application encompasses five work cells: Cut, Bend, Machine, Weld, and Finish. FactoryTalk Metrics monitors the availability, performance, and quality for each work cell and computes a high-level Overall Equipment Effectiveness (OEE) rating. BizBikes is also interested in analyzing how much time each work cell spends in non-productive states, so FactoryTalk Metrics also monitors various downtime conditions, operations that interrupt production, and standby states. This information shows BizBikes where equipment efficiency problems are and helps them understand how to improve manufacturing performance.

Before you begin the tutorials described in this manual, you or your RSBizWare administrator should install the BizBikes project.

For more information, see the Rockwell Automation Knowledgebase (http://rockwellautomation.custhelp.com/), Answer no. 465006, BizBikes sample project for FactoryTalk Metrics.

How FactoryTalk Metrics Will Help Solve the BizBikes Production Problems

Tutorial Prerequisites

http://rockwellautomation.custhelp.com/

Chapter 2 The BizBikes Factory



Chapter 3

Getting Started

Before you walk through the examples and tutorials that are discussed in this book, it is assumed that the RSBizWare administrator has installed, configured, and started the RSBizWare Server on the server computer.

The RSBizWare architecture is a scalable, multi-tiered, distributed architecture consisting of a data collection sub-system, an Oracle or SQL Server database repository, the Information Services Manager, and clients. Rockwell Automation’s FactoryTalk Transaction

The RSBizWare Architecture

Chapter 3 Getting Started


Manager is the embedded engine that collects data from the control system(s) and the Metrics Server Manager logs it to the predefined RSBizWare database repository. There are several types of clients, including the Configuration Console and the Internet Explorer Web client.

The RSBizWare architecture can be configured to run on a single computer, or it can be distributed across multiple computers. In the simplest case, the Configuration Console, the Information Services Manager, the RSBizWare Administrative tools used by the RSBizWare administrator, the database, the Metrics Server Manager, and the FactoryTalk Transaction Manager data collection engine run on a single computer. In a distributed setting, these components may reside on separate computers. Clients connect to the Information Services Manager using TCP/IP, so they can be deployed over a LAN, WAN, intranet, or the Internet. The scalability of the RSBizWare architecture allows many clients to connect to a single server.

RSBizWare reports created by the report designer are saved to the Information Services Manager and are available online over a TCP/IP network. Most users will wish to view RSBizWare reports using Microsoft Internet Explorer; however, if you also wish to create and edit RSBizWare reports, you will need to run the Configuration Console.

By using Microsoft Internet Explorer to view RSBizWare reports, you can connect to the Information Services Manager without having the RSBizWare software installed on your computer; instead, the server hosts a special Web page, the Quick Web, to give you access to RSBizWare reports stored on the server. This option only allows you to view RSBizWare reports.

To access the Quick Web, open Internet Explorer, enter the Web address for the Information Services Manager computer in the

Connecting to the Information Services Manager

Using Microsoft Internet Explorer

Getting Started Chapter 3


Address Bar of the Web browser, and press the Enter key on your keyboard.

NOTE The Web address is made up of the name of the server computer and the HTTP port number used by the server computer, separated by a colon. For example, if you were attempting to connect to a server computer named “rsi-rockwell” that uses the default HTTP port 8080, you would use the address http://rsi-rockwell:8080 Please contact your RSBizWare administrator for the specific Information Services Manager Web address to which you should connect.

The first time you try to use the Quick Web, you must download the several ActiveX controls from the server computer. The download will begin automatically.

After you have downloaded the ActiveX controls from the Information Services Manager, you may be prompted to login. If prompted, enter the user name and password for the account your RSBizWare administrator has authorized for you and click OK. You now have established a connection to the RSBizWare Server.

If you wish to configure your plant model, manage the collection of control system data, and/or edit RSBizWare reports, you should connect to the Information Services Manager via the Configuration Console. Your RSBizWare administrator must assign a FactoryTalk Metrics Author license and the appropriate privileges to you before you will be able to perform these functions.

You must have the Client software installed on your computer before you can run the Configuration Console. To install the Configuration Console from the RSBizWare DVD, select the Minimal installation option.

1. To start the Configuration Console, select Programs > Rockwell Software > RSBizWare > Configuration Client from the Windows Start menu. The Login dialog box will appear.

Using the Configuration Console

http://rsi-rockwell:8080/



2. If prompted, enter the user name and password for the account your RSBizWare administrator has authorized for you, enter the name of the server computer where the Information Services Manager is running in the Server text box, and click Login. You now have established a client session with the RSBizWare Server.

NOTE When you first login to the Configuration Console on a Windows Server 2003 computer or a Windows XP (Service Pack 2) computer, you might get the following warning: “Content from within this application coming from the Web site listed below is being blocked by Internet Explorer Enhanced Security Configuration.” This message is displayed if you are using the Windows default security settings on the preceding operating systems. To prevent this message from appearing again and to be able to use the full functionality of the Configuration Console, do the following: 1. Add this Web page to your trusted sites by clicking Add in the

Internet Explorer dialog box. 2. Click Add and Close in the Trusted sites dialog box. 3. Click Close in the Internet Explorer dialog box. 4. Restart the Configuration Console.

Every (Windows) user will need to follow this procedure the first time they login to the Configuration Console.

The status bar at the bottom of the client application shows your user name, the activations that have been assigned to you, and the Information Services Manager to which you are connected.

When you start the Configuration Console, you will notice that the user interface is made up of two main components: the Report Explorer and the report design and display work area.

Exploring the User Interface

Getting Started Chapter 3


The Report Explorer is a hierarchical navigation tool used for organizing RSBizWare reports that have been saved for future use. The Report Explorer contains the reports that have been saved on the Information Services Manager to which you are connected and for which you have been granted view permissions. Your ability to modify and delete the reports listed on the Report Explorer is dependent on the licenses and features that have been assigned to you by your RSBizWare administrator and the permissions that have been granted to you by the creator of each individual report.

When you click an item in the Report Explorer, the specified RSBizWare report will display in the work area to the right of the Report Explorer. The work area is the region where report designers can create and modify reports.

Many areas of the application give you access to a shortcut menu. The shortcut menu allows you to perform frequently used commands without using the main application menu or toolbar buttons. To view the shortcut menu, right-click in an area of the application. The shortcut menu will contain commands that are appropriate for the area where you right-clicked. For example, if you

The Report Explorer

The Report Design and Display Work Area

Shortcut Menus



right-click the Report Explorer, the shortcut menu will contain commands that apply to the Report Explorer.


Chapter 4

Collecting Performance Data

The primary functions of FactoryTalk Metrics are to collect and analyze production data to provide performance ratings for every activity area. Before the report designer can create performance rating reports for the report user, the RSBizWare administrator must set up the application to collect data from the control system.

This chapter will help you understand the two key categories of ratings used to evaluate the performance of a production asset and to understand how to identify and configure the data points that will be used to collect the production data necessary to calculate performance ratings. We will:

• Define the OEE and Fault Metrics ratings.

• Configure the FactoryTalk Metrics application, including plant model configuration, time pattern configuration, time pattern exception configuration, composite time pattern configuration, and performance parameter configuration.

• Start and stop data collection.

• Perform manual data collection.

The tutorials in the next chapter, "Analyzing FactoryTalk Metrics Data (page 141)", will help you understand how to analyze the data that is collected in FactoryTalk Metrics.

In version 7.0 of FactoryTalk Metrics a change was made how data collection is initialized. Prior to this it was possible to have partial FactoryTalk Transaction Manager .rsl files (still stored on disk when data collection started) processed as current data values. This approach could lead to inaccurate count information being recorded in the event of a part count reset in the control system. The most

Collecting Part Count Data When the Metrics Server Manager Is Stopped

Chapter 4 Collecting Performance Data


serious effect of this issue was seen when a counter used in a FactoryTalk Metrics part count formula was reset and the resulting formula evaluated to a negative number. The change required that the initial data used as a baseline for calculations all come from the same time period. In certain environments with continuous counters that do not get reset, this change could result in the loss of count data that was collected erroneously in previous versions. The data collected in this way can account for part counts that were produced since the last time the Metrics server was running.

In order to accommodate customers that found this data useful the Metrics Server Manager settings file (PlantMetricsServerSettings.xml) can be configured so that it forces the Metrics Server Manager to initialize its data in the pre-7.0 manner.

The file is located in C:\Program Files\Rockwell Software\RSBizWare (if you accepted the default installation path). It contains an InitializeFromSingleTimestamp tag that is set to 1 by default. The default value causes the Metrics Server Manager to process data in the standard way to prevent the inclusion of older data. Changing this value to 0 will force the Metrics Server Manager to process data without regard for its timestamp. This change may be appropriate for some production environments but in others may lead to incorrect values being logged for count information.

For more information on the Metrics Server Manager settings file, see the Administration Guide, section "The Metrics Server Manager Settings File".

FactoryTalk Metrics uses an OEE (Overall Equipment Effectiveness) model to measure the performance of manufacturing equipment. The OEE model yields a single performance rating for every activity area (work cell, line, area, or plant) being monitored, thereby providing a simple way to determine quickly if an activity area is performing adequately. The OEE value can be used to assess a

What Is the OEE Rating?

Collecting Performance Data Chapter 4


single machine’s performance over time or to compare the performance of machines to each other.

Three components contribute to an OEE value: availability, throughput, and quality. Each is a percentage, and the OEE value is the product of these three percentages, and therefore is also a percentage.

Availability is a ratio of running time to available time. Available time may be defined by a schedule or modified by planned downtime events such as preventive maintenance. Available time may also be modified by events such as being starved for parts or being blocked by a downstream process.

Availability = RunningTime / AvailableTime

Throughput is the performance of a machine when it is running compared to its ideal cycle time. The ideal cycle time will depend upon the product being produced and is measured in units of seconds per part.

Throughput = (TotalParts x IdealCycleTime) / RunningTime

Quality is the percentage of good parts that are produced.

GoodParts = TotalParts – Scrap

Quality = GoodParts ⁄ TotalParts

The OEE calculation that is used by FactoryTalk Metrics is the product of these three components:

OEE = Availability × Throughput × Quality



This reduces to:

FactoryTalk Metrics gathers and stores all of the raw data necessary to make this calculation for specific time periods, as well as by activity area, by part number, and by shift. All of the individual components of the calculation are stored and available for analysis.

OEE is a valuable method of analyzing performance because it is widely recognized and can be applied to any type of industry, factory, or machine. But it is merely the default efficiency calculation performed by FactoryTalk Metrics, and additional or alternate calculations can be implemented. Furthermore, FactoryTalk Metrics supports the collection of detailed event data, which can be used to analyze the specific causes of inefficiencies.

FactoryTalk Metrics uses the Fault Metrics ratings to measure the reliability of manufacturing equipment. These metrics provide a simple way to determine quickly if an activity area is performing reliably. The fault metrics values can be used to assess a single machine’s reliability over time or to compare the reliability of machines to each other.

Mean Time Between Failure (MTBF) measures the average amount of time that a piece of equipment was in a running state between failures. (Mean Time Between Failures.) The ratio of running time to the total number of failures. The calculation for this field is: MTBF = Uptime ⁄ FaultCount.

MTBF is the ratio of running time to the total number of failures. MTBF is a derived field that contains aggregate functions and, as such, can only be used in summary report objects and cannot have aggregate functions applied to it.

What Are Fault Metrics?

Mean Time Between Failure



MTBF = RunningTime ⁄ TotalFailures

Mean Time to Repair (MTTR) measures the average amount of time that a piece of equipment was in a failure state. (Mean Time To Repair.) The ratio of time spent in a failure state to the total number of failures. The calculation for this field is: MTTR = FaultTime ⁄ FaultCount.

MTTR is a derived field that contains aggregate functions and, as such, can only be used in summary report objects and cannot have aggregate functions applied to it.

NOTE To collect fault metrics for an activity area, you will need to create custom events for the work cell. See the “View Performance Parameter events” topic in the online help for information on creating custom events.

• The plant model is made up of activity areas—enterprises, sites, areas, lines, and work cells—and of equipment and labor resources. These are based on terms that the Instrument Society of America (ISA) S95 standard defines in order to provide common terminology for improved communication and integration between control systems and enterprise systems.

• A work cell is a location and/or group of equipment used to perform work in a manufacturing process. The operations in a manufacturing process are performed at work cells. A work cell is typically a physical location and a primary resource (e.g., a machine); however, it may also represent a logical grouping of primary resources from which a selection is made.

• A line is a collection of one or more work cells that are combined to perform work. The work cells in a line are either physically located close to one another or are related to one

Mean Time To Repair

Configure the Plant Model



another in the production process (the production result of the first work cell in a line feeds the second work cell in the line).

• An area is a physical, geographical, or logical grouping of lines and/or work cells within a site, typically representing a main production capability (e.g., electronic assembly) within a manufacturing location.

• A site is a group of areas, lines, and work cells representing a geographical location at which products are manufactured.

• The enterprise is the highest-level activity area, typically representing the business.

The plant model that you configure for FactoryTalk Metrics may be used by all RSBizWare applications—FactoryTalk Metrics, FactoryTalk Historian Classic, FactoryTalk Scheduler, and Arena—in your organization. In FactoryTalk Metrics, the enterprises, sites, areas, lines, and work cells in your plant model will be the subjects of your performance parameter evaluation. For implementations of RSBizWare that incorporate the FactoryTalk Scheduler application, the plant model also will include a level below the work cell that defines individual resources that perform work. FactoryTalk Metrics performance parameters can also be configured for resources.

NOTE To create and edit the plant model, you must be granted the Organize Plant Model privilege by your RSBizWare administrator.



1. To describe your plant to the Configuration Console, select Configure > Plant Model from the main menu. The Plant Model Configuration dialog box will display.

The BizBikes and BestSeats enterprises have already been created in the sample data. For this tutorial, we will create another sample enterprise and a site, an area, a line, and several work cells that belong to the sample enterprise.

2. First, we will create the enterprise. Right-click in the white space below the plant model tree and select New Root Enterprise from the shortcut menu. Our new enterprise will display in the Plant Model tree.

3. The default name of the enterprise (New Enterprise) is highlighted to indicate that it is ready to be changed. Enter a new name for the enterprise, Sample Enterprise, and press the Enter key on your keyboard to accept the change.



4. Now, right-click the enterprise that we just created and select New Activity Area > Site from the shortcut menu. Our new site will display in the plant model tree. Change the name of the site to Sample Site.

5. Add an area and a line to the plant model tree using the same method. Name the area Sample Area and name the line Sample Line.

Now we are ready to create the individual work cells that make up the Sample Line.

1. Right-click the Sample Line and select New Activity Area > Work Cell from the shortcut menu. Our new work cell will display in the plant model tree. Enter the name Sample Work Cell 1 and press the Enter key on your keyboard to accept the changes.

2. Repeat the previous step to create Sample Work Cell 2 and Sample Work Cell 3.

3. To be able later to associate time patterns with the activity areas, we must add the capacity property to each line and work cell. The capacity of an activity area describes its availability over time. To configure capacity for the line and three work cells, right-click each of them and select Add Capacity from the shortcut menu. A Capacity entry will be added to the tree below each activity area.

4. Click OK to save your changes to the plant model and close the dialog box.

Now we are ready to create the time patterns that will define the availability of the activity areas in our plant.

FactoryTalk Metrics allows you to create the time patterns that will be used to calculate the amount of available time for an activity area. The OEE calculation is based on available time, so the OEE

Configure an Activity Area Schedule



calculation will not be accurate unless the available time is defined accurately.

It is not necessary for you to use a time pattern to define available time for an activity area; however, if you do, the OEE calculation for the activity area will not be negatively impacted by the periods of time when the activity area is scheduled to be unavailable (e.g., weekends, evenings).

NOTE To define time patterns, configure composites, and schedule exceptions, you must be granted the Manage Time Pattern privilege by your RSBizWare administrator.

A time pattern defines the availability of an activity area over time, which repeats as necessary during the activity area schedule. We can define the duration of the repeating period as a Day, Week, or Custom. A Day duration defines a time pattern for a 24-hour day, a Week duration defines a time pattern for a standard 7-day week, and the Custom duration defines a time pattern for an arbitrary duration, such as a 14-day cycle or an 8-hour shift. In this example, we will make use of the Custom, Day, and Week options.

A time pattern is composed of a default value and a series of time spans. The default value defines the value of the time pattern during intervals where no time span is specified. Each time span specifies a start time, end time, value (e.g., Available, Unavailable), and optional report name for the span. The default value for the time pattern and the value for the time span can be a named state, a numeric value, or another time pattern. Named states are simply a set of values (e.g., 1, 0) to which you have applied descriptions (e.g., Available, Unavailable).

Our sample activity area follows a time pattern that consists of three 8-hour shift periods—each with a 30-minute break

Step 1: Define Time Patterns



(Unavailable)—that make up the work day. This time pattern applies Monday through Friday, and the facility is closed (Unavailable) during the weekends.

The ability to reference other time patterns allows us to build time patterns from other time patterns. In our example, we will define three shift time patterns, a Work Day time pattern that is made up of the shifts, and a Work Week time pattern made up of five Work Days.

First, we must define the three shift time patterns.

1. From the main menu, select Configure > Time Pattern to display the Time Patterns dialog box.

2. Right-click a folder in the Time Patterns tree at the left-hand

side of the dialog box and select New Time Pattern from the shortcut menu. Our new time pattern will be displayed in the Time Pattern tree.

3. The default name of the time pattern (New Time Pattern) is highlighted to indicate that it is ready to be changed. Enter the new name for the time pattern, Shift A, and press the Enter key on your keyboard to accept the change.



You will notice that the Default Value Type is set to State and the Default Value is set to Unavailable. This indicates that any periods of time that are not specified as Available in the Time Spans list will be designated as unavailable.

4. Our shift times will be relative to the start and end times specified in the Work Day time pattern, so clear the Lock Times check box above the Time Spans list.

5. Since we want our shift to last 8 hours, click the Browse button (...) next to the Duration box. The Time Pattern Duration dialog box will appear.

6. Select the Custom option for Duration Type and enter a

duration of 8 Hours. Click OK to return to the Time Patterns dialog box.

7. In the Report Name box, enter Shift A. In the Shift box, enter the shift number that you want to use to refer to this shift when reporting on the FactoryTalk Metrics data that is collected. For this example, enter 1.



8. Right-click the time span grid at the right and select New Time Span from the shortcut menu. The Time Span dialog box will display.

9. Make sure the Value Type is set to State and the Value is set to

Available.

10. Specify this time span as starting at hour 0 and ending at hour 4. Remember that our shift times are relative, so these times mean “start of shift” and “4 hours into shift time”.

11. Click OK to save your changes and close the dialog box.

12. Create a second time span. Set the value to Available and specify this time span as starting at 4:30 and ending at 8.



13. Click OK to save your changes and return to the Time Patterns dialog box. Because we set the Default Value of the time pattern to Unavailable, the half hour between time spans is unavailable (i.e., shows a capacity of 0 in the time pattern chart).

14. Now we will make two copies of Shift A. To make a copy of

the time pattern, right-click Shift A in the Time Patterns box and select Duplicate from the shortcut menu. The new copy of the shift is displayed in the tree. Change the name of the new shift to Shift B. Create another copy of Shift A and name it Shift C.

15. Click Shift B to display its properties in the Time Patterns window. Change its Report Name to Shift B and its Shift number to 2, so that data collected during times covered by this time pattern will be logged under this reporting information.

16. Edit Shift C to change its Report Name to Shift C and its Shift number to 3.



Now that we have built our shift time patterns, we can use them to build the Work Day time pattern.

1. With the Time Patterns dialog box open, create a new time pattern and name it Work Day.

2. Leave the Report Name and Shift fields blank; data will be recorded using the report information defined in the individual shift time patterns that we will reference in the time spans.

3. Create a time span for the first shift in this time pattern by right-clicking the time span grid at the right and selecting New Time Span from the shortcut menu. In the Time Span dialog box, select Time Pattern from the Value Type list and Shift A from the Value list. The Time Span dialog box uses the 0 hour to represent 12:00 midnight. Set the Start time to 0 (midnight) and the End time to 8 (8:00 AM).

The Shift A time span should look like the example below.


Work Day Time Pattern



5. Create a time span for Shift B where the shift starts at 8. We want this time span to end at 4:00 PM, and since times must be entered in 24-hour format, specify this time span as ending at 16.

6. Now create a time span for Shift C. Start the shift at 16 and end it at 24.

After you have completed these steps, the Work Day should look like the example below.

Now that we have built our Work Day pattern, we can use it to build the Work Week time pattern.

1. With the Time Patterns dialog box open, create a new time pattern and name it Work Week.

2. Click the Browse button (...) next to the Duration box. The Time Pattern Duration dialog box will appear.

3. Change the time pattern duration to 1 Week and click OK to return to the Time Patterns dialog box.

4. Create the first time span for this work week by right-clicking the time span grid at the right and selecting New Time Span from the shortcut menu. Select Time Pattern from the Value

Work Week Time Pattern



Type list and select the time pattern named Work Day for the value. Enter the first time span as starting on Monday at 0 (Monday at midnight), and ending on Tuesday at 0 (Tuesday at midnight).

5. Repeat this for Tuesday, Wednesday, Thursday, and Friday.

After you have completed these steps, the Work Week should look like the example below.

6. Take a few minutes to look at the other time patterns that are

provided with the sample data. These samples will illustrate how to create other types of time patterns.

7. Click OK to save the changes that you have made since opening the Time Patterns dialog box and to close the dialog box.

A composite is a base time pattern that is associated with an activity area. The time pattern defines the normal schedule for the activity area and the composite may have exceptions that define any changes to the normal schedule.

In this example, we will use Work Week as the base time pattern for the sample line and work cells we defined in our plant model.

Step 2: Configure Composites



1. From the main menu, select Configure > Composite Time Pattern to display the Composite Time Patterns dialog box.

2. In the Elements tree at the left of the dialog box, expand the

Sample Enterprise item and each item underneath down to the Sample Line item. Select the Capacity item under the Sample Line.

NOTE If there is not already a Capacity tree item under the Sample Line, you will need to add one in the Plant Model Editor. See "Configure the Plant Model (page 31)" for instructions on how to add a capacity to an activity area.

A composite may have exceptions that define irregular, but expected, changes to the normal schedule. These exceptions may be outages (unavailable times) such as holidays or planned maintenance periods, or additional available times such as overtime hours or extended seasonal hours. In this example, we will schedule an exception for New Year’s Day.

1. Make sure the Composite Time Pattern dialog box is still displayed. Select the Capacity item under the Sample Line.

Step 3: Schedule Exceptions



Right-click the Exceptions grid and select New from the shortcut menu to display the Exception dialog box.

2. Enter New Year’s Day in the Description box.

3. Accept the default values of State for the Value Type list and Unavailable for the Value list.

4. Specify this exception as starting on January 2, 2006, at 0 and ending on January 3, 2006, at 0.

You will notice that the Sample Line is listed in the Applications box on the lower right side of the dialog box. This indicates that you are creating this exception for the Sample Line only. This does not mean that the exception applies to the work cells under it.

If you wanted to apply this exception to another work cell, you would select the name of the work cell in the Elements box on the left and click the arrow button (>) to move the individual work cell. To apply the exception to an entire branch of the tree, you would select the parent tree item (in this case, Sample



Line) and click the double arrow button (>>). The individual work cells under Sample Line will be added to the list.

5. Click OK to save your changes and return to the Composite Time Patterns dialog box.


Now that you have created your plant model, created a time pattern, and associated the time pattern with activity areas in your plant, you can set additional parameters that will be used to measure the OEE rating and gather custom events for these activity areas.

FactoryTalk Metrics provides a great deal of flexibility in how you configure the parameters that will be used to measure an activity area’s OEE rating. At a minimum, you must provide the following information:

• The FactoryTalk Transaction Manager configuration that will be the link to the control system.

• The amount of time it should take the activity area to produce one good part (ideal cycle time).

• The control system counter that is keeping track of production counts.

For more sophisticated configurations, you can define other key parameters and custom events. You can connect many of the parameters either to a data point in the control system or to a formula. Depending on the sophistication of your control system, you can use a combination of data points and formulas. This tutorial illustrates the different methods that you can use to configure performance parameters.

NOTE To configure OEE performance parameters for an activity area, you must be granted the Manage Performance Parameters privilege by your RSBizWare administrator.

Configure OEE Performance Parameters For an Activity Area



1. From the main menu, select Configure > FactoryTalk Metrics > Performance Parameters to display the Manage Performance Parameters dialog box.

2. In the tree, browse for the activity area for which you want to

configure performance parameters and click Configure to display the Configure Performance Parameters dialog box. This dialog box allows you to establish the parameters that will be used to collect performance data and measure the OEE rating for the activity area.

For this tutorial, select the Sample Work Cell 1 work cell and click Configure.



If the FactoryTalk Transaction Manager configuration associated with this activity area were running and enabled for online edits, you could edit the performance parameters of the selected activity area without stopping the configuration. If the configuration were running and not enabled for online edits, you could not make changes to the configuration until the configuration was stopped.

NOTE The FactoryTalk Transaction Manager Live Data Migration Tool allows you to enable configurations that are not currently enabled for online edits. For additional information about editing a running configuration and using the FactoryTalk Transaction Manager Live Data Migration Tool, see the "Online Edits" topic in the online help.

Before you can configure the performance parameters, you must select the associated FactoryTalk Transaction Manager configuration from the FactoryTalk Transaction Manager Configuration list. For this tutorial, select the BizBikesOnline configuration. This FactoryTalk Transaction Manager configuration is created when the BizBikes project is restored.

The ideal cycle time is part of the Throughput value in the OEE equation. It indicates the length of time, in seconds, that the activity area should take to produce a single good part and it can have a decimal value. If the activity area is producing parts faster than the ideal cycle time, the OEE rating will improve. If the activity area is producing parts slower than the ideal cycle time, the OEE rating will worsen.

The Part Id value tells FactoryTalk Metrics what type of part is being produced by the activity area. Changes in the Part Id value allow FactoryTalk Metrics to track operation conditions to the type of part being produced. If you always know what kind of part the activity area is producing, you can obtain the OEE ratings for the activity area sorted by part.

Step 1: Configure the Data Collection Parameters

Step 2: Configure the Ideal Cycle Time and Part Id Parameters



1. The navigation buttons on the left-hand side of this dialog box allow you to access the different groups of performance parameter fields in the dialog box. Click the Cycle Time Part Id button to display the Cycle Time/Part Id dialog box.

2. Select an option to indicate how the application should determine the ideal cycle time by selecting one of the following values from the Cycle Time Type list:

• Use a single Ideal Cycle Time. Select this option if the activity area always takes the same amount of time to produce every part, regardless of what type of part is being produced. Parts that actually take longer than the specified cycle time will negatively impact the OEE rating.

• Use a Part Id/Cycle Time list. Select this option to improve the accuracy of the OEE rating. When you select this option, the application uses the specified lookup list to find the Ideal Cycle Time for the type of part that is being produced. This assumes that the activity area always takes the same amount of time to produce a certain type of part. Click Create List to create a new list or select a list from the drop-down and click Edit List to modify the selected lookup list.

NOTE This option is only available if you select the Specify an Unscheduled Data Point to provide the Part Id data option in the Part Id section at the bottom of this dialog box.

• Monitor an Unscheduled data point for Ideal Cycle Time. Select this option to obtain the most accurate ideal cycle time. When you select this option, the control system specifies the amount of time it should be taken to produce a good part. Click Select to access a dialog box containing data points to choose from. Optionally, you can select a data point as the ideal cycle time event trigger and then specify the actual ideal cycle



time by using a FactoryTalk Transaction Manager expression. Do this by selecting the Use a FactoryTalk Transaction Manager Expression to determine the Ideal Cycle Time value check box and clicking the Edit button to create the expression in the FactoryTalk Transaction Manager Expression editor. If you use a FactoryTalk Transaction Manager expression, the only data point it can reference is the one selected in the Data Point box.

NOTE For additional information about choosing a data point, refer to the Select a Data Point topic in the Configuration Console online help.

For this tutorial, select Monitor an Unscheduled data point for Ideal Cycle Time, click Select, and double-click the FT.RSViewBizBikes.BEND_IdealCycleTime data point on the Select Data Point dialog box to insert that data point into the Data Point box.

3. Close the Select Data Point dialog box.

4. Select an option to indicate how FactoryTalk Metrics will determine what type of part the activity area is making by selecting one of the following values from the Part Id Type list.



• Do not monitor Part Id. Select this option if the application does not have information about the types of parts the activity area is making; therefore, the OEE rating for the activity area will always be based on all parts produced by the activity area.

• Use a single Part Id. Select this option if the activity area makes only one type of part and the OEE rating for the activity area will always be associated with that particular type of part. Enter the Part Id in the Part Id box.

• Monitor an Unscheduled data point for Part Id. Select this option if you want to monitor a data point in the control system to determine the type of part being produced. Changes in the Part Id value allow FactoryTalk Metrics to track operation conditions to the type of part being produced. If FactoryTalk Metrics knows what kind of part the activity area is producing, you can obtain the OEE rating for the activity area when it is producing a specific type of part. Click Select to access a dialog box containing data points to choose from.

For this tutorial, select Monitor an Unscheduled data point for Part Id, click Select, and double-click the FT.RSViewBizBikes.BEND_Part_ID data point on the Select Data Point dialog box to insert that data point into the Data Point box.



5. Close the Select Data Point dialog box.

A user-defined summarization criterion is the FactoryTalk Metrics Performance Parameter field—similar to Shift, Part Id, and Ideal Cycle Time—for which data can be collected. When the value of the field changes, it triggers the summarization of historical performance data for the activity area. The collected values can then be used to filter OEE performance data for the activity area. For example, if your system is configured to collect a user-defined summarization criterion called Operator ID for this activity area, you will be able to calculate the OEE performance for the activity area when a particular operator is running this equipment.

NOTE User-defined summarization criteria are defined by your RSBizWare administrator within the Service Console.

Step 3: Configure User-defined Summarization Criteria Parameters



1. Click the Summarization Criteria button on the left-hand side of the dialog box to display the Summarization Criteria dialog box.

2. Select the summarization criterion that you want to collect

from the Select Summarization Criteria list. For this tutorial, select Operator ID.

3. Select an option to indicate how FactoryTalk Metrics will determine the value for this user-defined summarization criterion.

• Do Not Monitor the selected Summarization Criteria for the Plant Model Activity Area. Select this option if you do not want the application to collect values for this field. The OEE rating for the activity area will always be based on all user-defined summarization criterion values of this type.

• Specify a default Summarization Criteria Value for this Plant Model Activity Area. Select this option if you want to provide a single value for this user-defined summarization criterion. The OEE rating for the activity area will always be based on this value. For example, if a particular operator always runs this piece of equipment, you



might use this option to specify the operator’s ID. Enter the value in the Value box.

• Specify an Unscheduled Data Point to provide Summarization Criteria information for this Plant Model Activity Area. Select this option if you want to monitor a data point in the control system to determine the value for this user-defined summarization criterion. Changes in the value allow FactoryTalk Metrics to track operation conditions to a specific value. In the case of Operator ID, this would allow FactoryTalk Metrics to track which operator is running the machinery and would allow you to obtain the OEE rating for the activity area when a specific operator was running the machinery. Click Select to access a dialog box containing data points to choose from.

For this tutorial, select the Specify a default Summarization Criteria Value... option and type Operator1 in the Value box.

The Part Count parameter is also part of the Throughput value in the OEE equation. It indicates how many parts were produced by the activity area. Because FactoryTalk Metrics is simply comparing the rate of items produced to the value given for the ideal cycle time, the unit of measure is not important (but it must be the same unit of measure as the ideal cycle time).

Step 4: Configure the Part Count Parameter



1. Click the Part Count button on the left-hand side of the dialog box to display the Part Count dialog box.

2. Select the tab that corresponds to the type of part count you

want to collect (i.e., Total, Good, or Scrap/Bad). It is not necessary to collect all three count values; however, at the minimum, you must collect the good part count or total part count and scrap/bad count (from which good part count can be calculated).

For this tutorial, select the Good Part Count tab.

3. Select an option to indicate how FactoryTalk Metrics should determine the number of parts of that type (total, good, or scrap/bad) that the activity area has produced:

• This Part Count Type is not in use. Selecting this option allows you to deactivate a part count type that you do not want the system to collect.

• The Plant Model Activity Area monitors a Scheduled or Unscheduled Data Point to determine Part Count. Select this option if you want a data point in the control system to report the number of parts produced by this activity area.



Click Select to access a dialog box containing data points to choose from.

• The Plant Model Activity Area evaluates a Formula to determine Part Count. Select this option if the number of parts produced is not contained in a single register in the control system. For example, if the activity area for which you are configuring performance parameters is actually two separate physical machines, you can create a formula to add the part counts from the two machines to create a single good part count.

Optionally, you can select a data point as the part count event trigger and then specify the actual part count by using a FactoryTalk Transaction Manager expression. Do this by selecting the Use a FTTM Expression to determine Part Count value and clicking the Edit button to create the expression in the Expression Editor. If you use a FactoryTalk Transaction Manager expression, the only data point it can reference is the one selected in the Data Point box.

Or, optionally, you can have the Activity Area determine the value of a FactoryTalk Transaction Manager expression on a scheduled basis by selecting the Evaluate this FactoryTalk Transaction Manager Expression on a scheduled basis and click the Edit button to create the expression in the FactoryTalk Transaction Manager Expression editor.

For this tutorial, select The Plant Model Activity Area evaluates a Formula to determine Part Count option.

Before we continue with the configuration of our activity area, let’s look at what it takes to create a Performance Parameter formula. Performance Parameter formulas consist of Boolean or arithmetic operations that are applied to data point values. Because a formula can be based on operations against multiple data points, the collection of data from a formula allows you to collect more specific information about your activity area.

Configure a Formula



There are three parameters in the Performance Parameters configuration for which you can create formulas: Part Count, Monitored Availability, and Running State. For Part Count, you can create an arithmetic formula; for Monitored Availability and Running State you can create Boolean formulas.

1. Click Edit to create the formula that will be used to determine the part count. The Performance Parameters Formula Wizard, which will assist you in the creation of a formula that will be used to perform an advanced calculation for an OEE Performance Parameter, is displayed.



2. A Performance Parameters formula consists of one or more formula parts. Click Add > to display the Edit Formula Part step of the wizard. Use this dialog box to choose the operator and data point that will make up the first part of your formula.

3. Select an operator from the Formula Part Operator list.

NOTE Since this is the first value in an arithmetic formula, you do not need to select an operator; the Starting Value operator has been selected for you.

4. Click Select to display the Select Data Point dialog box. Use this dialog box to choose the data point that will be evaluated in the formula.

For this tutorial, double-click the FT.RSViewBizBikes.BEND_Parts_Total data point on the Select Data Point dialog box and then close the dialog box.

5. Click Next to return to the Formula Parts page of the wizard. The formula part that you just created is displayed in the Formula Text and Formula Parts boxes.

6. Repeat Steps 1 - 5 to create additional formula parts.

For this tutorial, click the Add button, select (-) Subtract Value for the Formula Part Operator, click Select,



double-click the FT.RSViewBizBikes.BEND_Parts_Scrap data point on the Select Data Point dialog box, and then close the dialog box.

When you are finished creating formula parts, make sure the Formula Parts step of the wizard is displayed and click Next to display the summary step of the wizard.

7. Click Finish to add the formula to the Performance Parameters for this activity area.

Scheduled availability is part of the Availability value in the OEE equation. It indicates when the activity area is supposed to be available to produce parts.

1. Click the Scheduled Availability button on the left-hand side of the dialog box to display the Scheduled Availability and Capacity dialog box.

2. Select an option to indicate how FactoryTalk Metrics will

determine when the activity area is available to produce parts.

• The Plant Model Activity Area is scheduled to be available at all times. Select this option to specify that the activity area is scheduled to always be available. If you select

Step 5: Configure the Scheduled Availability Parameters



this option, it is difficult to determine when the activity area is truly available. As a result, non-production time (e.g., weekends) could cause the activity area’s OEE rating to be artificially low. You should not choose this option unless the activity area truly runs 24 hours a day, seven days a week or unless you intend to rely on monitored availability to determine availability.

• Collect Scheduled Availability information from the control system. Select this option if a site changes shift schedules frequently. Using this method, the Shift Id value from the control system is used to define availability. With this option, you must do the following:

• Select a data point to monitor for shift information, and select the shift description lookup list.

• Optionally, select a data point to monitor for scheduled availability. If no data point is selected, the scheduled availability will be determined from the current shift. If the optional data point for Scheduled Availability is selected, then that is the only value used to determine the scheduled availability state. If only the Shift ID Data Point is selected, then the Plant Model Activity Area will be considered to be Scheduled Available when the Shift ID value indicates that a shift is currently active. The collected value for Shift ID is interpreted as an integer value with any positive value indicating that the Plant Model Activity Area is in an active shift. Any other value, zero or negative, indicates that the Plant Model Activity Area is out of shift. Any time that it is in an active shift is considered to be Scheduled Available and any out-of-shift time is Scheduled Unavailable.

• A configured Capacity Time Pattern specifies the Plant Model Activity Area’s Scheduled Availability and Capacity state. Select this option to define when the activity area is scheduled to be available. If you base the



availability of the activity area on a time pattern, the OEE rating of the activity area will not be negatively affected by time periods that are scheduled as unavailable (e.g., weekends, evenings).

Click the Composite, Exception, and Pattern buttons to access the corresponding editors so that you can create or modify time patterns, composites, and exceptions. These are the same dialog boxes we used in "Configure an Activity Area Schedule 34".

If a site changes shift schedules frequently, the Collect Scheduled Availability information from the control system option is more flexible than using a time pattern.

For this tutorial, select the A configured Capacity Time Pattern... option.

3. Finally, you need to specify the time pattern to be used for this work cell. In "Step 1: Define Time Patterns (page 35)", you defined time patterns for this plant model. So all you need to do is assign a time pattern to the capacity for this work cell.

For this tutorial, click the Composite button to access the Composite Time Patterns dialog box.

4. Expand the Sample Enterprise, Sample Site, Sample Area, Sample Line, and Sample Work Cell 1 to expose the Capacity item.



5. Select the Capacity item, select Time Pattern from the Value Type list, and select Work Week from the Value list. Click OK.

Monitored availability is also part of the Availability value in the OEE equation. This parameter indicates when the activity area is actually available to produce parts. While an activity area may be scheduled to be available at a specified time, it may not actually be available at that time. An example of this is when an activity area is scheduled to be available, but is not able to work because it is starved for parts from an upstream process. Using the monitored availability parameter improves the understanding of which machine in the facility truly is causing the problems.

Step 6: Configure the Monitored Availability Parameters



1. Click the Monitored Availability button on the left-hand side of the dialog box to display the Monitored Availability screen.

2. Select an option to indicate how the application should

determine the actual availability of the activity area.

• The Plant Model Activity Area is always available. Select this option if FactoryTalk Metrics will use only the scheduled availability information to determine the Availability part of the OEE equation. As a result, non-production time that is not the fault of the activity area (e.g., when the machine is starved for parts) will cause the activity area’s OEE rating to be artificially low.

• The Plant Model Activity Area determines Monitored Availability based on the current Machine State. Select this option if the activity area is considered to be in an available state if the current machine state indicates an available state. For more information, see "Configure and Use Machine States (page 70)".

• The Plant Model Activity Area monitors an Unscheduled Data Point to determine availability. Select this option to improve the accuracy of the OEE rating. For



example, if you base monitored availability on the data point that contains the running bit of an upstream unit, the OEE of the current unit will not be negatively affected when it is starved for parts (the upstream unit is not running).


Optionally, you can select a data point as the availability event trigger and then specify the actual availability value by using a FactoryTalk Transaction Manager expression. Do this by selecting the Use a FactoryTalk Transaction Manager Expression to determine the Monitored Availability value check box and clicking the Edit button to create the expression in the FactoryTalk Transaction Manager Expression editor. If you use a FactoryTalk Transaction Manager expression, the only data point it can reference is the one selected in the Data Point box.

• The Plant Model Activity Area evaluates a Formula to determine availability. Select this option to determine the availability of the activity area based on the results of a formula. For example, if you base the monitored availability on the running state of the upstream and downstream units, you can determine that the activity area is actually available because it is not starved for parts and is not blocked.

Click Edit to create or modify the formula that will be used to determine the availability. See "Configure a Formula (page 55)" for instructions on creating a formula.

For this tutorial, select The Plant Model Activity Area evaluates a Formula to determine availability option and construct a formula where the following data point values are false:

• FT.RSViewBizBikes.BEND_Standby



• FT.RSViewBizBikes.BEND_Test

Use the instructions in "Configure a Formula (page 55)" to construct the formula. When the formula is completed, the formula box will look like that shown below.

By default, FactoryTalk Metrics applies the Boolean AND operator to the Scheduled Availability and the Monitored Availability for an activity area to determine the Availability value that is used in the OEE rating. This means that if both Scheduled Availability and Monitored Availability indicate an Available state, the activity area is Available.

If you want FactoryTalk Metrics to use the Boolean OR operator when it interprets Availability, click the Advanced button on the left-hand side of the Configure Performance Parameters dialog box and choose the second Availability Interpretation Option. The Boolean OR option means that if either Scheduled Availability or Monitored Availability indicate an Available state, the activity area is Available.

The Availability Truth table shown below defines the results of the Boolean AND and Boolean OR operations.

Scheduled Availability

Monitored Availability

AND Result OR Result

Available Available Available Available Available Not Available Not Available Available Not Available Available Not Available Available Not Available Not Available Not Available Not Available

For this tutorial, the default AND operator is sufficient so do nothing.

Step 7: Modify the Default Availability Behavior



Running time is part of the Availability value in the OEE equation. The Running parameter allows the control system to indicate when the activity area is actually producing parts.

1. Click the Running State button on the left-hand side of the dialog box to display the Running dialog box.

2. Select an option to indicate how FactoryTalk Metrics should

determine when the activity area is actually running and producing parts.

• The Plant Model Activity Area is always in a running state. Select this option if you want running time set equal to available time (and you will not be able to isolate the contribution that Availability makes to the OEE value).

• The Plant Model Activity Area is always running when it is available and not in a faulted state. Select this option if you want the running state of the activity area to be based on the availability and the fault state of the activity area. This enables you to eliminate unavailable time and downtime from the OEE rating.

• The Plant Model Activity Area determines Running State based on the current Machine State. Select this

Step 8: Configure the Running State Parameter



option if the activity area is considered to be in a running state if the current machine state indicates a running state. For more information, see "Configure and Use Machine States (page 70)".

• The Plant Model Activity Area monitors an Unscheduled Data Point to determine running state. Select this option if you have a data point in the control system that contains a running bit. If you base the running state parameter on the data point that contains the running bit of the selected activity area, the activity area’s running time will be stored in the database for later reporting.


Optionally, you can select a data point as the running state event trigger and then specify the actual running state value by using a FactoryTalk Transaction Manager expression. Do this by selecting the Use a FactoryTalk Transaction Manager Expression to determine the Running State value check box and clicking the Edit button to create the expression in the FactoryTalk Transaction Manager Expression editor. If you use a FactoryTalk Transaction Manager expression, the only data point it can reference is the one selected in the Data Point box.

• The Plant Model Activity Area evaluates a Formula to determine running state. Select this option if the running state for the activity area is determined by several data points in the control system. For example, if you base the running parameter on the running state of the activity area and the part jam bit or fault indicator bit, you can determine that the activity area is actually running because it is not jammed or in a fault condition.

Click Edit to create or modify the formula that will be used to determine the run state. See "Configure a Formula (page 55)" for instructions on creating a formula.



For this tutorial, select the The Plant Model Activity Area is always running when it is available... option.

When you are finished configuring your performance parameters, click Apply to save your changes. The application will create system-generated Performance Parameter events.

Performance Parameter events are what FactoryTalk Metrics uses to collect data for performance monitoring. To view the events that have been created for your activity area and to display the Events screen, click the Events button on the left-hand side of the Configure Performance Parameters dialog box.

There are two types of Performance Parameter events: system-generated and user-defined events.

System-generated (default) events are created and maintained by the FactoryTalk Metrics software and reflect the selections that you

Step 9: Generate Performance Parameter Events

View the Performance Parameter Events for an Activity Area

System-generated Events



have made for the Performance Parameters configuration. You are only able to edit the description of a system-generated event. All of the other properties of these events are locked. System-generated events cannot be deleted.

User-defined events are custom events that are used to collect extra data that you would like to associate with the existing performance data. By defining custom events, you can direct FactoryTalk Metrics to monitor specific bits or registers in the plant control system, and maintain historical records on the behavior of those data points. For example, you can create user-defined events to trap and record downtime occurrences, e-stops, upstream/ downstream status, machine state information, and operator input.

The ability to direct FactoryTalk Metrics to monitor custom events in the control system is extremely powerful because it allows you to customize FactoryTalk Metrics for your unique situation and objectives.

What is captured and how it is interpreted is up to you. There is no enforced limit to the number of custom events that can be associated with a plant model activity area in FactoryTalk Metrics; although the addition of each new event will consume more resources from all the components of the system.

The performance parameters for a user-defined event include:

• Identifying information. Plant Model Activity Area (referred to as “Work cell Description” in the FactoryTalk Metrics Event History report data source), Event Category (a user-defined grouping or folder of related events), and Event Description (user-defined).

User-defined Events



• Summarization rules. Define how FactoryTalk Metrics will handle the creation of multiple summary records in the database for a single occurrence of an event. See the “Data summarization types” topic in the online help for definitions of the summarization types.

• Trigger. Defines how the event starts and ends, (e.g., a bit in the control system goes high to signal the start of the event and goes low at the end of the event). See the “Event trigger types” topic in the online help for definitions of the trigger types.

• Additional data. Optionally, an additional data point can be collected at the start or end of the event, or a counter can be monitored through the duration of an event. Additional data collected might be an event reason code entered by an operator that explains why the event occurred.

• Event fault metrics. Not all events are relevant in the calculation of fault metrics. Specify how this event should be used when calculating fault metrics (Mean Time Between Failure, Mean Time To Repair). Mean Time Between Failure and Mean Time to Repair are derived fields that contain aggregate functions and, as such, they can only be used in summary report objects and cannot have aggregate functions applied to them.

• Event reporting. The reporting value property determines the type of value that is reported for an event. The severity level property determines the severity that is associated with an event. This is useful for reporting and sorting events.

For this tutorial, we will not be creating user-defined events. Refer to the online help for information about creating user-defined events.

The Recycle Bin is a system-generated category similar to the categories for Available or Running events. It is used to hold events that are no longer being used to collect performance parameter data but still have historical data in the database that may be used in

The Recycle Bin



reports. The Recycle Bin is only displayed in the Performance Parameters Events tree if historical data exists.

When you modify a set of performance parameters, FactoryTalk Metrics will disable the existing events for the portion of the performance parameters configuration that was modified and create new events for the category. It will then check to see if any data has been logged for the disabled events. If no data has been logged, then the events are deleted. If there is historical data for an event, that event is moved to the Recycle Bin.

For example, if you changed the Activity Area Availability from “Data Point” to “Formula,” the system would disable the existing events in the Available category, delete the events that do not have historical data, move the events that have historical data to the Recycle Bin, and create new Available events.

NOTE If you delete an event from the Recycle Bin, the event and any historical data associated with the event will be deleted.

Machine states are special attributes of user-defined events. While user-defined events are independent of each other (so that at any time there may be no or many user-defined events active at a particular activity area), machine states are mutually exclusive. That is, an activity area can be in one and only one machine state at a time, and each activity area that has machine states configured is always in a machine state at all times.

The advantage of using machine states is that it is possible to account for all time in an activity area by way of the defined machine states, without gaps and without double counting time. If you do not use machine states, you must implement this type of state logic in the control system if you need to collect machine state information.

Configure and Use Machine States



Machine states are defined for the FactoryTalk Metrics application as a whole (not for individual activity areas). Up to 99 unique machine states can be defined for a FactoryTalk Metrics application.

When you configure the performance parameters for an activity area, you can also configure the machine states that are appropriate for that activity area. Each activity area can be in only one machine state at a time, so all machine states should be mutually exclusive. All, some, or none of the defined machine states can be configured in a particular activity area.

Each machine state has a priority, so if multiple machine states could be active simultaneously, only the machine state with the highest priority will actually be active. If at any time the activity area is not in a defined machine state, the machine state will be logged as Undefined.

The following example discusses one possible approach to defining machine states and discusses how they can be configured for one example activity area. Unlike the other tutorials in this chapter, you cannot follow along with this example because the data points do not exist in the BizBikes database.

The Sample Enterprise that we first configured in section "Configure the Plant Model (page 31)", has determined that its machines and work areas can be in one of the following machine states at any particular time:

• Running. The machine is producing output. This state represents the ideal state for this machine because the machine is available and running.

• Setup. The machine is being changed over for a new production run. This state represents a minor problem. In this state, the machine is available, but not running.

Machine States at Sample Enterprise



• Test. The machine is in a test mode. This state represents a minor problem. In this state, the machine is not available nor is it running.

• Blocked. The machine is blocked because of a problem at a downstream machine. This state represents a major problem, but not a severe problem. In this state, the machine is available, but not running.

• Starved. The machine is starved for parts from an upstream machine. This state represents a major problem, but not a severe problem. In this state, the machine is available, but not running.

• Linefault. The machine is simultaneously blocked because of a problem at a downstream machine and starved for parts from an upstream machine. This state represents a severe problem. In this state, the machine is available, but not running.

• Down. The machine is unavailable for production for some reason other than a linefault, blocked, or starved state. This state represents a major problem, but not a severe problem. In this state, the machine is available, but not running.

For the example work cell, these states are determined by collecting values from the following data points:

• FT.SampleEnterprise.Workcell_STATE. This monitored value data point can have one of the following values:

• 0 (Running). This value maps to the Running machine state.

• 1 (Setup). This value maps to the Setup machine state.

• 2 (Test). This value maps to the Test machine state.

• 3 (Down). This value maps to the Down machine state.

• 4 (Off). This value does not map to a particular machine state, so by default it maps to the Undefined machine state.



• FT.SampleEnterprise.Workcell_BLOCKED. When this monitored bit data point is on (1), the value maps to the Blocked machine state. Note also, that when this data point is on, the FT.SampleEnterprise.Workcell_STATE data point will have a value of Down (3).

• FT.SampleEnterprise.Workcell_STARVED. When this monitored bit data point is on (1), the value maps to the Starved machine state. Note also, that when this data point is on, the FT.SampleEnterprise.Workcell_STATE data point will have a value of Down (3).

• FT.SampleEnterprise.Workcell_BLOCKED and FT.SampleEnterprise.Workcell_STARVED. When both of these monitored bit data points are on, the combined value maps to the Linefault machine state.

After you have defined your machine states, you must configure and prioritize them.

The priority of a machine state is used by FactoryTalk Metrics to select one machine state if the values collected from one or more user-defined events would otherwise indicate that two or more machine states should be active. If there is a situation where the values of one or more user-defined events can map to more than one machine state simultaneously, the priority is used to determine which machine state becomes active. In this situation, the machine state with the highest priority (the lowest priority number) is selected. If there is no possible overlap between machine states, their relative priority is unimportant.

In the Sample Enterprise, the following machine states must be prioritized in the specified order (from highest priority to lowest priority):

1. Linefault. Because the Linefault state occurs when data points for Blocked and Starved are on, this state must have a higher

Step 1: Configure the Machine States



priority than either of these two other states. If either Blocked or Starved had a higher priority than Linefault, then the Linefault state would never occur.

2. Blocked. This state must have a higher priority than the Down state because when a machine is blocked it is also down, but when a machine is down it is not necessarily blocked (it could be in a Linefault state, a Starved state, or some down condition that maps to the Down state). Note that the relative priority of Blocked and Starved to each other is unimportant because when they are both active, the machine is in the Linefault machine state.

3. Starved. This state must have a higher priority than the Down state because when a machine is starved it is also down, but when a machine is down it is not necessarily starved (it could be in a Linefault state, a Blocked state, or some down condition that maps to the Down state). Note that the relative priority of Blocked and Starved to each other is unimportant because when they are both active, the machine is in the Linefault machine state.

4. Down. Because the data point that maps to this state can indicate any type of down condition (including the Linefault state, the Blocked state, the Starved state, or any other generic down condition), it must have the lowest priority of all of the down states.

The relative priority of the Test, Setup, and Running states is unimportant because the values of the data points used to determine these states are mutually exclusive with each other and with the down states.



1. From the Configuration Console, select Configure > FactoryTalk Metrics > Machine States from the main menu. The Configure Machine States dialog box is displayed.

2. Click Add to access the Configure State dialog box. This

dialog box is used to define the properties of an individual machine state.

3. Use the State Name box to name the state. This name must be

unique.

For the Sample Enterprise, you would type the name Linefault in the State Name box.

4. From the Color list, select the color that will be used to represent this state in graphical reports.



The read-only Priority box indicates the priority of this machine state relative to other machine states. This priority is assigned automatically and cannot be changed on this dialog box. To change it, you must use the Priority arrow buttons on the Configure Machine States dialog box.

For the Sample Enterprise, you would select the color Red from the Color list.

5. If you want a state to indicate that the machine is available for production, select the An Activity Area’s Monitored Availability is true when this State is active check box.

For the Sample Enterprise, select the An Activity Area’s Monitored Availability is true when this State is active check box.

6. If you want a state to indicate that the machine is actually producing output, select the An Activity Area’s Running State is true when this State is active check box. This check box can only be selected if the An Activity Area’s Monitored Availability is true when this State is active check box is selected.

For the Sample Enterprise, leave the default setting for the Linefault state.

7. Click OK to save any changes to the state and return to the Configure Machine States dialog box.



After configuring all of their machine states, the Configure Machine States dialog box for the Sample Enterprise would look like this:

After you have configured your machine states for the FactoryTalk Metrics application, you can map the relevant machine state to the user-defined events used to derive that machine state in each activity area. The example that follows shows the configuration of one example work cell.

How mapping is created depends on the types of data points in use in the activity area:

• A single monitored value data point.

• A single monitored bit data point.

• A monitored formula that resolves to a single bit value.

Monitored value data points can return a range of valid values. A monitored value data point does not have an on/off state, so each value they return can map to a different machine state (though you do not have to map a value to a particular state if that value has no meaning within your set of defined machine states). For the Sample

Step 2: Map Machine States To User-defined Events

Map a Machine State To a Single Monitored Value Data Point



Enterprise, the FT.SampleEnterprise.Workcell_STATE data point is an monitored value data point that will be used to determine four different machine states.

To collect machine state information from a monitored value data point, you must do the following from the Configuration Console:

1. Select Configure > FactoryTalk Metrics > Performance Parameters from the main menu to open the Manage Performance Parameters dialog box.

2. Select the activity area for which you want to associate machine states and click Configure to open the Configure Performance Parameters dialog box. If necessary, select the FactoryTalk Transaction Manager configuration for this activity area.

For the Sample Enterprise, you would select Sample Work Cell 1 and click Configure.

3. Click the Events button.

4. Select an existing event and click Edit or create a custom event by clicking New to access the Performance Parameter Events dialog box.

For the Sample Enterprise, you would click New to create a new custom event.

5. If necessary, give the event a description and create a new category or select an existing category for the event.



For the Sample Enterprise, you would type State in the Description box. Then, you would click New, type Machine State Events in the Enter Event Category Name box, and click OK.

6. Click the Event Trigger button, select Monitored Value

from the Event Trigger Type list, and drop or select the appropriate analog data point.

For the Sample Enterprise, you would select the FT.SampleEnterprise.Workcell_STATE data point.



7. Click the Event Value button and select a valid value from the

Event Value Type list (either Collect Value at the Start of the Event or Collect Value at the Start and the End of the Event).

For the Sample Enterprise, you would select Collect Value at the Start of the Event and select the FT.SampleEnterprise.Workcell_STATE data point.



8. Select or create a value lookup list that maps each event value to one of the machine states created on the Configure Machine States dialog box.

For the Sample Enterprise, you would click Create List to create a new lookup list. You would then create a lookup list that maps the values 0, 1, 2, and 3 to the corresponding machine states as described in "Machine States at Sample Enterprise (page 71)" and shown below.

9. Click the Machine State/Faults button, select the appropriate

Fault Metric Tracking value, and select Apply the Machine State configured for the event’s collected value in the Event Lookup Code List.

For the Sample Enterprise, you would select This event’s collected value is used to calculate Fault Metrics based on the Event Lookup Code List option and the Apply the Machine State configured for the event’s collected value in the Event Lookup Code List option.



10. Click the Reporting button and select the appropriate Event

Severity Level option value.

For the Sample Enterprise, you would select the Use the Severity Level from the selected Event Lookup Code List for the collected event value option.

11. Click OK to save the configuration.



Monitored bit data points are switches that can be either on or off. Because of the on/off nature of these data points, the events generated by them can map to only one machine state. For the Sample Enterprise, the FT.SampleEnterprise.Workcell_BLOCKED data point is a digital data point that will be used to determine when a machine is blocked by a downstream machine.

To collect machine state information from a digital data point, you must do the following from the Configuration Console:


2. Select the activity area for which you want to associate machine states and click Configure to open the Configure Performance Parameter Event dialog box. If necessary, select the FactoryTalk Transaction Manager configuration for this activity area.



4. Select an existing event and click Edit or create a custom event by clicking New to access the Configure Performance Parameter Event dialog box.



Map a Machine State To a Monitored Bit Data Point



For the Sample Enterprise, you would type Blocked in the Description box. Then, you would select Machine State Events from the Category list.

6. Click the Event Trigger button, select either Monitored Bit

Low to High Transition or Monitored Bit High to Low Transition from the Event Trigger Type list, and drop or select the appropriate digital data point.

For the Sample Enterprise, you would select the Monitored Bit Low to High Transition option from the Event Trigger Type list and select the FT.SampleEnterprise.Workcell_BLOCKED data point.



7. Click the Machine State/Fault button, select the appropriate

Fault Metric Tracking value, select When this event is active apply the selected Machine State, and select the appropriate machine state from the list.

For the Sample Enterprise, you would select This event is not used in calculating Fault Metrics, select When this event is active apply the selected Machine State, and select Blocked from the list.



8. Click the Reporting button and select the appropriate Event Severity Level option value.

For the Sample Enterprise, you would select the Specify a Severity Level for this Event option and specify a severity of 35.


In some production environments, you must combine the values from two or more data points to determine a machine state. The Linefault machine state is an example of a machine state that is derived by combining two data point values; the Linefault machine state is active if FT.SampleEnterprise.Worcell_BLOCKED is on and FT.SampleEnterprise.Worcell_STARVED is on.

Map a Machine State To a Formula That Resolves To a Single Bit



To collect machine state information from a combination of two or more monitored bit data points, monitored value data points, or both, you must do the following from the Configuration Console:


2. Select the activity area for which you want to associate machine states and click Configure to open the Configure Performance Parameter Event dialog box. If necessary, select the FactoryTalk Transaction Manager configuration for this activity area.



4. Select an existing event and click Edit or create a custom event by clicking New to access the Configure Performance Parameter Event dialog box.





For the Sample Enterprise, you would type Linefault in the Description box. Then, you would select Machine State Events from the Category list.

6. Click the Event Trigger button, select either Monitored

Formula Low to High Transition or Monitored Formula High to Low Transition from the Event Trigger Type list, and drop or select the appropriate analog data point.

For the Sample Enterprise, you would select the Monitored Formula Low to High Transition option from the Event Trigger type list and click the Edit button to create a formula where the value of the FT.SampleEnterprise.Workcell_BLOCKED data point is true and the FT.SampleEnterprise.Workcell_STARVED data point is true. The Formula box will look like the following example when completed. For more information on constructing a formula, see "Configure a Formula (page 55)".



7. Click the Machine State/Faults button, select the appropriate

Fault Metric Tracking value, select When this event is active apply the selected Machine State, and select the appropriate machine state from the list.

For the Sample Enterprise, you would select This event is not used in calculating Fault Metrics, select When this event is active apply the selected Machine State, and select Linefault from the list.



8. Click the Reporting button and select the appropriate Event Severity Level option value.

For the Sample Enterprise, you would select the Specify a Severity Level for this Event option and specify a severity of 0.


As mentioned previously, you can use the fact that a machine state is active to determine if the corresponding activity area is available (Monitored Availability), running (Running State), or both. To determine the monitored availability or running state of an activity area by way of that activity area’s machine state, do one or both of the following.

1. Click the Monitored Availability button on the left-hand side of the dialog box to display the Monitored Availability screen for the current activity area.

Step 3: Determine Availability and Running State From Machine State

Use Machine State To Determine Monitored Availability



2. Select the The Plant Model Activity Area determines Monitored Availability based on the current Machine State option.

1. Click the Running State button on the left-hand side of the dialog box to display the Running State panel for the current activity area.

Use Machine State To Determine Running State



2. Select the The Plant Model Activity Area determines Monitored Availability based on the current Machine State option.

Every FactoryTalk Metrics implementation can be different, but all endeavor to answer the question “What are my machines doing?” To answer this question, you must consider these two related questions: “Are my machines running when they are supposed to?” and “What are they doing when they are not running?” Downtime tracking can answer these questions for you.

The word “downtime” is frequently used, but may mean different things to different people. All of the following are possible definitions of downtime:

1. Any time a machine is not running.

2. Any on-shift time a machine is not running.

3. Any on-shift time when pre-defined conditions cause a machine to stop (this will exclude other conditions from downtime).

Configure FactoryTalk Metrics To Perform Downtime Tracking



4. Any on-shift time, except certain conditions (like blocked or starved), when predefined conditions cause a machine to stop.

5. Any time a machine is in a pre-defined faulted condition.

Further, when someone says they want to see downtime reports, they may want to see:

1. All time, divided into categories like running and downtime.

2. All downtime.

3. Downtime divided into pre-defined categories.

4. Downtime divided into pre-defined categories with reason codes entered by the operator.

5. Downtime by machine, shift, part, operator, etc.

It is important that you carefully consider the definition of downtime and the reporting requirements of your organization before you start a downtime tracking project. In addition, there are three distinct approaches to downtime tracking with FactoryTalk Metrics that you will want to evaluate for your organization. Each approach has its own advantages and considerations:

• Running versus downtime.

• User-defined downtime events.

• Machine State.

This measure of downtime is suitable for those organizations that consider downtime to be any time a machine is available to produce parts, but is not actually running.

By default, an activity area is assumed to be always available and always running; however, this default configuration will not allow you to collect downtime for the activity area. To collect downtime, you need to provide a method to determine machine availability and a running indicator from the control system. Using the Configure

Running Versus Downtime



Performance Parameters dialog box, you can set Available Time to be collected from the control system, or to be defined by a Time Pattern (or shift schedule) and modified by the Monitored Availability setting; and define a data point or formula from the control system that indicates when the monitored machine is running.

To report on the difference between available time and running time (the time when the machine was available but not running), use the Downtime Seconds field in the FactoryTalk Metrics Work cell History report data source. To report on running versus downtime data, use the Running Percent and Downtime Percent fields in the FactoryTalk Metrics Work cell Detail report data source.

The advantage to using this method of downtime tracking is that very little configuration or control system data is required. The disadvantage of this method is that all non-running time is lumped together, making it impossible to determine the causes of the downtime.

The ability to configure user-defined events in FactoryTalk Metrics allows you to collect and report on virtually any event that happens on the factory floor, provided that the event can be detected by the control system. This is the most powerful capability of the product, and through it FactoryTalk Metrics can illuminate all sorts of conditions: machine component behavior, setups and changeovers, and quality checks, just to name a few.

With user-defined events, downtime can be tracked to the lowest level of detail that is implemented in the control system. To effectively track downtime, control system indicators of a downtime condition, as well as reason indicators, should be implemented as separate user-defined events, and be collected in a category called “Downtime”. Create as many different events as practical, because the more distinct events that are logged, the better picture of downtime causes can be created.

User-defined Downtime Events



You should also identify any conditions that may impact the output of the machine that are not caused by machine failure (if that is your definition of downtime) and configure user-defined events for them. Examples might be setups, changeovers, or material delays. Again, the more granular you can make the events, the better.

User-defined events can also be configured as Faults, for the purposes of calculating Mean Time Between Failure (MTBF) and other metrics. Considering only Fault events as downtime is another option for downtime reporting.

Reports of user-defined events can be created using the FactoryTalk Metrics Event History report data source, with filters applied so that only the data associated with the desired events or event categories is displayed.

The disadvantage of this method of downtime tracking is that the possibility exists that at any point in time an activity area may not be experiencing a user-defined event or may be experiencing more than one user-defined event. For example, a downtime event will often cause other events to occur in a domino fashion, resulting in multiple events being active at one time. This makes it difficult to account for all time accurately without implementing non-overlapping event logic in the control system.

The BizBikes demo application on the RSBizWare CD uses the user-defined events approach to collecting and reporting on downtime data. There is an event category called Downtime that contains three user-defined events:

• Breakdown.

• Unscheduled Maintenance.

• Testing.

Downtime Tracking With User-defined Events in the BizBikes Demo Application



The Breakdown event is categorized as a Fault event. For each Breakdown event, a Reason Code is collected from the operator so the underlying cause of the breakdown is captured.

In addition, there are two other user-defined event categories which reflect a production stop, but are not categorized as downtime: Operation and Standby. Operation contains three user-defined events: Setup, Load/Unload, and Order Processing.

In BizBikes, downtime information is shown in a variety of reports. Information for all activity areas is in the Overview > Events folder on the Report Explorer tree, and information for each activity area is contained in the Events Page and Events Detail reports within the folder for each activity area. User-defined events are collectively referred to as Events or Exceptions in the BizBikes reports.

Using Machine State to track downtime allows you to configure a state model for each activity area such that all time will be attributed to a defined machine state. This will ensure that all time is accounted for in defined machine states and that no time is double-counted. The Machine State capability allows you to prioritize the states such that if there is more than one state that theoretically could occur at the same time, then the state with the highest priority becomes active. This prevents the problems associated with a downtime event causing other events to occur in domino fashion.

To use machine states to track downtime, do the following:

1. Using the Configure Machine States dialog box, configure the machine states relevant to your activity areas. You should also prioritize states in relation to one another and, where appropriate, set the Monitored Availability is true when this State is active and Running State is true when this State is active properties for individual states.

Machine State



2. Using the Configure Performance Parameter Event dialog box, associate the machine states with the user-defined events that effectively define each state for each activity area for which you want to collect downtime data.

3. Using the Configure Performance Parameters dialog box, configure the Monitored Availability and Running State to be determined from the machine states.

• An activity area is considered available if the Monitored Availability is true when this State is active property is set for the active machine state.

• An activity area is considered to be running if the Running State is true when this State is active property is set for the active machine state.

When you are finished with the configuration of OEE performance parameters for the activity area, check the Enable Data Collection check box at the top of the dialog box and click Apply to save your changes. This notifies FactoryTalk Metrics that you are ready to begin the collection of data for this activity area and causes the application to generate the necessary FactoryTalk Transaction Manager transactions.

NOTE Enabling data collection for the activity area also consumes one work cell license for the Information Services Manager to which the Configuration Console is connected.

To view status information about the events associated with the activity area, click the Data Collection button on the left-hand side of the dialog box to return to the Data Collection screen. The Configuration Status, Data Collection Status, and FactoryTalk Transaction Manager Transaction Status buttons in the middle of

Enable Data Collection For the Activity Area

Review Performance Parameters Event Status



the dialog box control what type of data will display in the Event Status list.

The Configuration Status list displays the following basic information about each of the events:

• The event category to which the event belongs.

• Whether the event is system-generated or user-defined.

• Whether or not the event is enabled.

The FactoryTalk Transaction Manager Transaction Status list displays the following information about the FactoryTalk Transaction Manager transaction associated with each event:

• Whether or not the transaction was created when you enabled data collection for the activity area. A value of Not Applicable means the event does not require input from the control system; therefore, a transaction has not been created.

• Whether or not the transaction is valid inside FactoryTalk Transaction Manager.



• Whether or not the transaction bindings are up-to-date and match the configured event. If the transaction is invalid and/or the bindings are not up-to-date, you may want to regenerate the transactions. To regenerate the transactions, click the Generate Transactions button at the top of the Data Collection screen.

When the FactoryTalk Transaction Manager configuration has been started and the system is collecting data for the activity area, the Data Collection Status list displays the following information for each event:

• Whether or not the event has received an initial value.

• The last time the event received a value from the control system.

• The status of the event in data collection.

When you are finished reviewing the event status for this activity area, click OK to save any changes you have made and to return to the Manage Performance Parameters dialog box.



Take some time to examine the OEE performance parameters that are configured for each of the BizBikes sample activity areas. These activity areas are organized under the BizBikes, Inc., enterprise in the Manage Performance Parameters dialog box. When you are finished reviewing the sample activity areas, click Close to exit the Manage Performance Parameters dialog box.

After you have finished configuring the performance parameters and have enabled data collection for the activity areas that use a particular FactoryTalk Transaction Manager configuration, you must start the FactoryTalk Transaction Manager configuration to begin data collection.

To start a FactoryTalk Transaction Manager configuration, select Tools > FactoryTalk Transaction Manager > Manage FactoryTalk Transaction Manager Configurations from the main menu. The FactoryTalk Transaction Manager Configurations dialog box will display.

Review Sample Activity Areas

Start and Stop Data Collection



The FactoryTalk Transaction Manager Configurations dialog box lists the FactoryTalk Transaction Manager configurations that have been imported and the applications to which they apply. Use this dialog box to evaluate the running status of FactoryTalk Transaction Manager configurations that are collecting data from the control system and to start, stop, or restart the configurations.

• A green traffic light to the left of a configuration indicates that it is running and collecting data from the control system.

• A red traffic light indicates that the configuration is not running.

To start a FactoryTalk Transaction Manager configuration, click the configuration and click the Start button. To stop a FactoryTalk Transaction Manager configuration, click the configuration and click the Stop button.

FactoryTalk Metrics allows you to enter some information manually that cannot be collected from the control system in real time. With manual data collection, you can perform the following tasks:

• Add reason codes and comments to user-defined events.

• Adjust total, good, and scrap part counts.

• Add reason codes and comments to scrap events.

• Change the amount of available time.

For this example, we will change the schedule data for the Bicycle Shop activity area in the BizBikes, Inc., enterprise.

NOTE To perform manual data collection, you must be granted the Manage FactoryTalk Metrics Manual Data Collection privilege by your RSBizWare administrator.

Manual Data Collection



1. From the main menu, select Tools > FactoryTalk Metrics > Manual Data Collection to display the FactoryTalk Metrics Detail/Manual Data Collection dialog box.

2. Open the BizBikes, Inc., item and browse for the Bend

activity area in the tree as shown in the preceding graphic. Expand the activity area name to open the folder and display the five sub-folders under the activity area. As you click each of the subfolders, a custom table will display in the work area at the right.

• Counts folder. This table lists the count values that were collected during the specified period of time for the selected activity area and allows you to modify the good parts, scrap parts, and total parts values for the activity area.

• Event folder. This table lists the user-defined events that occurred during the specified period of time for the selected activity area and allows you to enter reason codes and comments for each user-defined event.



• OEE folder. This table lists the OEE and other performance values calculated from the values collected during a specified period of time for the selected activity area. You cannot edit the records in this table.

• Schedule folder. This table lists the shift-related time values that were collected during the specified period of time for the selected activity area and allows you to modify the scheduled available and actual available values for the activity area.

• Scrap folder. This table lists the scrap events that occurred during the specified period of time for the selected activity area and allows you to enter comments for the scrap event. If the scrap event has a lookup list associated with it, you may also enter a reason code for the scrap event.

3. The Time Selection Toolbar at the top of the table controls the time period for which data will display in the table. By default, the past two hours are displayed. If you want to modify a record that was collected more than two hours ago, use the tools on this toolbar to change the time period.

For this tutorial, click the All Times button to display all data that has been collected for this activity area.

4. Click the Schedule folder to display the table of schedule values.

5. To edit a record, right-click the record in the table and select Manual Data Collection Properties from the shortcut menu. The FactoryTalk Metrics Manual Data Collection dialog box will display. This dialog box will look different depending on what type of record (Counts, Events, Schedule, or Scrap) you are attempting to change.

For this tutorial, let’s assume that a particular schedule (the second record in the list) changed because of a power outage. So right-click that record and select Manual Data Collection Properties.



6. Subtract 6(minutes) from the Actual Availability value. The Change Description field allows you to enter a text string that describes the reason for the change. This field is optional. For this tutorial, enter Shift started 6 minutes late because of power outage.

7. Click OK to save your changes and close the dialog box. You

are returned to the FactoryTalk Metrics Detail/Manual Data Collection dialog box.

8. Click OK to close the FactoryTalk Metrics Detail/Manual Data Collection dialog box.


Chapter 5

Automated Configuration

FactoryTalk Metrics contains additional software and content which is designed to reduce the time it takes to implement a FactoryTalk Metrics system. This content automates the configuration of FactoryTalk Metrics if you have Rockwell Automation ControlLogix controllers that can utilize a User-Defined Type.

The additional content provided with FactoryTalk Metrics includes:

• FactoryTalk Metrics User-Defined Type (UDT). For more information about UDT, see "FactoryTalk Metrics UDT (page 105)".

• FactoryTalk Metrics Configuration Tool. The Configuration Tool automatically configures the performance parameters of work cells using the tag names in the UDT. See "Configuring FactoryTalk Transaction Manager (page 129)" and "Configuring FactoryTalk Metrics (page 114)".

This chapter will help you understand how to use the Configuration Tool to perform an automated configuration of FactoryTalk Metrics.

The UDT named FTM_Workcell provides a comprehensive set of data points you can use to configure FactoryTalk Metrics. The FactoryTalk Metrics UDT should satisfy many customers’ data collection needs. It is provided as a convenience for data point organization and faster configuration. Using the UDT requires the use of a compatible ControlLogix controller.

• Data point organization. The UDT organizes the data points that are typically used for FactoryTalk Metrics data collection

FactoryTalk Metrics UDT

Chapter 5 Automated Configuration


into a single structure that you can implement in a Logix-based control system program.

• Performance parameter configuration. The FactoryTalk Metrics Configuration tool uses the data point names in the UDT to automatically configure performance parameters for FactoryTalk Metrics work cells. Each data point is used for a particular performance parameter.

The FactoryTalk Metrics Configuration tool configures FactoryTalk Metrics performance parameters using the tag names in the UDT. Each work cell in the plant model uses a different instance of the UDT in the control system (see "Creating the Plant Model (page 125)"). Each work cell will be configured identically.

NOTE The FactoryTalk Metrics Configuration tool configures performance parameters in a specific manner. However, you can modify the performance parameters after you use the FactoryTalk Metrics Configuration tool. As the implementor, decide whether and how to change the performance parameters to meet the customer’s needs. You can modify work cell performance parameters as necessary using standard methods for FactoryTalk Metrics.

Following are the data points in the UDT and the corresponding performance parameters for which they will be used in FactoryTalk Metrics. As the implementor, you must modify the control system program to ensure that the UDT tags contain valid data for FactoryTalk Metrics to collect.

All UDT data points (unless otherwise noted) are used by the FactoryTalk Metrics Configuration Tool to configure FactoryTalk Metrics performance parameters. If a particular UDT data point is not used in a customer’s application, and therefore does not contain valid control system data, you will have to modify the FactoryTalk Metrics performance parameters. Do this after you run the FactoryTalk Metrics Configuration Tool to make sure that the unused data point is not used by FactoryTalk Metrics.

UDT Data Points and FactoryTalk Metrics Performance Parameters

Automated Configuration Chapter 5


The Part ID identifies the product being produced at the work cell. The value in this field should change when the work cell produces a different part. You must coordinate the PartId value with the part count values in order to associate the part counts with the correct Part Id.

Line UDT Field Name

Data Type FactoryTalk Metrics use

Scheduled /Unscheduled

1 PartId String Part ID Unscheduled

This value is the time required for one part to past through the work cell under ideal conditions. Ideal Cycle Time is a real value and represents seconds. Usually, the Ideal Cycle Time value changes only if the Part Id also changes.

Line UDT Field Name



2 IdealCT Real Ideal Cycle Time Unscheduled

NOTE The GoodParts tag should act like an accumulator and increase in value. This value should never decrease unless it is reset.

Good Parts is the count of the first quality parts produced by the work cell.

Line UDT Field Name



3 GoodParts Integer Good Part Count Unscheduled

Part ID

Ideal Cycle Time

Good Parts



NOTE The ScrapParts tag should act like an accumulator and increase in value. This value should never decrease unless it is reset.

Scrap Parts is the number of parts produced by a work cell that, for whatever reason, cannot be categorized as good parts. From a machine efficiency point of view, these parts have no value, and the cycle time taken to produce them at the current work cell has been wasted.

Line UDT Field Name



4 ScrapParts Integer Scrap Part Count Unscheduled

The Total Parts value is automatically calculated by FactoryTalk Metrics as:

Good Parts + Scrap Parts = Total Parts

The FactoryTalk Metrics Configuration Tool does not use Total Parts when configuring performance parameters and relies on FactoryTalk Metrics to calculate Total Parts as the sum of Good Parts and Scrap Parts. If the customer’s application requires that Total Parts be collected, you must configure Total Parts manually using the Configuration Console after you run the FactoryTalk Metrics Configuration Tool.

NOTE You can create a list to convert shift values to strings by using the Configuration Console. See "Configure the Scheduled Availability Parameters (page 58)".

By default, the FactoryTalk Metrics Configuration tool configures Scheduled Availability to be collected from the control system. The UDT’s Shift tag is expected to contain a number that corresponds to the work cell’s current shift number. If Shift is greater than zero, the work cell is assumed to be on shift and available to run.

Scrap Parts

Total Parts

Scheduled Availability



Line UDT Field Name



6 Shift Integer Scheduled Availability - Shift

Unscheduled

Running is used to determine whether or not a work cell is running. If the Running tag is high or true, the work cell is considered to be running. Running Time is an important component of several KPI calculations.

Line UDT Field Name



7 Running BOOL Running state indicator Unscheduled

Monitored Availability can be used as a real-time override of Scheduled Availability. It is commonly used to prevent Available Time from accumulating if the work cell is scheduled to be available but cannot produce due to some factor that is beyond its control.

Line UDT Field Name



8 MonitoredAvailability

BOOL MonitoredAvailability Unscheduled

NOTE Using the Configuration Console, you can create a list to convert the numeric values returned by this data point into string values for easier reporting. See "Configure the Scheduled Availability Parameters (page 58)".

Running

Monitored Availability

Custom Events - Monitored Value



The UDT contains one tag that is configured in FactoryTalk Metrics as a Monitored Value custom event. It is assumed that this tag will always contain a meaningful value, such as machine state code.

Line UDT Field Name



9 Monitored _Value

String Custom Events (Monitored Value type)

Unscheduled

The UDT contains an array of five Boolean values that are interpreted by FactoryTalk Metrics as triggers for five user-defined digital events. (There are actually 32 values in the array, but the FactoryTalk Metrics Configuration Tool only configures the first five.)

FactoryTalk Metrics will monitor each of these Boolean values, and each should represent a single important event that FactoryTalk Metrics will capture (such as an e-stop, downtime, light curtain break, product changeover, etc.). When the trigger value changes from 0 to 1 (or low to high), that is interpreted as the start of the event. A trigger value change from 1 to 0 (or high to low) is interpreted as the end of the event.

Once these events are configured in FactoryTalk Metrics by the FactoryTalk Metrics Configuration Tool, you should edit the performance parameters to give them meaningful names for reporting purposes. See "Modifying Performance Parameters (page 137)".

Digital events differ from analog events because analog events have an event value data point (such as an event reason code) in addition to the trigger data point.

Custom Events - Digital



Line UDT Field Name



9 Events_Digital

BOOL (32) Custom Events (with no event values)

Unscheduled

10 Events_Digital(0)

BOOL Event Trigger


BOOL Event Trigger


BOOL Event Trigger


BOOL Event Trigger


BOOL Event Trigger

The FTM_Workcell UDT contains a UDT called FTM_AnalogEvents — an array of one Boolean value and one Integer value. The UDT field called Events_Analog consists of an array of five occurrences of the FTM_AnalogEvents UDT. The five triggers are interpreted by FactoryTalk Metrics as triggers for five analog events. The five integers are interpreted as event values. Typically, reason codes for the event are provided by the operator or control system. Each of these trigger/value pairs are independent and should indicate that an important work cell event is occurring that FactoryTalk Metrics should track. The trigger value should change from 0 to 1 (or low to high) when the event to track is occurring, and should change back to 0 (or low) when the event ends. The control system should copy an event value to the Value data point before the event ends and the trigger returns to low. Each trigger/value pair should indicate only one distinct event that may have multiple causes (for example, downtime, operator stop, etc.).

Custom Events - Analog



Once these events are configured in FactoryTalk Metrics by the FactoryTalk Metrics Configuration tool, you should edit the performance parameters to give them meaningful names and to provide lookup lists to translate the integer values returned in the value data points to string values for reporting. See "Modifying Performance Parameters (page 137)".

Line UDT Field Name



Events _Analog

FTM_Analog Events[5]

Custom Events (with event values)

15 Trigger(0) BOOL Event Trigger Unscheduled 16 Value(0) Integer Event Value Scheduled 17 Trigger(1) BOOL Event Trigger Unscheduled 18 Value(1) Integer Event Value Scheduled 19 Trigger(2) BOOL Event Trigger Unscheduled 20 Value(2) Integer Event Value Scheduled 21 Trigger(3) BOOL Event Trigger Unscheduled 22 Value(3) Integer Event Value Scheduled 23 Trigger(4) BOOL Event Trigger Unscheduled 24 Value(4) Integer Event Value Scheduled

NOTE For more information about flex fields, see "Enabling Flex Fields (page 123)".

A FactoryTalk Metrics application can have five flex fields (or user-defined summarization criteria). These fields can be an integer, boolean, or string. Flex fields are defined system-wide for all work cells and are typically values (such as an operator id) necessary for providing context for performance reporting. The FactoryTalk Metrics Configuration Tool chooses the string tag for each flex field.

Flex Fields - String



Line UDT Field Name



Flex_String String Flex Fields (String type) Unscheduled 35 Flex_String(

0) Flex Field 1

36 Flex_String(1)

Flex Field 2

37 Flex_String(2)

Flex Field 3

38 Flex_String(3)

Flex Field 4

39 Flex_String(4)

Flex Field 5

Integer flex fields are valid flex field types and therefore are provided in the UDT. However, this type of flex field is not used by the FactoryTalk Metrics Configuration Tool. To use integer flex fields, you must configure the performance parameters manually and change the flex field data point from Flex_String to Flex_Integer.

Line UDT Field Name



Flex_Integer Int (5) Flex Fields (Integer type) Unscheduled 25 Flex_Integer

(0) Flex Field 1

26 Flex_Integer(1)

Flex Field 2

27 Flex_Integer(2)

Flex Field 3

28 Flex_Integer(3)

Flex Field 4

29 Flex_Integer(4)

Flex Field 5

Flex Fields - Integer



Boolean flex fields are valid flex field types and therefore are provided in the UDT. However, this type of flex field is not used by the FactoryTalk Metrics Configuration Tool. To use boolean flex fields, you must configure the performance parameters manually and change the flex field data point from Flex_String to Flex_Integer.

Line UDT Field Name



Flex_Real Int (5) Flex Fields (BOOL type) Unscheduled 30 Flex_Bool(0) BOOL (32) Flex Field 1 31 Flex_Bool(1) Flex Field 2 32 Flex_Bool(2) Flex Field 3 33 Flex_Bool(3) Flex Field 4 34 Flex_Bool(4) Flex Field 5

FactoryTalk Metrics Configuration Tool is designed to reduce the time it takes to implement a FactoryTalk Metrics system.

In this tutorial you will use the FactoryTalk Metrics User-Defined Type (UDT), RSLogix 5000, RSLinx Enterprise, and the FactoryTalk Metrics Configuration Tool to configure a functioning FactoryTalk Metrics application.

To configure FactoryTalk Metrics, you must modify specific information for the following:

• FactoryTalk Directory. Create users, applications, optionally define areas, create the RSLinx Enterprise connection, and create shortcuts. See "Configuring the FactoryTalk Directory (page 116)".

Flex Fields - Boolean

Using FactoryTalk Metrics Configuration Tool to Perform an Automated Configuration



• Service Console. Configure servers; assign privileges, licenses, and activations; and configure flex fields. See "Configuring the Service Console (page 120)".

• Plant model. Use the Configuration Console to create the plant model for your facility. See "Creating the Plant Model (page 125)".

• FactoryTalk Metrics UDT. Add the FactoryTalk Metrics UDT to your ControlLogix programs. This allows the FactoryTalk Metrics Configuration Tool to use the data points in the UDT for the FactoryTalk Metrics application. See "Adding the FactoryTalk Metrics UDT (page 126)".

• FactoryTalk Transaction Manager. Use the FactoryTalk Metrics Configuration Tool to create and import the FactoryTalk Transaction Manager configuration. See "Configuring FactoryTalk Transaction Manager (page 129)".

• Data collection. Use the Service Console to register the FactoryTalk Transaction Manager configuration for data collection. See "Registering the FactoryTalk Transaction Manager Configuration for Data Collection (page 135)".

• FactoryTalk Metrics. Use the FactoryTalk Metrics Configuration Tool to configure FactoryTalk Metrics using the data points in the UDTs in the controller programs. See "Configuring FactoryTalk Metrics (page 135)".

• Performance Parameters. Use the Configuration Console to modify and customize the performance parameters as necessary using the standard FactoryTalk Metrics capabilities. See "Modifying Performance Parameters (page 137)".

• Reports. Using the standard Report Expert report templates, create and manage parameter sets to satisfy your reporting requirements. Configure the report tree to add or modify reports as necessary. See "Configuring Reports (page 139)".



When you have made all of the desired modifications, you can start data collection for the FactoryTalk Metrics application. See "Starting a Data Collection (page 140)".

In order to configure FactoryTalk Directory for FactoryTalk Metrics, you must perform the following:

• Add users. Create user accounts in order for users to be able to use FactoryTalk Metrics. See "Adding FactoryTalk users (page 116)".

• Configure the OPC Server. Configure RSLinx Enterprise as the OPC server for FactoryTalk Metrics See "Configuring RSLinx Enterprise as the OPC Server (page 117)".

To create users who can access FactoryTalk Metrics, you must first create those users in the FactoryTalk Directory. In the FactoryTalk Directory you can create either FactoryTalk users or Windows-linked users. In the following steps you will create one FactoryTalk user called FTAuthor to whom you will later grant privileges to configure FactoryTalk Metrics.

To add users:

1. Launch the FactoryTalk Administration Console. Select Start > All Programs >Rockwell Software > FactoryTalk Administration Console.

2. Select the Network directory and click OK.

3. Double-click the Users and Groups folder to expand it.

4. Right-click the Users folder and select New.

5. Add a FactoryTalk user (for example, “FTAuthor”).

Configuring FactoryTalk Metrics: New vs. Update Configuring FactoryTalk Directory

Adding FactoryTalk Users



NOTE A Windows-linked user is validated by Windows. If applicable, use Windows-linked group accounts rather than Windows-linked user accounts. This simplifies the process if you ever move your software to a different domain. You cannot move individual Windows-linked user accounts from one domain to another. You can move Windows-linked group accounts to a new domain, while retaining all of the security permissions for the group. If you change the domain an individual Windows-linked user account belongs to, you must delete the old account, create the new account, and then recreate all of the security permissions for the new account. To set up the security policy according to the customer’s needs, refer to the FactoryTalk Security Quick Start Guide.

Configure RSLinx Enterprise as the OPC server. RSLinx Enterprise must be used as the OPC server in order to use the FactoryTalk Metrics UDT in ControlLogix controllers and the FactoryTalk Metrics Configuration Tool to configure FactoryTalk Metrics. Other OPC servers may also be required if controllers other than ControlLogix are used as sources for FactoryTalk Metrics data. When you installed RSLinx Enterprise, it became available in the FactoryTalk Administration Console.

To configure RSLinx Enterprise, do the following steps:

1. Step 1: Check the Processor connections.

1. Click the Communications tab at the bottom of the FactoryTalk Administration Console.

2. Verify the connection to the processors. Drivers and/or devices may need to be added to access the appropriate processors.

2. Step 2: Create an Application and Server for RSLinx Enterprise.

Configuring RSLinx Enterprise as the OPC Server



Create a new application for your RSLinx Enterprise OPC server and then verify the computer hosting the server. All of the OPC servers and controllers that FactoryTalk Metrics uses should be contained within a single application in the FactoryTalk Directory.

To add an application:

1. On the Application tab, right-click the network and select New Application.

2. Type a name and description for the application (for example, FTApp) and click OK . The new application appears under the network tree item at the bottom of the FactoryTalk Administration Console.

3. Right-click the new application and select Add New Server > Rockwell Automation Device Server (RSLinx Enterprise). The RSLinx Server Properties dialog box opens.

4. Verify the computer name hosting the RSLinx Enterprise Server.

NOTE To configure the Redundancy and the FactoryTalk Alarms and Events tabs as necessary, refer to the RSLinx Enterprise User Guide .

5. Click OK . The new server appears under the application.

1. Step 3: Add areas (optional).

Areas organize and subdivide a distributed network application into logical or physical divisions. For example, separate areas might correspond with separate manufacturing lines in a facility, separate plants in different geographical locations, or different manufacturing processes.

Adding areas to a FactoryTalk Directory application is optional.



To add areas:

1. Right-click your new application (for example, FTApp) and select New Area . The New Area dialog box opens.

2. In the Name field, type a name for the new area (for example, FTArea1). Enter an optional description and click OK. The new area appears under the Application tree item.

3. Repeat steps 2 and 3 for each additional area.

1. Step 4: Add shortcuts.

Add shortcuts to reference each of the ControlLogix controllers and verify the communication.

To add shortcuts and verify their communication:

1. Click the plus sign (+) to open the new RSLinx Enterprise server you just created and double-click the Communication Setup tree item. If necessary, maximize the FactoryTalk Administration Console to see the entire configuration.

2. To create a new shortcut, click Add. “New Shortcut” appears.

3. Type the shortcut name to reference all data points within a specific ControlLogix device. If one device will contain only the data points for one FTMLE work cell, consider using the same name for both the work cell (see "Creating the Plant Model (page 125)") and the shortcut (for example, “Filler”). This is the convention used by the FactoryTalk Metrics Configuration Tool. If data points from more than one work cell will be contained in one device, use some other meaningful name for the shortcut. Create one shortcut for each device.



4. Once you name the shortcut, click the Primary tab to the right of the shortcuts and navigate to the controller’s connection.

5. Select the controller and at the top of the dialog box, click Apply . Click Yes to apply the changes.

6. At the bottom of the dialog box, click Verify to open the Shortcut Verifier dialog box. For help completing the dialog box, click How to use the Shortcut Verifier at the bottom of the Shortcut Verifier dialog box.

7. At the bottom of the Communication Setup dialog box, click OK.

NOTE The default installation of FactoryTalk Metrics assumes that all components will be installed on the same computer.

8. Close the FactoryTalk Administration Console.

When you first configure the Service Console you must perform the following:

• Configure servers. Register the Security Services Manager and Information Services Manager and associate the Metrics Server Manager. See "Configuring Servers (page 120)".

• Assign user privileges, licensing, and activation. Give FactoryTalk Directory users FactoryTalk Metrics privileges and activations and assign work cell licenses and activations to the Information Services Manager. See "Assigning User Privileges, Licensing and Activation (page 122)".

• Enable flex fields. FactoryTalk Metrics configures five flex fields. Enable the desired flex fields. See "Enable Flex Fields (page 123)".

You must register the Security Services Manager, Information Services Manager and Metrics Server Manager.

Configuring the Service Console

Configuring Servers



To register the servers:

1. Select Start > Programs > Rockwell Software > > Service Console to open the Service Console.

2. If you are working with a clean installation of FactoryTalk Metrics, the message “No Security Services Manager have been registered. Would you like to register one now?” appears. If this prompt appears, click Yes and then complete the Service Console Registration dialog box.

NOTE If you are logged in as a Windows Administrator, you are automatically logged into the Service Console. If not, you must log in using a FactoryTalk user name that is a member of the Administrators group. See "Adding FactoryTalk users (page 116)".

3. Register the Information Services Manager server. Right-click the Servers tree item (under the Security Services Manager) and select Register Server. The Service Console Registration dialog box appears.

4. In the Server Type field, click the drop-down arrow and select Information Services Manager and then click OK. When you expand the Servers tree item, a yellow question mark will appear next to the Information Services Manager, indicating it is not completely configured.

5. To complete its configuration, select the Information Services Manager tree item in the tree and then in the Data Connection Properties on the right side of the window, complete the following fields:

• Data Sources. Select the FactoryTalk Metrics DSN (for example, FTMDSN).

• Database User ID. Enter the user id for the SQL Server database (for example, FTMUser).

• Database Password. Enter the user’s password for the SQL Server database.



NOTE For more information on completing the Data Connection Properties dialog box, click Help.

6. To test the connection, click Test Connection. When the connection is successful, click OK.

7. Click Apply and then click Yes to restart the server.

8. When the warning message appears regarding not rebooting until the Information Services Manager has started, click OK. The database will be initialized with the RSBizWare schema for FactoryTalk Metrics. When this is complete, the message “The server is running” appears at the top of the window.

9. To associate the Metrics Server Manager, under the Servers tree item, right-click the Information Services Manager tree item and select Associate Metrics Server Manager. Complete the Service Console Registration dialog box to associate the Metrics Server Manager. Click the Metrics Server Manager tree item and complete the Database Connection Properties in the pane on the right. Use the DSN, user name, and password that you used in step 5.

NOTE For more information on configuring the Service Console, refer to the Administration Guide.

The FactoryTalk Metrics product activations that have been purchased must be assigned to the server where the product is installed. In this section you will also import the FactoryTalk users into the Service Console and assign user licenses and privileges. For more information, refer to the Administration Guide.

1. To assign activations to the Information Services Manager, open the Security Services Manager, Administration, and Activations tree items. Select the desired activations and click Assign an Activation to assign it to the Information Services Manager. You will need to assign at least one Metrics Server

Assigning User Privileges, Licensing and Activation



Manager activation, at least one FactoryTalk Metrics Author activation, and at least one RSBizWare Runtime activation.

2. To synchronize the FactoryTalk Directory users with the RSBizWare database, under the Administration tree item, select Users and Groups and click Refresh at the bottom of the right pane. Any users or groups you created earlier will now appear.

3. To grant privileges to a user, select the user who to whom you want to grant permission to configure FactoryTalk Metrics (for example, FTAuthor) and click Edit User Properties. The Security Control dialog box appears.

4. Click the License & Activation tab and select FactoryTalk Metrics Author check box. This allows the user to configure FactoryTalk Metrics using the Configuration Console and the FactoryTalk Metrics Configuration Tool. This also consumes one FactoryTalk Metrics Author activation. We will assume that the user is FTAuthor. You may make as many users authors as you have FactoryTalk Metrics Author activations.

5. Click the Privileges tab and select all of the privileges. This ensures that the user will have the ability to perform all tasks from within FactoryTalk Metrics.

6. Click OK.

NOTE For more information on configuring the Service Console, refer to the Administration Guide.

Flex fields, or user-defined summarization criteria, are optional data values you can collect from the control system to give the rest of your historical data additional context. The standard summarization criteria include Shift and Part Id. Therefore, you can group or sort all FactoryTalk Metrics data you collect by these values. You can define additional flex fields at the system level. Each configured work cell can optionally collect flex field data from the control system. At

Enabling Flex Fields



the system level you only enable, name, and define types for flex fields available for collection. For more information about flex fields, refer to the Administration Guide.

FactoryTalk Metrics allows up to five flex fields.

To enable flex fields:

1. In the Service Console under the Metrics Server Manager tree item, select the FactoryTalk Metrics Flex-Fields tree item. The five FactoryTalk Metrics flex fields (user-defined summarization fields) appear.

2. To enable a flex field, double-click the row of the desired flex field and select the following options on the Configure Summarization Criteria dialog box:

• Name. Flex fields are named by default (for example, User Defined Summarization Field 1, etc.). If you don't change the flex field name here, the name will appear as User Defined Summarization Field 1 in the Performance Parameter screen as well as in the Report Expert parameters. The name you assign here will reference the flex field throughout the application.

• Enable This Summarization Criteria. This enables the selected flex field. Flex fields that are not enabled do not appear elsewhere in the application.

• String Value. Select this option because the FactoryTalk Metrics Configuration Tool only configures the string values in the UDT for use as flex fields. If the flex field you want to use is either numeric or boolean, you may configure it as such here, but you will have to modify the performance parameters that the FactoryTalk Metrics Configuration Tool creates to use an integer or boolean data point for the flex field value.

3. Click OK.



4. Repeat steps 2 and 3 for each additional flex field you would like to enable (up to five flex fields). The flex fields you enable will be included in the performance parameters for all the work cells you define in the FactoryTalk Metrics application.

NOTE The default installation of FactoryTalk Metrics assumes that all components will be installed on the same computer.

5. Close the Service Console.

To use the FactoryTalk Metrics Configuration Tool effectively, you will create one instance of the FactoryTalk Metrics UDT in the control system for each work cell defined in the plant model.

NOTE For more information about creating the plant model, with additional work cells, refer to the Administration Guide.

Create entries in the plant model for at least the site, area, line, and work cell levels shown because this is the plant model structure that is used in the Report Expert report templates. Typically, machines that are to be monitored by FactoryTalk Metrics are defined at the work cell level. The FactoryTalk Metrics Configuration Tool only configures plant model entries at the work cell level.

To add work cells:

1. Launch the Configuration Console. To do this, select Start > All Programs > Rockwell Software > > Configuration Console.

2. Under FactoryTalk Tasks, click Configure the Plant Model. The Plant Model dialog box appears.

3. To create an entry at the plant model’s root level, right-click anywhere in the window and select New Root Enterprise or New Root Site. To create an entry at a lower level, right-click an entry in the plant model, select New Activity Area, and then select the appropriate level for the new entry.

Creating the Plant Model



4. At the work cell level of the plant model, type the name of the work cell (for example, Filler).

5. Add the remaining work cells for your plant model and then click OK.

For each work cell to be included in the FactoryTalk Metrics application, you must create an instance of the FactoryTalk Metrics UDT in the control system to serve as a data source for that work cell. You must add the UDT definition to the appropriate RSLogix 5000 control program, create an instance of the UDT, and add MOV or other instructions to the program to ensure that the UDT data points will contain valid data. For a discussion of how each of the FactoryTalk Metrics performance parameters relates to the tags in the UDT, see "UDT Data Points and FactoryTalk Metrics Performance (page 106)".

NOTE All data points in the UDT, with the exception of Good Parts, are optional. Therefore, you do not have to use all of the data points contained in the UDT. The FactoryTalk Metrics Configuration Tool will map the data points to the appropriate FactoryTalk Metrics performance parameters, and you will have to manually remove the data points that you do not use from the FactoryTalk Metrics performance parameters. See "Modifying Performance Parameters (page 137)".

To import the UDT:

1. Launch RSLogix 5000. Select Start > All Programs > Rockwell Software >RSLogix 5000 Enterprise Series > RSLogix 5000.

2. Open your controller program file into which you want to import the UDT.

3. Right-click the User-Defined folder (located in the Data Types folder) and select Import Data Type to import FactoryTalk Metrics UDT.

4. Browse to select the FTM_Workcell.L5X file and click Import.

Adding the FactoryTalk Metrics UDT



NOTE By default the FTM_Workcell.L5X UDT file is located in the following location: C:\Program Files\Rockwell Software\RSBizWare.

5. When the file is imported two UDTs (FTM_AnalogEvents and FTM_Workcell) appear under the User-Defined folder. You will use these data types later to create an array of tags specifically designed to store FactoryTalk Metrics data.

6. To see the UDT’s tags, select the FTM_Workcell tree item.

NOTE If the controller program contains data points for more than one work cell that will be configured in FactoryTalk Metrics, you can create an array of UDTs rather than creating several instances of the UDT with different names. UDT arrays are supported by the FactoryTalk Metrics Configuration Tool as a convenience. The dimension of the array should be the same as the number of work cells that are included in the controller program. The suggested name of the UDT array is "Workcell" because this is the default name that the FactoryTalk Metrics Configuration Tool uses.

7. Create the necessary number of instances of the FTM_Workcell UDT in the controller program. In the controller program’s (project name) folder, right-click Controller Tags and select New Tag.

8. In the Name field of the New Tag dialog box, type the name of the tag (for example, Workcell) and enter an optional description.

9. After the Data Type field, click the Browse button.

10. In the Select Data Type dialog box, scroll the list of data types to select FTM_Workcell.



11. In the Dim 0 field, change the value to the number of work cells in the controller program. This will create an array of the same number of instances of the FTM_Workcell UDT.

12. Click OK. The New Tag dialog box reappears.

13. Click OK. The array of UDT instances now appears at the bottom of the list of the project name’s controller tags. The tags are named Workcell[0], Workcell[1], etc. These instances are sufficient to configure the same number of FactoryTalk Metrics work cells.

14. It is necessary to change the existing program file to ensure that the data points in the UDT that you want to use in the FactoryTalk Metrics application contain accurate and timely data. In general, the type of instruction that you will add to the program depends on the destination data type:

• Integer data types. For integer data types such as the Part Counts in the UDT, use Move (MOV) instructions.

• Boolean data types. For Boolean data types such as Event Triggers, use a combination of Examine On and Output Energize instructions.

• String data types. For string data types such as Part ID and Flex_String values, use the Copy (COP) instruction. In the Length field of the COP instruction, the Source_Tag.LEN value should be specified.

NOTE For information about adding instructions to your program file, refer to the RSLogix 5000 Common Procedures Programming Manual and associated RSLogix documentation.

15. To deploy the program file with the UDT to the controller, select Communications >Download. Once the program is loaded to the controller, you can run the program file. Select Communications > Run mode.

16. Repeat the above process for each controller program that the FactoryTalk Metrics application will use.



17. Close RSLogix 5000.

Use the FactoryTalk Metrics Configuration Tool to create a FactoryTalk Transaction Manager configuration or modify an existing one. You will later use the configuration tool to configure FactoryTalk Metrics.

NOTE You should not run the FactoryTalk Metrics Configuration Tool if FactoryTalk Metrics is collecting data. Stop the FactoryTalk Transaction Manager configuration before running the configuration tool. You cannot run the FactoryTalk Metrics Configuration Tool from a remote location. You must run the configuration tool where the FactoryTalk Metrics components, FactoryTalk Metrics and FactoryTalk Transaction Manager software products are installed.

Launch the FactoryTalk Metrics Configuration Tool. Select Start > Programs >Rockwell Software > FactoryTalk Metrics> FactoryTalk Metrics Configuration Tool. The FactoryTalk Metrics Configuration tool opens performance parameters using the data points in the UDT structures in the controller programs.

Connect to the FactoryTalk Metrics database to populate the configuration tool with the work cells from the plant model.

NOTE For more information about installing and creating a database for use with FactoryTalk Metrics, see the Administration Guide, chapter "Installing and Creating an SQL Server Database".

Configuring FactoryTalk Transaction Manager

Loading the Plant Model from the Database



1. Click the Database tab:

2. Complete the following fields:

• Data Source Name. Click the drop-down arrow to select the name of the DSN (for example, FTMDSN).

• DB user name. Type the username of the SQL Server database login account (for example, FTMUser).

• DB user password. Type the password of the SQL Server database login account.

3. Click Load from database to load the list of work cells configured in the plant model into the SQL Server database. The same data that appears on this tab will also appear on the FactoryTalk Transaction Manager and FactoryTalk Metrics tabs.

The configuration tool’s FactoryTalk Transaction Manager tab allows you to:

• Create the FactoryTalk Transaction Manager configuration if it does not exist.

• Select the work cells in the plant model to be configured with performance parameters.

Creating and Importing the FactoryTalk Transaction Manager Configuration



• For each work cell to be configured, identify the location in the control system where the UDT is located.

• Create the transactions necessary to configure the performance parameters for the selected work cells by creating an XML data file and then importing that file into FactoryTalk Transaction Manager.

NOTE If you intend to use an existing FactoryTalk Transaction Manager configuration, that configuration must contain a FactoryTalk Live Data control connector and a FactoryTalk Metrics enterprise connector.

1. Click the FactoryTalk Transaction Manager tab:


• FTTM XML out. Select the location where you want to store the FactoryTalk Transaction Manager XML configuration file. This is a temporary file used by the tool to contain the configuration that you will import into FactoryTalk Transaction Manager (and may include only the data points or the entire configuration with connectors and configuration location).

• FTTM config name. Type a name for the FactoryTalk Transaction Manager configuration you are about to create. You can use an existing configuration used by FactoryTalk



Metrics or you can enter a new name (for example, “FTMetrics”) and the configuration will be created.

• FTTM config path. Select the location where FactoryTalk Transaction Manager stores its files. If a FactoryTalk Transaction Manager configuration exists, you must use the existing path. If the configuration doesn't exist, this path will be used when the configuration is created.

• Application name. FactoryTalk Transaction Manager can only use data points from one FactoryTalk Directory application. Type the name of the application you created in the FactoryTalk Directory (for example, "FTApp").

• Connector user name. Type the user name for all FactoryTalk Transaction Manager connectors (for example, type COMPUTER NAME\User name). This Windows user must have permission to launch a Windows service.

• Connector password. Type the connector user's password. If you do not enter a password and there is an existing password, the password remains unchanged.

3. To generate data points only (if you have already created your configuration in FactoryTalk Transaction Manager and only want to add new data points to the configuration), select DataPoints only.

NOTE By default, all of the work cells are selected. To deselect work cells individually, uncheck the Generate box for the work cell. To deselect all of the work cells simultaneously, click Deselect all. The button then changes to Select all and you can now use it to select all work cells simultaneously. To select individual work cells, select the Generate box for the work cell.

IMPORTANT To avoid overwriting your existing work cell information, select only new work cells for generation (do not generate existing work cells that have already been configured).

4. To associate each work cell with the correct UDT in the control system, modify the following fields (except the work cell name) for each work cell:



• Work Cell. The name of the work cell in the database. You cannot change this field.

• Area Path. If the Linx Enterprise shortcut that contains the UDT for this work cell is contained within an area, type the area name as it appears in the FactoryTalk Administration Console. If the shortcut is in an area is an area within an area, enter a slash between the area names (for example, FTArea1/FTArea2). If you did not create an area path in the application (for example, if the OPC Server is located directly in the application root folder), you must leave this field blank.

• Linx Enterprise Shortcut. Type the name of the shortcut created for the ControlLogix processor in Linx Enterprise. By default, the name chosen by the configuration tool is the same as the work cell name. If the name of the Linx Enterprise shortcut is different than the work cell name, type a new shortcut name.

• Structure Name. Type the name of the FactoryTalk Metrics UDT instance in the controller program.

• Position In Structure. If you created a UDT array in the controller program, click the drop-down arrow to select the position in the array for the UDT that corresponds to this work cell.

IMPORTANT Any changes you make to a work cell in the FactoryTalk Metrics Configuration tool will overwrite the work cell's configuration.

5. To apply the same area path, Linx Enterprise shortcut, or structure (tag) name to all of the selected work cells, enter the data in the empty cell above the column heading and click Apply. If you leave the cell above a column heading entry empty, the data for that column does not change.

6. To generate the XML file, click Generate FTTM XML. Once the XML configuration file is generated, do not edit the file before you import it.



7. To import the newly generated XML configuration file to FactoryTalk Transaction Manager, click Import to FTTM. Following are examples of data point names generated by the configuration tool. Each data point name begins with "FT" which is the name assigned to the FactoryTalk Live Data connector in the FactoryTalk Transaction Manager configuration.

• With area and a single UDT instance (not an array): FT.ApplicationName._AREAName::_ShortCutName_UDTName_. UDTDatapoint Name

• With area and UDT as an array: FT.ApplicationName._AREAName::_ShortCutName_UDTName_Occurrence#_.UDTDatapointName

NOTE If you try to import the configuration where FactoryTalk Transaction Manager is not installed, the error message “FactoryTalk Transaction Manager is not installed properly” appears. The XML file is validated automatically by the FactoryTalk Metrics Configuration Tool when the file is imported, so you do not need to validate the file before importing it to FactoryTalk Transaction Manager. If the file is not valid, the message “Error during import to FactoryTalk Transaction Manager” appears. If there is a log file to which you can refer, the message “Error during import to FactoryTalk Transaction Manager. See details in (log file name).” appears. This log fie is located where the XML file is located.

8. Minimize, but do not close, the FactoryTalk Metrics Configuration Tool while you register the FTTM configuration.

NOTE If you close the configuration tool before configuring the FactoryTalk Metrics tab (see "Configuring FactoryTalk Metrics (page 135)"), you will have to complete the work cells list on the FactoryTalk Transaction Manager tab (with the appropriate area path, shortcut, structure name, and position) again.



If you created the FactoryTalk Transaction Manager configuration on the FactoryTalk Transaction Manager tab of the configuration tool (see "Configuring FactoryTalk Transaction Manager (page 129)") you must register the FactoryTalk Transaction Manager configuration for data collection. Register the FactoryTalk Transaction Manager configuration for use with FactoryTalk Metrics through the Service Console.

NOTE If you have an existing FactoryTalk Transaction Manager configuration that you have already registered, you do not have to register that FactoryTalk Transaction Manager configuration for data collection.

To register the FactoryTalk Transaction Manager configuration for data collection:

1. If you closed the Service Console earlier, launch it again. Select Start > Programs > Rockwell Software > > Service Console.

2. Open the Service Console, Security Services Manager, Servers, and Information Services Manager tree items.

3. Right-click the Data Collection tree item and select Register FactoryTalk Transaction Manager Configuration.

4. Complete the wizard to register the configuration. Be sure and select FactoryTalk Metrics for the data collection.

5. Close the Service Console.

Return to the FactoryTalk Metrics Configuration Tool to configure the performance parameters for the FactoryTalk Metrics work cells. The configuration tool creates an XML file for configuring FactoryTalk Metrics and then imports that configuration file.

Registering the FactoryTalk Transaction Manager Configuration for Data Collection

Configuring the FactoryTalk Metrics



1. From the FactoryTalk Metrics Configuration Tool, click the FactoryTalk Metrics tab:

2. In the FactoryTalk Metrics XML file field, click the browse

button to select the location where you want to create the FactoryTalk Metrics XML file.

3. To update the data on this tab with the data from the FactoryTalk Metrics database, click Update lists from database.

IMPORTANT Do not make any changes to the work cell data on this tab. Any changes you make to the work cells on this FactoryTalk Metrics tab will cause the data in the FactoryTalk Transaction Manager configuration and the data in the FactoryTalk Metrics performance parameters to be inconsistent. Therefore, the data collection for the work cells will not work properly.

Do not make any changes to the work cell data on this tab. Any changes you make to the work cells on this FactoryTalk Metrics tab will cause the data in the FactoryTalk Transaction Manager configuration and the data in the FactoryTalk Metrics performance parameters to be inconsistent. Therefore, the data collection for the work cells will not work properly.


• BizWare login. Type the login name of an RSBizWare user with FactoryTalk Metrics Authoring privileges.



• BizWare password. Type the password for the RSBizWare user.

• FTTM configuration. Select the name of the FactoryTalk Transaction Manager configuration you generated on the FactoryTalk Transaction Manager tab. This is necessary because the data that configures both FactoryTalk Transaction Manager and FactoryTalk Metrics must be the same.

• Disable events. Select this option to disable all custom events in the configuration. The new events (Analog, Digital, and Monitored Value) for the selected work cells will still be created, but they will be disabled. In addition, all custom events for all work cells, whether or not you select them in the configuration tool, will be disabled. You must manually enable any custom events that you want FactoryTalk Metrics to collect. If the import fails, the events may still be disabled.

IMPORTANT If you select Disable events, you will disable all events in the FactoryTalk Metrics application for all work cells, whether or not the work cells are selected for configuration in the FactoryTalk Metrics Configuration Tool.

5. To generate the FactoryTalk Metrics configuration file, click Generate FactoryTalk Metrics XML.

6. To import the work cell data to FactoryTalk Metrics, click Import to FactoryTalk Metrics. Unless a warning message appears, the configuration for FactoryTalk Metrics is imported into FactoryTalk Metrics.

Once the FactoryTalk Metrics performance parameters are imported into FactoryTalk Metrics, you can customize them.

Changes are made through the Configuration Console. For more information about changing performance parameters, see chapter "Collecting Performance Data (page 27)".

Modifying Performance Parameters



After you have used the FactoryTalk Metrics Configuration Tool:

• Every data point in the FactoryTalk Metrics UDT is mapped to the appropriate performance parameter for every work cell. You may not have use for all of the data points in the UDT, and you may not have programmed them to contain valid data when you added the UDT to the control program. If the control program is not populating a UDT data point with valid data, you should delete that data point from the performance parameters. In the case of events, you can disable or deleted unused events.

• Every work cell is configured identically. In a real application this is rarely the case. You can customize each work cell using the Configuration Console.

• Check to make sure the performance parameters are configured as expected and are programmed in the controller (for example, all event triggers are configured for low to high transition).

• Default names are assigned to events, and events are grouped into categories by event type. You may want to change the way events are grouped and change the event names and event categories to be more meaningful.

• No lookup lists are created by the configuration tool. You will want to make lookup lists to translate integer values for analog event values and shift numbers into string values. String values are more useful in both reports and in Report Expert parameters. You can also make lookup lists for machine states.

• Each work cell is disabled, you must enable it manually.

• If you chose to disable events in the configuration tool, you must manually enable all the events that you want FactoryTalk Metrics to use. You must do this for all work cells, not just the work cells you selected in the configuration tool.



• You may want to add performance parameters that use data points not contained in the UDT, such as additional events.

Some performance parameters are not configured by the FactoryTalk Metrics Configuration Tool. You must configure these manually. Performance parameters that are not configured by the configuration tool include:

• Scheduled Availability using Time Patterns, as an alternative to collecting shift information from the control system

• Machine States - required to use some of the standard reports provided with Report Expert

• Event severity

• Lookup lists

• Event value - choose the Beginning or Ending value

• Fault Metrics

NOTE If you run the FactoryTalk Metrics Configuration Tool again, all of your custom changes to the performance parameters (for the work cells selected in the configuration tool) will be lost.

Although FactoryTalk Metrics contains over 40 configured reports in the Report Expert environment, every customer will require reports that are not provided. The Report Expert User Guide contains instructions on how to create and manage parameter sets and the Report Explorer to extend the standard Report Expert report templates. To see a list of standard Report Expert report templates, refer to the Report Expert User Guide.

You can use the following options to create additional reports:

Configuring Reports



• Quick Web. This legacy FactoryTalk Metrics reporting environment provides a relatively easy method to create custom reports. You can access these reports from the Report Expert web page. No standard reports are provided.

• Microsoft Reporting Services. This custom report feature is provided with SQL Server. Report Builder is easy to use, but has limited functionality. SQL Server Business Intelligence Development Studio offers more functionality, but requires more technical knowledge. Reports deployed to Microsoft Reporting Services can be added to and viewed from Report Expert.

• Third-Party Reporting Tools. You can use third-party reporting tools report on data in the FactoryTalk Metrics database.

After you complete the FactoryTalk Metrics configuration, you must start the FactoryTalk Transaction Manager configuration in order to begin collecting FactoryTalk Metrics data from the control system.

1. From the Configuration Console, select Tools > FactoryTalk Transaction Manager > Manage FactoryTalk Transaction Manager Configurations.

2. Select the FactoryTalk Transaction Manager configuration and click Start. Services should start and the traffic light should turn green.

3. Click OK.

Starting a Data Collection


Chapter 6

Analyzing FactoryTalk Metrics Data

FactoryTalk Metrics provides a graphical environment in which to analyze production and process data. This chapter will help report designers understand how to use FactoryTalk Metrics to create and view RSBizWare reports containing OEE charts; bar, pie, and line charts; and tables. We will discuss the parts of a report, look at the sample reports that are installed with the software, create a report based on the sample data, and discuss the creation of more complex reports. FactoryTalk Metrics must be set up by the RSBizWare administrator before you can start to create reports using real data.

In RSBizWare, a report is a complete, formatted document that is made up of one or more report objects that have been placed on an HTML document along with text, graphics, and/or hyperlinks. A report—saved as an .htm file—is created and edited using the Configuration Console with a FactoryTalk Metrics Author license. RSBizWare reports can also be edited using Web-authoring tools such as Microsoft FrontPage.

An RSBizWare report object shows the data from a database table or view in a meaningful graphic or tabular presentation. The report object defines how data is to be shown to the user. It defines both the visual representation of the data (e.g., pie chart, bar chart, table) as well as the data sorting and summarization.

The data for the report object comes from an RSBizWare report data source. A report data source is a connection to a table or view within the RSBizWare database or an external database.

The data in the report object may be restricted by a query (the filter), made up of one or more search criteria, that determines which

Create a New RSBizWare Report

Chapter 6 Analyzing FactoryTalk Metrics Data


records from the report data source will be shown. The use of a filter is optional.

To create a new, blank report in the work area, from the main menu, select File > New Report. Now you are ready to start inserting items on your report. You can insert any combination of text, hyperlinks, pictures, and/or report objects. For this tutorial, let’s create an RSBizWare report that we can use as a Web page for the BizBikes factory. Our factory will be posting this Web page so BizBikes factories in other locations can view our manufacturing data.

First, we will create a title for the Web page and we will add the BizBikes logo to the report and make it a hyperlink to Rockwell Automation’s BizBikes sample Web site.

1. To insert the title, simply place the cursor where you want the text to appear and type BizBikes Web Page. Use the Report Formatting toolbar shown below to change the font to Arial and the font size to 18 point.

2. Place the cursor on the report where you want the logo to

appear and, from the main menu, select Insert > Picture. The Picture dialog box will be displayed, allowing you to select the picture that will be added to the report and set some picture display properties.

3. If you accepted the default installation when you installed the Configuration Console software, use the browse (...) button to navigate to C:\Program Files\Rockwell Software\RSBizWare\ and select the BizBikes_logo.gif file. If you did not accept the default installation, you will need to browse to the appropriate directory into which you installed the software.

4. Enter BizBikes Web in the Alternate Text box. The Alternate Text will appear as the pop-up text when you hover your mouse pointer over the image.

Insert Text, Pictures, and Hyperlinks Into Your Report

Analyzing FactoryTalk Metrics Data Chapter 6


5. When you click OK, the BizBikes logo will be displayed on your report.

6. Click the logo that you just inserted and select Insert > Hyperlink from the main menu to display the Hyperlink dialog box.

7. Make sure http: is selected in the Type list and enter http://www.software.rockwell.com in the URL box.

8. Click OK to convert the BizBikes logo into a hyperlink.

You also can convert text into a hyperlink. For example, you could add the text Home to the report and convert it to a hyperlink to your organization’s Web site.

When you author an RSBizWare report, you are working in design mode. Design mode allows you to edit the report, insert text and report objects, and resize and arrange the objects on the report. To see the RSBizWare report as the user would see it, you will use preview mode, which prevents editing the report objects and the report.

To view the report in preview mode, select View > Preview Mode

from the main menu or click the Preview Mode button on the Report Formatting toolbar.

To return to design mode, select View > Design Mode from the

main menu or click the Design Mode button on the Report Formatting toolbar. You must have an Author license and the appropriate object permissions for a report and the report objects and filters that are used on the report in order to be able to edit the report, report objects, and filters.

Before you continue, you may want to save your RSBizWare report. When you save your report, it is saved as an HTML document on the Information Services Manager computer to which your

View Your Report In Preview Mode

Save Your Report

http://www.software.rockwell.com/



Configuration Console is connected and will appear as a tree item on your Report Explorer.

1. With the report still displayed in the work area, from the main menu, select File > Save Report As to display the Save Report As dialog box.

2. Enter BizBikes Web Page in the Report Name box. This is the

name that will show on the Report Explorer for this report.

3. Click Save to save the report and close the dialog box.

4. Let’s move our report to the BizBikes folder of the Report Explorer tree. From the main menu, select Configure > Reporting > Report Explorer to display the Report Explorer dialog box.



5. Highlight the report name in the tree control at the top of the dialog box and use the Move Item buttons to move the report to the BizBikes folder. (Click the up arrow three times and the right arrow once.)

6. Now let’s set the permissions for this report. Click the

Permissions button to display the Report Permissions dialog box, where you control the users and groups who will have view, edit, delete, and security permissions for this report.



7. Select the check boxes to the left of those permissions that you want to grant to everyone. For this tutorial, select the Edit Report check box. This will allow everyone who has been assigned a FactoryTalk Metrics Author license to edit and save changes to your report. You can grant permissions to users or groups in the same manner.

NOTE Changing permissions for the report does not affect the permissions of the report objects that have been added to the report.

8. Click OK to save your changes and return to the Report Explorer dialog box.


Now that you have saved your report to the Report Explorer, you can access the report by simply clicking the tree item in the Report Explorer.

The Configuration Console allows you to view report objects that other users have created and to add them to your report. For this tutorial, we will add a saved report object that was created when the

Add a Saved Report Object To Your Report



FactoryTalk Metrics sample data was installed. This report object will be used in the section entitled "Create a New Chart (page 154)".

1. With the BizBikes Web Page report open in the work area, place your cursor in the report where you want the report object to appear. Then from the main menu, select Insert > Existing RSBizWare Report Object to display the prompt below.

Each report object on a report can connect to a different Information Services Manager in your organization. Therefore, before you continue, you must identify the server to which this report object will connect. If you want your report object to connect to a different server than the one specified, click No to display the login dialog box where you will provide the user name, password, and server that you want to use to author the report object.

For this tutorial, click Yes to accept the default user name and server.



2. The RSBizWare Report Object Properties dialog box appears. Use this dialog box to select the report object that you want to insert in your report.

3. The lists at the top of this dialog box contain the report data

sources, report objects, and filters to which you have been granted permissions. Select FactoryTalk Metrics Workcell History from the list of report data sources. This is the data that will be shown in the report object.

4. Report objects are grouped by the report data source from which they get their data. When you selected a report data source, the list of report objects was refreshed to show only the report objects that are based on the selected report data source. Select Workcell History from the list of report objects.

5. For this example, we will not select a filter, so leave the filter list blank.

NOTE Filters are grouped by the report data source for which they have been created.



6. The check boxes at the bottom of the dialog box allow you to add toolbars to the report object. The end user of your report will use these toolbars to adjust the report object to suit his or her needs. Select the Status Bar check box. This will cause a status bar to display at the bottom of the report object. Because each report object on a report can connect to a different server, the status bar will indicate the user and server to which the report object is connected at run time.

7. Click OK to add the report object to the report. The report object is shown as a simple box outline.

8. Double-click inside the box outline to see the table and click the Refresh button. You may not see any data in the table. This is because the default time range for the table is the past 2 hours, but the sample data was collected over several days in May 2000. In the next section of the tutorial, we will learn to control the time range for the data that will be displayed in the table.

When you create a new chart or table that is based on a time selection-enabled report data source, the Time Selection toolbar shown below will automatically display at the top of the time-based report object. The Time Selection toolbar acts like a filter on the timestamp field that was designated for time selection when the report data source was created.

The default time selection filter is the past 2 hours. Use the Time Selection toolbar to define time ranges, start and end date/times, or time increments for your time-based report objects. The Time Selection toolbar provides the following buttons:

• The Refresh button re-executes the report object based upon the selections made in the Time Selection toolbar. When

Adjust the Time Range For a Time-based Report Object



you make a change to the settings on the Time Selection toolbar, you must click Refresh to view the change.

• The All Times button is used to specify no start and end times. This button enables you to show all data that has ever been collected. This is especially useful if you do not know the start and end date for which data has been collected.

• The Time Range button enables you to specify the start and end times to which the data will be restricted. Use this button if you want to report only on data between a specific beginning and ending time.

• The Time Span button restricts time to the past by a unit of time. This button is useful if you want to show all data from the past 24 hours, the past 7 days, or the past year. When you use this button with an auto-refresh chart and data that is currently being collected, the chart will continue to refresh with the current date/time as the end time.

• The Past Time from End Time button uses a unit of time before the specified end time. For example, this button is useful if you want to show all data from the week before August 2, 2005.

• The Future Time from Start Time button uses a unit of time after the specified start time. For example, this button is useful if you want to show all data from the week after August 2, 2005.

To change a date or time on the Time Selection toolbar, use the drop-down arrow to the right of the field or type a value directly in the field.

For our tutorial example, click the All Times button and then click the Refresh button. Your table should look similar to the following:



When you save your report, the settings that you specified on the Time Selection toolbar during report authoring will be saved with the chart. These become the defaults for runtime users and they are also used when you schedule the report object to be run at a later date. Scheduling report objects and reports is discussed in "Advanced Reporting Topics (page 189)".

NOTE Although the Time Selection toolbar settings are used when you schedule the report object, the scheduled output does not show the Time Selection toolbar. To show the start and end times that are being used in scheduled report objects, add start- and end-time dynamic text fields to your report object. See the Add Dynamic Text Fields To a Report Object topic in the online help for the instructions to perform this task.

At run time, the RSBizWare report objects on your report will attempt to connect to an Information Services Manager to access the production data necessary to draw the chart, bar graph, etc. The connectivity settings for each report object specify how they will connect to the Information Services Manager. When the report user attempts to view an RSBizWare report that contains multiple report objects with different connectivity settings, the report user may be required to login multiple times before he or she can see the report.

To avoid repetitive logins on a report, you can set your report objects to use Global Credentials. Global Credentials use a session logon to connect to a report object. With a session logon, the user is

Configure the Report Object To Use Global Credentials



prompted for user name and password once for each server that is encountered. After the user’s credentials (user, password) have been specified for a server, those credentials are available to any subsequent report object that is running on that client computer, is using the Use Global Credentials option, and is attempting to connect to the same server. The session logon that is established will remain active until the user specifically logs off, the credentials expire, or the client computer is rebooted.

In order for a report object to make use of a session logon, the report object must be configured to use Global Credentials. Let’s set the properties of the report object created in the preceding section to use Global Credentials.

1. Click the FactoryTalk Metrics Workcell History report object and select View > Properties from the main menu. The Report Object Properties dialog box will appear.

2. Click the Runtime Settings tab.



The Runtime Settings tab enables you to specify how the user will connect to the server that you selected when you inserted the report object. When you are configuring the server connection settings for a report object, you have the following options:

• Use Global Credentials

This is the default option. Select this option if you want to use a session logon to connect to this report object.

• Require user to login

Select this option if you want to require the user to provide his user name and password to access this report object. More than one report object on a report with this option selected will require the user to login multiple times.

NOTE Remember that any users who will be viewing the report must have access to the report data source, report object, and filter or they will not be able to see the report object.

• Use RSBizWare Server Connection

Select this option if you want to specify the RSBizWare Server Connection that this report object will use when the user views the report at run time. You will only be able to select from Server Connection objects that are configured to use the same RSBizWare server that you selected when you added this report object to the report.

NOTE This option is provided for backwards compatibility only. It is recommended that you use Global Credentials in place of RSBizWare Server Connection objects.

• Use the following User and Password

Select this option if you want to specify at design time the user name and password that the report object will use when the user attempts to view the report object at run time. The advantage of choosing this option is that the user will not have to login to view the data.



NOTES By selecting this option, you are granting the specified user’s application privileges to the runtime user for this report object. Because the Save Report Object Contents to File, Add Time-Series Comment, and Edit/Delete Time-Series Comment application privileges allow action on report objects, it is important to consider whether the specified user has these privileges and whether you want the runtime user to have these privileges. If you use this option across many report objects and the security policy for the user is very strict (that is, the password must be changed frequently), you will need to change the password setting separately for each report object. Consider using a less strict security policy (such as never requiring the password to be changed) for this user. For more information on security policy, consult the RSAssetSecurity documentation.

For this tutorial, make sure the Use Global Credentials option is selected.

3. Click OK to close the dialog box and save your changes.

We will be adding more report objects to this report. If you want the rest of the report objects on this report to use Global Credentials, you will need to specify this option for each report object when you insert the report object.

An important feature of the Configuration Console is the ability to create bar, pie, and line charts from data stored in a report data source. The purpose of this tutorial is to walk you through the steps that are necessary to create a chart with the New Chart Wizard. For this tutorial, you will use the FactoryTalk Metrics Workcell History report data source to create a chart showing the average running time per hour for work cells. This tutorial will also demonstrate how to create a prompt-at-runtime filter so that the end-user of the report can choose the work cells that will be charted. Your chart will look similar to the one shown below.

Create a New Chart



Take a look at the table report object that we inserted in "Add a Saved Report Object to Your Report (page 146)". This table shows a representation of the data we will be charting. You will be creating a chart with a bar for each work cell description; therefore, the Workcell Description field is the series. Notice that one column in our table (Workcell Description) contains all of the work cell descriptions and the data for the work cells is organized in rows. Each row contains the Running Seconds values and the Start Time for each work cell (our series). This will be important to remember when we are using the New Chart Wizard.

NOTE FactoryTalk Metrics exposes two main report data sources—Workcell History and Event History—from which report designers will be creating charts and tables. In order to create charts and tables effectively, it is important that you understand the type of data that these report data sources contain. Refer to "Workcell History, Event History, and Machine State Data (page 225)" for descriptions of these two report data sources.

Place your cursor where you want the chart to appear in the report and select Insert > Chart to display the authoring user name and

Step 1: Plan the Chart



server prompt. Click Yes to accept the default user name and server. The New Chart Wizard will appear. This wizard will lead you through the process of creating a new chart for your RSBizWare report.

The first step in the New Chart Wizard is to select the report data source containing the data that we want to chart. The Report Data Source list contains the report data sources for which you have the appropriate permissions. Select FactoryTalk Metrics Workcell History from the list and click Next to continue.

Next, we will need to specify the type of chart that we want to create. The vertical bar chart is the default. Click Next to accept the default and continue.

In the data configuration step, we need to describe the data to the Chart Wizard. Recall that the data table data is organized in rows for each work cell (series). This corresponds to the example table shown in the Chart Wizard for the Rows option.

If the series values (work cell descriptions) were in the column headers of the table and the Running Seconds values for each work cell were listed in the column for that work cell, this would be an

Step 2: Select the Data On Which To Report

Step 3: Choose a Chart Type

Step 4: Describe the Data



example of a table where the series is in columns. For this type of table, we would select the Columns option.

However, since we have determined that our data is in rows, make sure the Rows option is selected and click Next to continue.were in the column headers of the table and the Running Seconds values for each work cell were listed in the column for that work cell, this would be an example of a table where the series is in columns. For this type of table, we would select the Columns option.

However, since we have determined that our data is in rows, make sure the Rows option is selected and click Next to continue.

In this step, we must decide whether we want to chart all of the values from the table or if we want to apply aggregate functions to the values. Since we want to summarize a field in the chart (find the average running time for each hour of the day), accept the default Summary option and click Next to continue.

In the Chart Fields step, we will be selecting the fields from the report data source that will be shown in the chart. This dialog box

Step 5: Select Summary or Detail

Step 6: Select the Fields To Be Charted



would look different if we had selected the Columns option in the Data Configuration step of the wizard.

1. Since we want to have a bar for each work cell and we want the names of the work cells to appear in the legend, select Workcell Description from the LEGEND list.

2. Select the Running Seconds field from the VALUE list. This is the field that will provide the values for the height of the bars.

3. When you selected the Running Seconds field from the VALUE list, COUNT(Running Seconds) was added to the list at the bottom of the dialog box. To change the function that is applied to the field, select the COUNT(Running Seconds) field in the list, click the Function button, and select AVG from the shortcut menu.

This action changes the function from COUNT(Running Seconds) to AVG(Running Seconds). The AVG(Running Seconds) function will return the average running time value for each work cell.

4. Now we will add Start Time labels to the X-axis. This will allow us to group the average running time values for the work cells by hour. Select Start Time from the X-Axis list. Start Time is added to the list at the bottom of the dialog box.



5. To show the hour, you will need to apply the HOUR format to the field. Click the Start Time field in the list, click the Format button, and select HOUR from the shortcut menu.

6. Click Next to continue.

1. The Report Object Name dialog box will appear. You must provide a unique name for the report object. The name you enter here will appear at the top of your new chart and will also be the name for this chart when it is saved as a report object for future use.

2. For this tutorial, enter Running Time by Workcell in the Report Object Name box.


The Filter dialog box will display. Now we will create a filter that will specify which records will be charted. Since we only want to chart the values for certain work cells, we will need to filter out the work cells that we do not want to chart.

There are two types of filters that we can create: a static filter where we provide all of the filter values when we create the filter or a “prompt-at-runtime” filter that allows the user to select the filter values every time the filter is used. For this tutorial, we are going to create a prompt-at-runtime filter that allows the user to select the work cells that he or she wants to report on when the report is run.

NOTE Prompt-at-runtime filters cannot be used with report objects that will be scheduled.

Step 7: Enter the Chart Title

Step 8: Filter the Data



1. Click the New Filter button to display the Configure Filter dialog box.

2. Enter the name Workcell Description Filter in the Edit Filter Name box.

3. A filter is made up of one or more search criteria. For this filter, we will be creating a single criterion. Click the Add Criterion button to display the Search Criterion dialog box.

4. Select the Workcell Description field from the Field tree and select the = operator from the Operator list.

5. Select the Select from a list of existing values for this field check box. This creates a list of unique values from which the user can pick report values.

6. To make this a prompt-at-runtime filter, select the By prompting user when filter is run check box.

7. Select the Allow multiple selection from list check box. This will allow the user to select more than one work cell from the list of values that is created.

8. Select the Required (Must be supplied when filter is run) check box. Doing this will require the user to specify a filter value when the report object is run.



9. Click OK to return to the Configure Filter dialog box.

After you have completed these steps, the Configure Filter dialog box should look like the example below.

10. Click OK to return to the New Chart Wizard.



Now that we have selected the report data source, created our chart report object, and created a prompt-at-runtime filter, we are ready to insert the chart into the report.

1. Click Finish to add the chart to the report. The chart is shown as a simple box outline.

2. To ensure that the filter is properly associated with the report object, right-click the report object and select Properties from the shortcut menu.

3. On the Report Object Properties dialog box, select the Runtime Settings tab and select the Workcell Description Filter from the Default Filter list.

4. Click OK to return to the report object.

5. Double-click inside the box outline to see the chart click the All Times button on the Time Selection toolbar, and click the Refresh button. When you refresh a report object that contains a required prompt-at-runtime filter, the Runtime Report Criteria dialog box will display. This is the prompt that was created by the prompt-at-runtime filter. This dialog box allows the users of your report object to specify the values that will display in the report object.

NOTE If you did not select the Required check box in "Step 8 (page 159)", the preceding prompt would not appear.

6. For this tutorial, hold down the Ctrl key on your keyboard and click two of the work cells from the list.

7. Click OK to display the chart with the average running time for the two work cells that you selected.

Step 9: Insert Your New Chart Into the Report



Refer to "Customizing RSBizWare Charts and Tables (page 181)" for information on how to further customize your chart by changing the title or bar/line colors.

The Configuration Console gives you the ability to create a text report object (or table) on your report that displays the data from a report data source. The purpose of this tutorial is to walk through the steps that are necessary to create a table in your report. For this tutorial, we will use the FactoryTalk Metrics Workcell History report data source to create a table showing the average downtime for work cells by part number. Your table will look similar to the one shown below.

Place your cursor where you want the table to appear in the report and select Insert > Text Report from the main menu. The authoring user name and server prompt is displayed. Click Yes to accept the default user name and server. When the Report Wizard Welcome screen appears, click Next to begin.

Create a New Text Report Object

Step 1: Start the Text Report Object Wizard



The Report Data Source and Fields dialog box shown below is the first step to creating a table. In this dialog box, you will select the data that you want to include.

1. The Report Data Source list box contains the report data sources for which you have the appropriate permissions. Select PlantMetrics Workcell History from the list.

2. The Report Data Source Fields list contains the fields that are available for use in your table. Select the Workcell Description, Downtime Seconds, and Part fields, and click the right arrow button (>) to add the selected fields to the list on the right. Each field that you add to the list will be a column in your text report object.


Step 2: Select the Data On Which To Report



The Grouping Levels dialog box allows you to specify how your table will be grouped.

1. The fields that we added to the table are listed in the box on the left side of the dialog box. We can group by any of these fields. For this tutorial, let’s group the records by Part and Workcell Description. Select the Part and Workcell Description fields and click the right arrow button (>) to add fields to the Grouped fields list on the right side of the dialog box.

2. We want to force the report to group the records by Part first, so let’s make sure the Part field is at the top of the Grouped Fields list. If it is not, select Part and click the up arrow Priority button (^) until Part is at the top of the list.


The Sort Order dialog box allows you to specify the order in which the columns will be sorted and to calculate totals for columns. Since

Step 3: Group the Records

Step 4: Sort the Records



we chose to group by Part and Workcell Description, those columns automatically have a sort order applied to them.

1. To calculate the average downtime value, select the AVG check box in the Downtime Seconds row.

NOTE The weighted average (WAVG) function is an average that takes into account the proportional relevance of each component (typically over time), rather than treating each component equally. Weighted average can be used in any table of information where the values of a particular column should be given more or less importance based upon the values of another column. The weighted average function is ideal for calculating a time-weighted average OEE value for multiple activity areas. See the Weighted Average topic in online help for additional information.

2. For this table, we are not interested in showing the individual detail records that make up the average downtime; we want to see only the average downtime per work cell values. Select the Summary Only option at the bottom of the dialog box.




The Format Style dialog box allows you to control the appearance of the table.

1. The Report Style section of the dialog box lets you choose the color scheme that will be applied to the table or to create a custom style. For this tutorial, select the Access Northwind Invoice style from the Report Style list. A sample of the style is displayed in the Preview window to the right of the list.

2. The Styles by Field section of the dialog box allows you to set display formats for the individual fields. For this example, let’s specify the time formatting that is applied to the AVG(Downtime Seconds) field. Select the field from the list box and click the Customize Selected Field button to display the Customize Report Styles dialog box.

Step 5: Format the Table



3. Click the Convert tab.

4. Select the Convert from option and ensure that Seconds is

selected from the first list. This action will change the numeric value that represents the number of seconds into a time format.

5. Click OK to accept the values and return to the Report Wizard.




In the Report Object Name dialog box, you must provide a unique name for the report object.

1. For this tutorial, enter Demo Table.


When presented with the Filter dialog box, we can use the same filter that we created for our chart or we can create a new one. For this tutorial, let’s use the one we created before.

1. Select Workcell Description Filter from the Filter list.


Now that we have selected the report data source, created our table report object, and selected a filter, the Finish dialog box will display.

1. Click Finish to insert the report object.

2. To ensure that the filter is properly associated with the report object, right-click the report object and select Properties from the shortcut menu.

3. In the Report Object Properties dialog box, select the Runtime Settings tab and select Workcell Description Filter from the Default Filter list.

4. Click OK to return to the report object.

5. The table will display as a simple box in the report. Double-click inside the box outline to view the table.

6. Set the time selection option and refresh the table as you did in the chart tutorial.

Refer to "Customizing RSBizWare Charts and Tables (page 181)" for information on how to further customize your chart by changing the title or bar/line colors.

Step 6: Name the Report Object

Step 7: Filter the Data

Step 8: Insert Your New Table Into the Report



An important function of FactoryTalk Metrics is the ability to provide an OEE rating for each activity area that is being monitored. The OEE Box chart is a simple scorecard that will provide a rating based on the performance parameters that were configured for the activity area. This tutorial will help you understand how to use FactoryTalk Metrics to create an OEE Box chart. Your OEE Box chart will look similar to the following:

Create an OEE Box Chart



To view data described in this part of the tutorial, you must start the BizBikes project.

For more information, see the Rockwell Automation Knowledgebase (http://rockwellautomation.custhelp.com/), Answer no. 465006, BizBikes sample project for FactoryTalk Metrics.

Place the cursor where you want the chart to appear and select Insert > OEE Box from the main menu. When the authoring user name and server prompt is displayed, click Yes to accept the default user name, server, and port. A blank OEE Box chart will display on your report.

1. Click the OEE Box chart and select View > Properties from the main menu to display the RSBizWare OEE Box Control Properties dialog box. Use this dialog box to select the activity area for which you want to display an OEE rating.

Step 1: Start the BizBikes Project

Step 2: Insert Your New Chart Into the Report

Step 3: Select an Activity Area

http://rockwellautomation.custhelp.com/



2. Browse for and select the Bend activity area contained within the BizBikes, Inc enterprise. This is the activity area for which we will be displaying the OEE Box chart.

1. Click the Layout tab. This dialog box allows you to customize the OEE Box chart. You can specify the details that will appear on the report object, specify its layout, and set the auto-refresh rate. This dialog box also allows you to see a preview of the report object.

2. By default, the bar that shows the OEE value for the activity

area is displayed from left to right across the top of the OEE Box chart as shown above. For this tutorial, let’s change the chart to show the OEE bar from bottom to top along the left side of the OEE Box chart. Select the Draw OEE Bar Vertically option in the upper left-hand side of the dialog box.

Step 4: Specify the Layout of the Chart



3. Now, let’s adjust the historical details that will be shown on the OEE Box chart. There are several historical elements that are shown by default in the chart, including Good Part Count, Total Part Count, and Scrap Part Count. Let’s also show Mean Time Between Failures (MTBF) and Mean Time to Repair (MTTR). Select the check boxes to the left of Mean Time Between Failures and Mean Time to Repair in the Historical Data list to add them to the OEE Box chart.

Suppose we want to report on the OEE for all part numbers produced for all shifts over the last 30 minutes. To do this, we will need to create a custom filter that will restrict the data that is displayed in the OEE Box chart.

1. Select the Apply a Custom Filter check box and click the New button on the Layout tab to display the OEE Box Filter dialog box. We will use this dialog box to specify the shifts and parts that will be included in the OEE rating and the time range for which the OEE rating will be displayed.

Step 5: Create a Filter



2. Enter the name Past 30 Minutes in the Filter Name box at the top of the dialog box.

3. Clear the All Times check box and click the Time Span button. Change 10 to 30 in the The Past box and select minutes from the list.

4. To specify the shift that we want to filter on, select Shifts from the Filter On list in the Additional Filtering section of the dialog box. Keep the default to filter on All Shifts.

5. To specify the parts that we want to filter on, select Parts from the Filter On list in the Additional Filtering section of the dialog box. Keep the default to filter on All Parts.

NOTE If you have User-defined Summarization Criteria configured for the activity area you are reporting on, you can filter also on these criteria.

6. Click OK to save your filter and return to the RSBizWare OEE Box Control Properties dialog box.

Click the OEE Bar tab. This dialog box allows you to specify the bar colors in the OEE box report. The default bar colors are red (for OEE values 0 to 50), yellow (for OEE values 50 to 75), and green (for OEE values 75 to 100).

Step 6: Customize the OEE Bar Colors



For this tutorial, let’s combine the two lower ranges, so we have two ranges instead of three. Click the 50 to 75 range and click the Delete button. You will be prompted to confirm the deletion. Click Yes to remove the middle range from the list. Notice that the ranges are automatically adjusted to include the missing values.

1. Click OK to return to your report. The OEE Box chart will be displayed as a simple box in the report.

Step 7: Preview Your OEE Box Chart



2. In order to see the OEE Box chart properly, click the Preview Mode button to display the report in preview mode. The filter icon in the upper right corner of the box indicates that the filter you specified is being applied.

3. Click the Design Mode button to continue editing your

report.

FactoryTalk Metrics also enables you to display more detailed information about an activity area that is being monitored. The FactoryTalk Metrics Detail chart allows you to view the FactoryTalk Metrics Event, Counts, Scrap, OEE, and Schedule for the activity area. This is the same chart that is displayed in the Manual Data Collection dialog box that was discussed in "Manual Data Collection (page 101)". This tutorial will help you understand how

Create a FactoryTalk Metrics Detail Chart



to use FactoryTalk Metrics to create a FactoryTalk Metrics Detail chart.

1. Place the cursor where you want the chart to appear and, from the main menu, select Insert > FactoryTalk Metrics Detail to display the authoring user name and server prompt. Click Yes to accept the default user name, server, and port. A blank FactoryTalk Metrics Detail chart will display on your report.

2. Click the chart and select View > Properties from the main menu to display the FactoryTalk Metrics Detail Control Properties dialog box. This dialog box allows you to specify the activity area for which you want to display FactoryTalk Metrics details.



3. You can show the plant model tree in the FactoryTalk Metrics Detail report object to allow the runtime user to select the activity area when he views the report, or you can select the single activity area that will show in the FactoryTalk Metrics Detail report object. For this tutorial, we will select the activity area for which the user will view FactoryTalk Metrics Details. Clear the Show Plant Model Editor Tree check box at the top of the dialog box and use the Plant Model Unit tree to browse for and select the Bend activity area in the BizBikes, Inc enterprise.

4. Click OK to return to your report. The FactoryTalk Metrics Detail chart will be displayed as a simple box in the report.

5. Double-click inside the box outline, select the All Times button, and click the Refresh button to view the report object.

6. This is a time-based report object, so you will need to adjust the time range on the Time Selection toolbar. Click the All Times button and the Refresh button to display all FactoryTalk Metrics detail data that has been collected for the selected activity area.

When you saved your RSBizWare report to the Report Explorer, the report was saved on the Information Services Manager to which you

Export the Report To HTML



were connected. If you want to open and edit your report in an HTML editor such as Microsoft FrontPage or make the page part of a Web site, you will need to export the report to an HTML document on any networked computer.

1. Before you export the report, from the main menu, select File > Save Report to save your recent changes.

2. With the report still displayed in the work area, from the main menu, select File > Export To File to display the Save As dialog box.

3. Select the location on the network where the report will be saved. For this tutorial, let’s save the file to the desktop of the local machine. Select Desktop from the Save In box at the top of the dialog box.

4. Make sure HTML files (*.htm) is selected from the Save as type box at the bottom of the dialog box. Enter BizBikes Production.htm in the File name box.

5. Click Save to create the HTML file on your local disk and close the dialog box. At this point, your report is simply an HTML document with some text and a few RSBizWare ActiveX controls on it. You are now ready to open and edit the file and further customize it in FrontPage or another HTML editor.

You now have two copies of the report: one saved as an HTML file on the local disk and one stored in the Information Services Manager.

Let’s assume that we have opened our document from the previous example in Microsoft FrontPage, made some changes to the document using FrontPage’s formatting and Web authoring tools, and saved our modified HTML document. Now we want to make the modified document available to other users who will access it from the Report Explorer in the Configuration Console. To accomplish this, we simply need to load the document into the

Load Report From File



Configuration Console and save it to the Information Services Manager.

1. To load the document into the client, select File > Load from File from the main menu. The Open dialog box will display.

2. Browse to the desktop of your local machine. Select the BizBikes Production.htm file and click Open. The HTML document is opened in the Configuration Console work area, but has not yet been saved to the server.

3. Save the document—including the changes made in FrontPage—as an RSBizWare report on the Report Explorer by following the same steps we performed in "Save Your Report (page 143)".

Congratulations! You have completed the data analysis tutorials. Now you are ready to explore FactoryTalk Historian Classic on your own and create more complex reports using the sample data.


Chapter 7

Customizing RSBizWare Charts and Tables

This chapter will help report designers understand how to customize charts and tables that have been added to RSBizWare reports. It is assumed that you have an RSBizWare report containing chart and table report objects open in the Configuration Console and that you have a FactoryTalk Metrics Author license. Furthermore, it is assumed that you have Edit Report and Edit Report Object permissions for the report and the report objects that you are working with. The examples in this chapter use two of the report objects that we created in "Analyzing FactoryTalk Metrics Data (page 141)".

When you have a chart showing in your RSBizWare report, you can customize the appearance of your chart by changing the color of the chart “pens,” the size of the legend, the font that is used in the title, the color of the background, and much more.

Customizing Charts

Chapter 7 Customizing RSBizWare Charts and Tables


NOTE When you make modifications to a report object, all instances of the report object (such as those on other RSBizWare reports) will reflect the changes you have made.

Charts typically consist of three components: a title at the top, a chart in the middle, and a legend at the bottom. While this default layout may be fine for most charts, you may find that you want to change the layout of your chart. Perhaps the legend would fit better in another place on the chart, or the legend should be resized because it is too small to show all of the legend keys.

Before you can modify a chart component, it must be in edit mode. With your RSBizWare report in design mode, click the chart. The edit mode chart will have eight resizing handles and a highlighted border, indicating that it is ready to be modified. Now you can click the individual chart component to put it in edit mode.

When you finish working with a chart component, click outside the chart to remove the resizing handles and highlighted border.

To resize a component, make sure the resizing handles and highlighted border are visible. Hover your mouse pointer over one of the resizing handles. When the cursor changes to a two-sided arrow

, click and drag the handle until the component is the desired size. Release the mouse button to stop the resizing action.

To move the component, make sure the resizing handles and highlighted border are visible. Hover your mouse pointer anywhere inside the highlighted border. When your cursor changes to a four-sided arrow , click and drag the component to the new location. Release the mouse button to drop the component in that location.

To delete the component, make sure the resizing handles and highlighted border are visible. Right-click and select Delete from the shortcut menu or press the Delete key on your keyboard.

Working With the Component Parts of a Chart

Resize a Component

Move a Component

Delete a Component

Customizing RSBizWare Charts and Tables Chapter 7


To edit a chart title or a text field, make sure the resizing handles and highlighted border are visible. Right-click and select Edit Text from the shortcut menu to display the Set Text dialog box. Modify the text and click OK to close the dialog box and save your changes.

Examples of standard properties that you can change for chart components are border style and font style. In addition to the standard properties, each chart component type has some properties that relate only to that type of component. For example, the chart legend has properties that specify how the keys will be displayed within the legend. To access the property page for a chart component, make sure the resizing handles and highlighted border are visible. Right-click the chart component and select Chart Object Properties from the shortcut menu.

When you create a chart, the bars, pie slices, or lines of the chart are drawn with default “pens.” To make the chart easier to read or more appealing to your users, you can change the pen colors, styles, and sizes that are used. For example, you may want to change the thickness of the lines in your X-Y chart to make them easier to see.

To customize the pen colors and styles that are used on your chart, make sure the resizing handles and highlighted border are visible. Right-click the line, bar, or pie slice that you want to modify and select a pen command from the shortcut menu. The pen commands that are available will vary depending on what type of pen (line, bar, or pie slice) your chart uses. If your chart has an authoring legend, you can also use the chart property fields that have been added to the authoring legend to customize pen colors and styles.

When you have a text report object (or table) showing in your RSBizWare report, you can interactively show or hide columns, resize columns, rename columns, change the grouping and sorting, and apply aggregate functions to columns. These are shortcuts to features that normally are available on the properties dialog box for

Edit the Chart Title or Text Field

Change Chart Component Properties

Working With Chart “Pens”

Customizing Text Report Objects



the report object. These shortcuts have been created to allow you to change quickly the look and format of the table.

Before you can modify the table, you must have your RSBizWare report in design mode.

NOTE When you make modifications to a report object, all instances of the report object (such as those on other RSBizWare reports) will reflect the changes you have made.

Some report data sources may contain more columns than can be shown easily in the table. If you are creating a table for a report data source with many columns, you may want to show only the columns of information that the user will need. The Hide and Insert Column shortcuts allow you to change quickly which columns are included in the table.

To hide a column, right-click the column that you want to remove from the table. Select Hide Column from the shortcut menu that is

Show and Hide Columns



shown. Columns that are removed from the table can be re-added later.

To show a column that is not currently included in the table, right-click the table and select Insert Column > column name from the shortcut menu that is shown. The new column will be inserted to the right of the column that is selected.

When you add a column to a table, it is assigned a default width. Sometimes, the default width is too large, resulting in excess white space, or too small, forcing the values to wrap within the cells. The column-resizing feature allows you to reduce excess white space, to avoid word wrapping and to fit more columns into the work area.

Move your mouse pointer over the grid line to the right of the column that you want to resize. When your cursor turns into a bar with a left and right arrow on it ( ), click and drag the column to the size that you want.

Resize the column down until it disappears. When you release the mouse button, the column will reappear.

If you have selected the Interactive Grid style for your table, you can interactively add an Aggregate function column to the table, change the grouping of the table records, apply a format to the selected column, change sort order of the table, and rename the selected column heading.

If your table is not already using the Interactive Grid style, follow these directions to change your table.

1. Click the table and select View > Properties from the main menu to display the Report Object Properties dialog box.

2. Click the Advanced tab and click the Format button to display the Global Report Object Formats dialog box.

Resize Table Columns

To resize a column:

To remove a column by resizing it:

Aggregate, Group, Format, Sort, Chart, and Rename Columns



3. Click the Styles tab. Select Interactive Grid from the Style drop-down list.

4. Click OK to return to the Report Object Properties dialog box.

5. Click OK to return to the design mode report.

Your table will resemble the one shown below.

To apply the SUM aggregate function to a column, right-click the column header and select Aggregate > SUM from the shortcut menu. You will notice that the aggregate functions that are available on the menu vary from column to column. Only the functions that make sense for a particular column will be displayed. For example, it only makes sense to apply the SUM function to a numeric field.

To remove an aggregate function from a column, right-click the column header and select Aggregate > None from the shortcut menu.

To group by field, right-click the column header and select Grouping > Group 1 from the shortcut menu. This causes the table

Aggregate

Group



records to be grouped by the selected column. Every time you select Grouping from the shortcut menu for additional columns, you will notice that additional group numbers are added to the menu. This allows you to group by as many columns as you have shown in your table.

To remove a grouping, right-click the column header and select Grouping > None from the shortcut menu.

To apply a format to a column, right-click the column header and select Format>format style from the shortcut menu. You will notice that the format styles that are available on the menu vary from column to column. Only the formats that make sense for a particular column will be displayed. For example, it only makes sense to apply a “month, day, year” format to a date field.

To remove a format from a column, right-click the column header and select Format > <None> from the shortcut menu. The column data will use the default format for the type of data displayed in the column.

To apply an ascending (A to Z) sort to a column, right-click the column header and select Sorting > Sort 1 > Ascending from the shortcut menu. This causes the table records to be sorted by the selected column. Every time you select Sorting from the shortcut menu for additional columns, you will notice that additional sort numbers are added to the menu. This allows you to sort by as many columns as you have shown in your table.

To remove a sort, right-click the column header and select Sorting > None from the shortcut menu.

NOTE You can also sort the data by clicking the column header; however, this will not be saved when you save your table.

Format

Sort



To change the axis on which the chart is graphed, right-click the column header and select Chart > X-axis from the shortcut menu.

To clear the chart axis, right-click the column header and select Chart > None from the shortcut menu.

To rename a column, right-click the column header and select Rename from the shortcut menu. The name in the column header is highlighted to indicate that it is ready to be changed. Enter the new name for the column and press the Enter key on your keyboard.

If you have selected the Interactive Grid style for your table, each column in the table has a built-in quick filter below the column heading. The default quick filter for each column is (All). Click the default quick filter to display a list containing all unique column values. Select the value by which you want to filter, and the table will be trimmed using that column value as the criterion. By doing this to one or more columns, you can create a quick filter with one or more table columns interactively.

Chart

Rename

Quick Filter


Chapter 8

Advanced Reporting Topics

The Excel Add-in allows you to retrieve RSBizWare data—general reporting (or grid) data and time-series data—directly into Microsoft Excel. After the RSBizWare data has been imported into Excel, you can use any of Excel’s analysis, charting, or scripting features to further process the data.

When you install the RSBizWare software on a computer, a custom RSBizWare toolbar is added to Microsoft Excel that allows you to perform the tasks necessary to retrieve RSBizWare data.

1. First, you will need to specify the connectivity settings that the Excel workbook will use to communicate with the Information Services Manager.

Click the Connectivity button to display the RSBizWare Connectivity Settings dialog box.

2. Enter the name of the Information Services Manager to which

you want your Excel workbook to connect.

3. All conversations between Excel and the Information Services Manager use HTTP. Enter the port number that you want to

The Excel Add-in

Chapter 8 Advanced Reporting Topics


use for RSBizWare HTTP communications. The default port is 8080.

NOTE Please contact your RSBizWare administrator for the specific port number that you should use.


After you make a valid connection to an RSBizWare server, the RSBizWareSetup worksheet is created by the Excel Add-in. The RSBizWareSetup worksheet contains the information required to retrieve data for the reports you create in your Excel workbook.

5. Now you are ready to add and modify reports in your Excel workbook. Each Excel workbook can contain up to 255 RSBizWare reports.

To create a new grid data report in your Excel workbook, select Grid Data from the Report Type drop-down list and click the New Report Parameters button

. The Grid Data Parameters dialog box is displayed. Use this dialog box to specify the parameters that will be used to create a grid data report.

Advanced Reporting Topics Chapter 8


To create a new time-series report in your Excel workbook, select Time-Series from the Report Type drop-down list and click the New Report Parameters button

. The Time Series Parameters dialog box is displayed. Use this dialog box to specify the parameters that will be used to create a time-series report.



To modify the parameters of a grid or time-series report, click the RSBizWareSetup column that defines the report and

click the Edit Report Parameters button .

NOTE To delete a report from the workbook, click the RSBizWareSetup column that defines the report you want to delete. Click the Edit Report Parameters button to display the associated report parameters dialog box. Click the Delete button at the bottom of the dialog box. When prompted to confirm the deletion of the selected sheet, click OK to remove the report sheet.



6. Click the Refresh Reports button on the Excel Add-in toolbar. The Report Name List dialog box is displayed. Use this dialog box to select the reports for which you want the data refreshed from the server.

7. Select the reports that you want to refresh or click the Refresh

All Reports check box. Click Update to refresh the selected reports and close the dialog box.

Now you can save the workbook and use any of Excel’s analysis, charting, or scripting features to further process the RSBizWare data displayed on the worksheets.

The Configuration Console allows you to schedule tasks to be run at some time in the future. The scheduling feature allows the valuable information in the Configuration Console to be used by the entire company without the cost of a runtime user license. Any report or individual report object in the system can be scheduled as a task. The results of the task can be saved to a file, sent to an e-mail address, or printed. With this capability, you could schedule the Schedule Manager to e-mail report objects to production supervisors every morning or update your production statistics in an HTML

Scheduling Report Objects and Reports



document that is referenced by your Web server. To view a list of tasks that have been scheduled on the Schedule Manager to which you are connected, from the main menu of the Configuration Console, select Configure > Scheduled Report Objects. The Scheduled Report Objects dialog box will be displayed.

1. To schedule an individual report object to be run at a later time, click Add. The Report Object Selection step of the RSBizWare Schedule Wizard dialog box will display. Use this dialog box to specify the report object that will be scheduled.

Schedule a Report Object



2. Select a report data source, a report object, and a filter

(optional) from the lists provided. A preview of the report object will be displayed in the preview window.

3. Click Next to display the Description and Frequency dialog box. This dialog box allows you to name the scheduled item and to specify how frequently the scheduled item will be performed.



4. Enter a description of the task that is to be performed. For this example, enter Workcell Production Scheduled Task.

5. Select a Frequency option to specify whether the task will be performed once or whether it will be performed on a recurring basis. If the task is to be performed on a recurring basis, you must choose the interval that will be used. For this example, let’s schedule our task to run only one time. Select the One Time option.

6. Click Next to display the Single Execution dialog box, which defaults to midnight tonight.

7. Because we chose the One Time option, we must specify the

exact date and time that the task will be performed. Select today’s date from the Date box and set the time for an hour from now.



8. Click Next to display the Delivery Method dialog box. This dialog box allows you to specify how and where the task results will be distributed.

9. Select one or more of the following distribution methods:

• E-mail. Select this option to have the results e-mailed to the electronic address that you specify. Enter the e-mail address to which you want the task results delivered. The results will be sent as an attachment to the e-mail. You must also specify the file format to which you want your task results saved. Available file formats will depend on the type of report object that is being scheduled.

• Printer. Select this option to have the results sent to a printer. Select a printer from the list of printers that have been configured on the computer where the Security Services Manager is running.

• File. Select this option to have the results saved to a file on the computer where the Security Services Manager is running. Use the Browse button (...) to set the path and file name to which you want the task results written. If you scheduled the task to run more than once, the file will be overwritten each time the task is run.



Click Finish to exit the wizard. If the scheduling is successful, a message will display to indicate when the next occurrence of the scheduled item will take place, and you are returned to the Scheduled Report Objects dialog box.

NOTE If the Report Schedule Manager that performs scheduled tasks is running on the machine where you are running this Configuration Console, you must close the Configuration Console for the scheduled task to be performed. If the Report Schedule Manager and the Configuration Console are on the same machine and you do not close the Configuration Console, the Report Schedule Manager will take over the Configuration Console, causing disruption of your current Configuration Console activities and failure of the scheduled task.

Click Close to exit the Scheduled Report Objects dialog box.

1. To schedule a report from the Report Explorer to be run at a later time, locate the report in the Report Explorer tree. Right-click the report and select Schedule from the shortcut menu. The Description and Frequency step of the Schedule Wizard will be displayed.

2. Follow Steps 4 - 10 above to schedule your report.

Each time the Information Services Manager attempts to perform a scheduled task, a history record that documents the success or failure of the attempt is written to the database. If your task results are not being distributed to the specified destination, you can view the schedule history to troubleshoot the problem.

To view the history for a scheduled task, open the Scheduled Report Objects dialog box, highlight the task in the list, and click the View History button. The Document Schedule History dialog box will be displayed. This dialog box contains a read-only table that displays the history for a scheduled task. Each record in the table represents an instance when FactoryTalk Metrics has attempted to

Schedule a Report

View the History of the Scheduled Task



perform the task. The table displays the following attributes for each attempt to execute the scheduled task:

• Report Title. For scheduled reports only. The tree label that was applied to the RSBizWare report when it was saved on the Report Explorer tree.

• Filter. For scheduled report objects only. The name of the filter that was applied to the RSBizWare report object when it was scheduled.

• Schedule Description. The name that the user gave to the task when it was scheduled.

• Log Message. A message from FactoryTalk Metrics that indicates the disposition of the task (e.g., Scheduled Item Created, Scheduled Item Dispatched, Scheduled Item Failed).

• Run Results. An additional description of the task results. For example, if your task failed, the run results may contain the reason that the task failed.

• Log Date. The date and time that the application attempted to perform the scheduled task.

The reporting features of the Configuration Console can be applied to tables or views that exist in non-RSBizWare databases. This is useful if you have data from other software packages or legacy systems that you want to analyze within the Configuration Console.

To analyze non-RSBizWare data within the Configuration Console, you will need to create an external data source that describes the external database to the Information Services Manager and a report data source that describes the table or view within the external database to the Configuration Console.

An external data source is an ODBC connection to a SQL Server or Oracle database. The external data source provides a link between the non-RSBizWare database and the Information Services

Analyzing Non-RSBizWare Data

Create an External Data Source



Manager. External data sources are configured through the Service Console. For information on how to create a new external data source, refer to the “Administering RSBizWare Servers” chapter of the Administration Guide.

A report data source is a connection to a table or view within an external data source. The report data source describes the table or view to the Configuration Console. After your report data source has been created, you can design reports to analyze the data. Refer to "Analyzing FactoryTalk Metrics Data (page 141)" for instructions on creating reports.

Before you walk through this tutorial, it is assumed that you have been granted a FactoryTalk Metrics Author license and the Create New Report Data Sources privilege by your RSBizWare administrator.

1. From the Configuration Console main menu, select Configure > Reporting > Report Data Sources, Objects, and Filters to display the Configure Report Data Sources, Report Objects, and Filters dialog box. This dialog box allows you to manage report data sources and the report objects and filters that are associated with the report data sources.

Create a Report Data Source

Step 1: Start the Report Data Source Wizard



2. Click the Add button in the Report Data Sources group box

to display the Report Data Source Configuration wizard. This wizard will lead you through the steps necessary to create your new report data source.

3. The first page of the wizard is the Welcome screen. Click Next to continue.

The Report Data Source Name page (shown below) displays the first step necessary to create a report data source—naming the report data source and assigning permissions.

Step 2: Give the Report Data Source a Name



1. Enter the name that you will use to refer to your report data source throughout the application. This name must be unique among all report data sources.

2. If you want to define how other users will be able to view or use your report data source, click the Permissions button to set custom permissions. For this example, we will accept the default permissions that are automatically associated with new report data sources.


NOTE For additional information about default permissions, see the “Administering RSBizWare Servers” chapter of the Administration Guide.

The Choose a Database Table or View page (shown below) allows you to specify the database table or view to which the report data source is providing a connection.

Step 3: Select a Database Table or View



1. Select the name of the external data source that contains the table or view. In the example above, the Coffee Datalog Data external data source was selected.

2. When you select an external data source, the list at the bottom of the dialog box fills with the tables and views that exist in the database. Select the table or view to which you want to create a connection.


In this step, you will be selecting from the Column Selection page the table/view columns that you want to include in the report data source. Only the columns that you include in the report data source will be available for users to include in report objects that reference this report data source.

Step 4: Choose the Columns That Will Be Included



1. Highlight the column names that you want to make available to the user and click the Add (>) button to move the column names to the Columns in Report Data Source list.

2. Columns that have been added to the Columns in Report Data Source list can be renamed so the names are more meaningful to users. To rename a column, select the column name in the list and click the Rename button. The name is highlighted to indicate that it is ready to be changed. Type the new name for the column and press the Enter key on your keyboard to accept the changes.



3. Now, let’s add a derived field to the report data source. A derived field is a calculated value that is obtained from an expression that you provide. For example, if your table has fields A, B, and C, you could create a derived field called D that contains the value calculated from the expression ((A-B)/C * 100). To add a derived field to your report data source, click the Derived Field button and select Add Derived Field from the shortcut menu to display the dialog box shown below.

4. Enter a name for your new field and type the expression or

SQL statement that will be evaluated to produce the derived field.

5. Click the Validate button to check for errors.

6. Click Add to return to the Report Data Source wizard. Your derived field will be displayed in the Columns in Report Data Source list.


This step of the wizard allows you to pick the field from the Time Selection Toolbar page that will be used to restrict the data in the report object by date and time.

Step 5: Enable the Time Selection Toolbar



1. The drop-down list contains all timestamp fields that you selected to include in the report data source. To enable the Time Selection toolbar for your report data source, select the timestamp field on which the Time Selection query will be run.


The Time-series Format page allows you to specify whether the table is going to be used for time-series analysis (as shown below). If the table is going to be used for time-series analysis, you must specify what format the table is in.

Step 6: Specify the Format of the Table or View



1. Select the option that best describes your database table or view.

• Select the Table is not in a time-series format option if the table does not contain time-series data. This will disable time-series analysis and FactoryTalk Transaction Manager time-series data collection for the report data source.

• Select the Narrow Format option if the reporting tag values are stored in a single column of the table.

• Select the Wide Format option if the table has a separate column for each reporting tag.

• Select the Compression option if your table contains compressed time-series data that has been collected using the FactoryTalk Transaction Manager Compression engine.

For this example we have selected the Narrow Format.




NOTE If you selected the “not a time-series” option, the wizard will skip steps 7 and 8. The Review Results page will display a summary of the new report data source that will be created. Review your selections and click Finish to create the report data source.

This step displays the Match Time-series Columns page. In this step, you will need to specify the role that each database field plays in time-series analysis. If you selected the “narrow” option in the previous step, you will be required to specify the field that contains the reporting tag ID, the field that contains the timestamp, and the field that contains the value. If you selected the “wide” option in the previous step, you will be required to specify one or more fields that contain the reporting tag values and the field that contains the time stamp.

1. To specify a role for a field, click the Time-series Use cell and select a role from the list that will be displayed.

Step 7: Specify the Role That Each Field Plays In Time-Series Analysis




The final step of the wizard contains the Data Point Configuration Table page shown below. Here you set up the data point configuration table, which is a database table that contains descriptive information about the reporting tags, including a reporting tag ID field, a reporting tag description field, and an engineering unit field. The data point configuration table will be joined to the report data source table by the reporting tag ID field. Each time-series report data source must use a different configuration table.

1. Select a table from the drop-down list or click the Create Configuration Table button to create a new table. The table fields will be listed in the grid at the bottom of the dialog box.

2. For each field in the configuration table, click the Timeseries Use cell and select a role from the list that will be displayed. This step is not necessary if you used the Create Configuration Table button to create a new table.

Step 8: Create a Data Point Configuration Table



3. Click Next to display the Review Results page. This dialog box displays a summary of the new report data source that will be created. Review your selections and click Finish to create the report data source.

NOTE If the underlying database table or view changes after you create your report data source, you must recreate the report data source to take advantage of the changes.

As its name implies, a user-derived field is a field that is derived by using the values of other fields. This section describes the type of data that can be used to create derived fields. It also contains several examples of creating derived fields.

You can create two types of derived fields: detailed and summary.

• Detailed derived fields contain values that are derived from one or more detail fields within a single record. For example, in "Create Detailed Derived Fields (page 211)", the RunMinutes field is derived by dividing the dRunSec field by 60 seconds.

• Summary derived fields contain values that are derived from more than one record from one or more detail fields. Summary values are typically obtained either by grouping multiple records or by applying a summarization function (like SUM or AVG) to the records being summarized. For example, in "Create Summary Derived Fields (page 215)", the PartsPerMinuteTotal field is derived by summing the dTotalParts field and the dRunSec field, dividing the former by the latter, and then multiplying the result by 60 seconds.

The sections that follow describe how to create these two types of derived fields.

After you create a user-derived field, you can include it in a report. Detailed text reports cannot contain summary derived fields, though

User-derived Fields



both summary and detailed text reports may contain detailed derived fields.

Detail derived fields can be treated like any actual field, when creating a report. The rule for summary reports is that every column in the report must be either a grouped column or have a column function applied to it. A grouped column is used to determine which records are grouped together to be summarized, and each of the columns that are not grouped must have a way (a function) to take multiple values (from multiple records) and calculate a single value to display on the report.

Because derived fields are derived from other data in the database, it is useful to know what other data is available for use in building derived fields. For more information on the most widely used database tables, see "Workcell History, Event History, and Machine State Data (page 225)".

NOTE While you can add a user-derived field to an existing report data source, it is recommended that you create a new report data source when creating user-derived fields. For more information on creating a report data source, see "Create a Report Data Source (page 200)".

Begin the creation of one or more detailed derived fields by creating a new report data source:

1. Select Configure > Reporting > Report Data Sources, Objects, and Filters from the Configuration Console menu.

2. Click Add in the Report Data Sources area of the dialog box.

3. On the Welcome dialog box of the wizard, click Next.

4. Type Workcell Derived Fields Example in the Report Data Source Name box. Click Next.

Create Detailed Derived Fields



5. Select the (Local Server Database) from the databases list. Clear the Show Tables check box so you will just see database views. Scroll down and select the OEEQWorkcell view. This is the same database view that the standard FactoryTalk Metrics Workcell History report data source uses, and the new report data source will be based on the same view. Click Next.

6. Select the following fields and move them to the Columns in Report Data Source list: sDescription, tStart, sPartId, dTotalParts and dIdealCycleTime. Notice this is just a few of the many columns that could be included in the report data source.

7. Click Derived Field and select Add Derived Field from the

shortcut menu. You will create the following three derived fields:

• ActualCycleTime. Like IdealCycleTime, the units will be the number of seconds to make one part. The formula is dRunSec/dTotalParts. So actual cycle time will only be measured when the work cell is running, and both good and scrap parts will be counted. This number will be compared to ideal cycle time.



• PartsPerMinute. This field is just another way to represent Actual Cycle Time, but in units that are more familiar. The formula is (dTotalParts/dRunSec)x60.

• RunMinutes. The OEEQWorkcell view contains Running Seconds, but converting this to minutes may make it easier to digest. The formula is dRunSec/60.

In creating a derived field, you can use any legal SQL statement structure that will return a single value. A useful construct to use where there is the possibility of a divide-by-zero error (as there is in two of the derived field formulas) is to use a CASE statement.

8. Create the RunMinutes field first. Enter RunMinutes into the Field Name box. Select dRunSec from the Columns list and click Add Column to Expression.

9. Edit the SQL expression so that it reads: BizBikesUser.OEEQWorkcell.dRunSec/60. The prefix to the dRunSec field name fully identifies the field to SQL Server. Click Validate to check for errors, and Add to create the derived field.

10. Create the ActualCycleTime derived field and use a CASE

statement to exclude records where dTotalParts are zero. The SQL Expression is shown in the text box below. (Note that at any place in the expression where you need to add a column from OEEQWorkCell, you can double-click the column name



or select it and click the Add Column to Expression button.) Click Validate and Add.

11. Create the PartsPerMinute derived field and use a CASE

statement to avoid dividing by zero. The SQL Expression is shown in the text box below. Click Validate and Add. The three derived fields have been added to the report data source. Note that you can permanently rename columns by clicking the Rename button. For example, changing sDescription to Workcell or Machine Name might make it clearer. You will be renaming some columns (temporarily) when you create reports. Click Next.

12. Select the tStart field as the field to be used by the Time

Selection toolbar when filtering by time. Click Next.

13. Accept the default Table is not in a time-series format option. Click Next.



14. Click Finish to finish the wizard and create the report data source. Click Close to close the Configure Report Data Sources, Report Objects, and Filters dialog box.

The following shows an example text report containing the derived fields created in the preceding instructions.

In this section, you will create some derived fields that are suitable for displaying accurate summarized data, specifically summarized Cycle Time and PPM. Begin by editing the Workcell Derived Fields Example report data source as follows:

1. Select Configure > Reporting > Report Data Sources, Objects, and Filters from the menu. Then, select the Workcell Derived Fields Example and click Edit.

2. Click Next until you get to the Column Section dialog box. Click Derived Field, and select Add derived field from the shortcut menu.

3. Create a derived field called ActualCycleTimeTotals using the SQL expression shown below. This expression is the same

Create Summary Derived Fields



one used with the ActualCycleTime derived field, but every column name has a SUM function applied to it. Click Validate and Add.

4. Create another derived field called PartsPerMinuteTotal

using the SQL expression shown below. This expression is same one used with the PartsPerMinute derived field, but every column name has a SUM function applied to it. Click Validate and Add.

5. Click Next until you reach the final dialog box in the wizard,

and click Finish. On the Configure Report Data Sources, Report Objects, and Filters dialog box, click Close.

The following shows an example text report containing the derived fields created in the preceding instructions.






Chapter 9

FactoryTalk Metrics Icon Definitions

Tree views on the Manage Performance Parameters and Configure Performance Parameters dialog boxes show the state of plant model elements. The first table below lists the plant model element icons. The second table below lists the state icons that are applied to the plant model element icons to define their states.

Icon Plant Model Element

Enterprise

Site

Area

Line

Workcell

Custom Activity Area

Equipment Resource (configured only by the FactoryTalk Scheduler Client)

Labor Resource (configured only by the FactoryTalk Scheduler Client)

Standard Resource (configured only by the FactoryTalk Scheduler Client)

Icon State Definition

The plant model element has performance parameters configured but is not enabled. The status of the plant model element is “Configured.”

The plant model element has performance parameters configured and is enabled, but is not collecting data. The status of the plant model element is “Configured.”

The plant model element has performance parameters configured and is waiting to receive initial data values. The status of the plant model element is “Starting.”

The plant model element has performance parameters configured and is waiting to receive initial data values. The status of the plant model element is “Starting.”

Plant Model Element State Icons

Chapter 9 FactoryTalk Metrics Icon Definitions


The Categories & Events tree view on the Configure Performance Parameters dialog box shows the state of performance parameter events and categories. The first table below lists the performance parameter event icons. The second table below lists the state icons that are applied to the performance parameter event icons to define their states.

Icon Event or Category

System-generated event

System-generated event category

User-defined event

User-defined event category

Icon State Definition

An event that is enabled or an event category that contains enabled events. These events are not collecting data.

An event that is waiting to receive initial data values or an event category that contains events that are waiting to receive initial data values.

An event that is collecting data or an event category that contains events that are collecting data.

Performance Parameter Event State Icons


Chapter 10

Object Permissions

An object permission is a privilege that is granted to security groups or individual users that allows access to a specific object within the client application. An example of an object permission for which users and groups can be given privileges is the ability to edit a particular report object. For example, if JLSmith is granted “Edit Report Object” permission for the report object called “Test Report Object,” then he will be able to make and save changes to that report object. Individual users can have object permissions granted to them, and they can inherit object permissions from the security groups to which they belong. For example, if a group has been granted “Edit Report Object” permission for “Test Report Object,” users assigned to that group are able to edit the report object also.

Object permissions are granted through the Configuration Console user interface. For information on how to grant object permissions to objects, see the Configure Permissions For an Object topic in the Configuration Console online help.

You may also set the baseline permissions that will be given to a certain group or user for every instance of an object type that is created in the Configuration Console. For example, if you want the user “JLSmith” to have permission to edit every report object that is ever created in the client application, you need to set the “Edit Report Object” default security for JLSmith for the “Report Object” object. After you have assigned default permissions to a type of object, the creator of a new object of that type may choose to revoke an individual user’s permissions to his newly created object.

NOTE Revoking permissions is performed in the Configuration Console.

Chapter 10 Object Permissions


Default object permissions are granted through the Service Console. For information on how to grant default object permissions, see the “Configuring Information Services Manager default permissions” section of the “Administering RSBizWare Servers” chapter in the Administration Guide.

View Report. Allows the selected users or groups to view the report. For the user or group to be able to view the report, you must make sure that the permissions for the report data sources, report objects, and filters (optional) used on this report are also set for the selected user or group.

Edit Report. (Author Licenses only) Allows the selected users or groups to make changes to the report.

Delete Report. (Author Licenses only) Allows the selected users or groups to delete the report.

Edit (Report) Security. (Author Licenses only) Allows the selected users or groups to grant security permissions for the report to other users or groups.

View Report Object. Allows the selected users or groups to view the report object. The report object will be available for use by the selected users or groups.

Edit Report Object. (Author licenses only) Allows the selected users or groups to make changes to the report object.

Delete Report Object. (Author licenses only) Allows the selected users or groups to delete the report object.

Edit (Report Object) Security. (Author licenses only) Allows the selected users or groups to grant security permissions for the report object to other users or groups.

Report Permissions

Report Object Permissions

Object Permissions Chapter 10


View Filter. Allows the selected users or groups to view the filter. The filter will be available for use by the selected users or groups.

Edit Filter. (Author Licenses only) Allows the selected users or groups to make changes to the filter.

Delete Filter. (Author Licenses only) Allows the selected users or groups to delete the filter.

Edit (Filter) Security. (Author Licenses only) Allows the selected users or groups to grant security permissions for the filter to other users or groups.

View Report Data Source. Allows the selected users or groups to view the report data source.

Edit Report Data Source. (Author Licenses only) Allows the selected users or groups to make changes to the report data source.

Delete Report Data Source. (Author Licenses only) Allows the selected users or groups to delete the report data source.

Edit (Report Data Source) Security. (Author Licenses only) Allows the selected users or groups to grant security permissions for the report data source to other users or groups.

Filter Permissions

Report Data Source Permissions

Chapter 10 Object Permissions



Appendix A

Workcell History, Event History, and Machine State Data

FactoryTalk Metrics exposes several important report data sources—Workcell History, Event History, and Machine State Data—from which report designers will be creating charts and tables. In order to create charts and tables effectively, it is important that you understand the types of data that these report data sources contain.

The FactoryTalk Metrics Workcell History report data source is based on the OEEQWorkcell view in the RSBizWare database. This report data source contains the historical performance data for activity areas, including OEE performance and the data that is used to calculate OEE performance. Each record contains summarized information for a single enabled activity area for a period of time. Each record includes:

• The start and end times for the record.

• The number of parts built (good parts, scrap parts, and total parts).

• The amount of time the activity area was available, scheduled available, and running.

• The part number being built and the ideal cycle time for that part number.

• The number of parts that could have been built under ideal conditions.

• Shift information.

• The OEE calculation for that period of time.

The FactoryTalk Metrics Workcell History Report Data Source

Appendix A Workcell History, Event History, and Machine State Data


• The value for each configured user-defined summarization criterion.

Records will be created as long as FactoryTalk Metrics is collecting data—24 hours per day, 7 days a week, whether the monitored equipment is running or not. The Performance Data Trending Rate selected for an activity area specifies the duration of the Workcell History record, so there will be a Workcell History record in the database for the activity area for the specified interval. The current record is updated in place every 10 seconds with new performance information. When the Performance Data Trending Rate interval has passed, the current record is closed and a new record is created. The current Workcell History record will also be closed and a new one created if any of the following occurs:

• There is a scheduled shift change or there is a change in the Scheduled Availability status for the activity area.

• The part number that the activity area is building changes.

• A configured user-defined summarization criterion value changes.

• The ideal cycle time changes.

• Data collection stops (a new record is not created).

Since there is one record in the database for each activity area for each Performance Data Trending Rate interval, it is not possible to report on periods of time less than the specified rate. For example, if the Performance Data Trending Rate for the activity area is set to 10 minutes and you try to report on Workcell History data between 12:00 and 12:05, you will get data between 12:00 and 12:10.

The Event History report data source is based on the OEEQEvent view in the RSBizWare database. This report data source contains the historical data of individual events that have occurred at the activity areas that are being monitored by FactoryTalk Metrics. An Event History record is created when an event occurs and is closed

The FactoryTalk Metrics Event History Report Data Source

Workcell History, Event History, and Machine State Data Appendix A


when that event ends. FactoryTalk Metrics uses Event History records to compute the performance information that is stored in the FactoryTalk Metrics Workcell History report data source. Each record may include:

• Activity area information.


• The part number being built.

• Start and end times for the record, along with duration of the record.

• Event description and event folder information.

• Start and/or end values of event values collected along with the event. (This may include the difference between start and end values. If the event value has a lookup list, the appropriate text from the list will be stored in the record.).

• Whether the event is user-defined or system-defined.

• A fault indicator, which indicates the first event record. This is useful if multiple records are created for a single event.

• Severity level.


All Event History records are subject to event data summarization, which is a set of rules that can divide a single event into multiple Event History records. Event data summarization preserves the ability to generate Event reports by shift or by part number. System-generated events are summarized (the current Event History record is closed and a new record is created in the database) based on the event data summarization type that is specified.

Unlike Workcell History records, Event History records are not created on a regular, predictable basis and can span any amount of time. An Event History record is created when an event occurs and

Appendix A Workcell History, Event History, and Machine State Data


is closed when that event ends, which in some cases may be hours later. Even though the time span of an Event History record can be quite long, its contents are updated every 10 seconds. Because Event records can have very different time spans, reporting on Event records can bring some unexpected results. Remember that reports always include entire records, and cannot be run on portions of records. You can mitigate this effect by ensuring that user-defined events have similar data summarization types. See the Configuration Console online help for detailed information on events and event data summarization types.

NOTE FactoryTalk Metrics allows the user to disable event data summarization for a user-defined event, but this feature should be used with caution because it could result in the creation of event records that are difficult to report on.

The FactoryTalk Metrics Machine State Data report data source is based on the OEEQStateData view in the RSBizWare database. This report data source contains historical machine state data. Each record contains summarized information for a single occurrence of a machine state for a configured work cell. Each record includes:

• Activity area information.

• Machine state ID and description.

• Start and end times for the record, along with duration of the record.


• The part number being built and the ideal cycle time for that part number.

• The number of parts built (good parts, scrap parts, and total parts).

The FactoryTalk Metrics Machine State Data Report Data Source

Workcell History, Event History, and Machine State Data Appendix A




Index

A Add a Saved Report Object To Your Report 146 Adding FactoryTalk Users 116 Adding the FactoryTalk Metrics UDT 126 Adjust the Time Range For a Time-based Report Object 149 Advanced Reporting Topics 189 Aggregate 186 Aggregate, Group, Format, Sort, Chart, and Rename Columns 185 Analyzing FactoryTalk Metrics Data 141 Analyzing Non-RSBizWare Data 199 Assigning User Privileges, Licensing and Activation 122 Automated Configuration 105

B BizBikes Business Problems 18

C Change Chart Component Properties 183 Chart 188 Collecting Part Count Data When the Metrics Server Manager Is Stopped 27 Collecting Performance Data 27 Configure a Formula 55 Configure an Activity Area Schedule 34 Configure and Use Machine States 70 Configure FactoryTalk Metrics To Perform Downtime Tracking 92 Configure OEE Performance Parameters For an Activity Area 45 Configure the Plant Model 31 Configure the Report Object To Use Global Credentials 151 Configuring FactoryTalk Directory 116 Configuring FactoryTalk Metrics

New vs. Update 116 Configuring FactoryTalk Transaction Manager 129 Configuring Reports 139 Configuring RSLinx Enterprise as the OPC Server 117 Configuring Servers 120 Configuring the FactoryTalk Metrics 135 Configuring the Service Console 120 Connecting to the Information Services Manager 22 Contact Us 16 Create a FactoryTalk Metrics Detail Chart 176 Create a New Chart 154 Create a New RSBizWare Report 141 Create a New Text Report Object 163 Create a Report Data Source 200 Create an External Data Source 199 Create an OEE Box Chart 170 Create Detailed Derived Fields 211 Create Summary Derived Fields 215 Creating and Importing the FactoryTalk Transaction Manager Configuration 130 Creating the Plant Model 125 Custom Events - Analog 111 Custom Events - Digital 110 Custom Events - Monitored Value 109 Customizing Charts 181 Customizing RSBizWare Charts and Tables 181 Customizing Text Report Objects 183

D Delete a Component 182 Documentation Feedback 235 Downtime Tracking With User-defined Events in the BizBikes Demo Application 95

Index


E Edit the Chart Title or Text Field 183 Enable Data Collection For the Activity Area 97 Enabling Flex Fields 123 Exploring the User Interface 24 Export the Report To HTML 178

F FactoryTalk Metrics Icon Definitions 219 FactoryTalk Metrics UDT 105 Features and Benefits 12 Filter Permissions 223 Flex Fields - Boolean 114 Flex Fields - Integer 113 Flex Fields - String 112 Format 187

G Get Consulting Services 16 Get Phone Support 15 Get RSBizWare Training 14 Get Web Support 15 Getting Started 21 Good Parts 107 Group 186

H How BizBikes Are Manufactured 17 How FactoryTalk Metrics Will Help Solve the BizBikes Production Problems 19

I Ideal Cycle Time 107 Insert Text, Pictures, and Hyperlinks Into Your Report 142

Installation Assistance 235 Intended Audience 12 Introducing BizBikes 17

L Load Report From File 179 Loading the Plant Model from the Database 129

M Machine State 96 Machine States at Sample Enterprise 71 Manual Data Collection 101 Map a Machine State To a Formula That Resolves To a Single Bit 86 Map a Machine State To a Monitored Bit Data Point 83 Map a Machine State To a Single Monitored Value Data Point 77 Mean Time Between Failure 30 Mean Time To Repair 31 Modifying Performance Parameters 137 Monitored Availability 109 Move a Component 182

N New Product Satisfaction Return 235

O Object Permissions 221

P Part ID 107 Performance Parameter Event State Icons 220 Plant Model Element State Icons 219

Index


Q Quick Filter 188

R Reference the Administration Guide 14 Reference the Online Help 14 Reference the Release Notes 13 Registering the FactoryTalk Transaction Manager Configuration for Data Collection 135 Rename 188 Report Data Source Permissions 223 Report Designer 13 Report Object Permissions 222 Report Permissions 222 Report User 13 Resize a Component 182 Resize Table Columns 185 Review Performance Parameters Event Status 97 Review Sample Activity Areas 100 Rockwell Automation Support 235 RSBizWare Administrator 12 Running 109 Running Versus Downtime 93

S Save Your Report 143 Schedule a Report 198 Schedule a Report Object 194 Scheduled Availability 108 Scheduling Report Objects and Reports 193 Scrap Parts 108 Shortcut Menus 25 Show and Hide Columns 184 Sort 187 Start and Stop Data Collection 100 Starting a Data Collection 140

Step 1 Configure the Data Collection Parameters 47 Configure the Machine States 73 Define Time Patterns 35 Plan the Chart 155 Start the BizBikes Project 171 Start the Report Data Source Wizard 200 Start the Text Report Object Wizard 163

Step 2 Configure Composites 42 Configure the Ideal Cycle Time and Part Id Parameters 47 Give the Report Data Source a Name 201 Insert Your New Chart Into the Report 171 Map Machine States To User-defined Events 77 Select the Data On Which To Report 156, 164

Step 3 Choose a Chart Type 156 Configure User-defined Summarization Criteria Parameters 51 Determine Availability and Running State From Machine State 90 Group the Records 165 Schedule Exceptions 43 Select a Database Table or View 202 Select an Activity Area 171

Step 4 Choose the Columns That Will Be Included 203 Configure the Part Count Parameter 53 Describe the Data 156 Sort the Records 165 Specify the Layout of the Chart 172

Step 5 Configure the Scheduled Availability Parameters 58 Create a Filter 173 Enable the Time Selection Toolbar 205 Format the Table 167 Select Summary or Detail 157

Step 6

Index


Configure the Monitored Availability Parameters 61 Customize the OEE Bar Colors 174 Name the Report Object 169 Select the Fields To Be Charted 157 Specify the Format of the Table or View 206

Step 7 Enter the Chart Title 159 Filter the Data 169 Modify the Default Availability Behavior 64 Preview Your OEE Box Chart 175 Specify the Role That Each Field Plays In Time-Series Analysis 208

Step 8 Configure the Running State Parameter 65 Create a Data Point Configuration Table 209 Filter the Data 159 Insert Your New Table Into the Report 169

Step 9 Generate Performance Parameter Events 67 Insert Your New Chart Into the Report 162

System-generated Events 67

T The BizBikes Factory 17 The Excel Add-in 189 The FactoryTalk Metrics Event History Report Data Source 226 The FactoryTalk Metrics Machine State Data Report Data Source 228 The FactoryTalk Metrics Workcell History Report Data Source 225 The Recycle Bin 69 The Report Design and Display Work Area 25 The Report Explorer 25 The RSBizWare Architecture 21 Total Parts 108 Tutorial Prerequisites 19

U UDT Data Points and FactoryTalk Metrics Performance Parameters 106 Use Machine State To Determine Monitored Availability 90 Use Machine State To Determine Running State 91 User-defined Downtime Events 94 User-defined Events 68 User-derived Fields 210 Using FactoryTalk Metrics Configuration Tool to Perform an Automated Configuration 114 Using Microsoft Internet Explorer 22 Using the Configuration Console 23

V View the History of the Scheduled Task 198 View the Performance Parameter Events for an Activity Area 67 View Your Report In Preview Mode 143

W Welcome to FactoryTalk Metrics 11 What Are Fault Metrics? 30 What Is FactoryTalk Metrics? 11 What Is the OEE Rating? 28 Where Can I Go for Help? 13 Work Day Time Pattern 40 Work Week Time Pattern 41 Workcell History, Event History, and Machine State Data 225 Working With Chart 183 Working With the Component Parts of a Chart 182

Rockwell Automation Publication PLTMT-UM001K-EN-P-December 2012 Supersedes Publication PLTMT-UM001J-EN-P-December 2011 Copyright © 2012 Rockwell Automation, Inc. All rights reserved. Printed in the U.S.A.

Rockwell Automation Support Rockwell Automation provides technical information on the Web to assist you in using its products. At http://www.rockwellautomation.com/support/, you can find technical manuals, a knowledge base of FAQs, technical and application notes, sample code and links to software service packs, and a MySupport feature that you can customize to make the best use of these tools. For an additional level of technical phone support for installation, configuration, and troubleshooting, we offer TechConnect support programs. For more information, contact your local distributor or Rockwell Automation representative, or visit http://www.rockwellautomation.com/support/.

Installation Assistance

If you experience a problem within the first 24 hours of installation, review the information that is contained in this manual. You can contact Customer Support for initial help in getting your product up and running. United States or Canada 1.440.646.3434 Outside United States or Canada

Use the Worldwide Locator at http://www.rockwellautomation.com/support/americas/phone_en.html, or contact your local Rockwell Automation representative.

New Product Satisfaction Return

Rockwell Automation tests all of its products to ensure that they are fully operational when shipped from the manufacturing facility. However, if your product is not functioning and needs to be returned, follow these procedures. United States Contact your distributor. You must provide a Customer Support case number (call the phone number above to obtain

one) to your distributor to complete the return process. Outside United States Please contact your local Rockwell Automation representative for the return procedure.

Documentation Feedback

Your comments will help us serve your documentation needs better. If you have any suggestions on how to improve this document, complete this form, publication RA-DU002, available at http://www.rockwellautomation.com/literature/.

http://www.rockwellautomation.com/support/

http://www.rockwellautomation.com/support/

http://www.rockwellautomation.com/support/americas/phone_en.html

http://www.rockwellautomation.com/literature/

Documents

Pltmt Um001 en p