USER GUIDE Rockwell Automation Publication PLTMT-UM001M-EN-P-June 2014 Supersedes Publication PLTMT-UM001L-EN-P-June 2013
Contacting Rockwell Customer Support Telephone — 1.440.646.3434 Online Support — http://www.rockwellautomation.com/support/overview.page Copyright Notice © 2014 Rockwell Automation Technologies, Inc. All Rights Reserved. This document and any accompanying Rockwell Software products are copyrighted by Rockwell Automation, Inc. Any reproduction and/or distribution without prior written consent from Rockwell Automation, Inc. is strictly prohibited. Please refer to the license agreement for details.
Table of Contents Chapter 1 Welcome to FactoryTalk Metrics What Is FactoryTalk Metrics? ................................................................... 9 Features and Benefits ..................................................................................10 Intended Audience......................................................................................10 Where Can I Go for Help? ....................................................................... 12 Get Web Support ........................
Table of Contents Configuring OEE Performance Parameters For Activity Areas ...... 41 Configuring Data Collection .............................................................. 44 Configuring Cycle Time ...................................................................... 44 Configuring a Part ID/Cycle Time Lookup List ...................... 47 Configuring Part Id ............................................................................... 50 Configuring Summarization Criteria .........................
Table of Contents System-generated Event Data Summarization............................. 116 Availability Interpretation Options ............................................... 117 Performance Data Trending Rate ................................................... 118 Machine States .......................................................................................... 118 Machine States at the Sample Enterprise ...................................... 120 Prioritizing Machine States ......................
Table of Contents Chapter 5 Analyzing FactoryTalk Metrics Data 6 Create a New RSBizWare Report ........................................................ 171 Insert Text, Pictures, and Hyperlinks .................................................. 172 Save the Report ......................................................................................... 174 Move the Report and Set Report Permissions ................................... 175 Add a Saved Report Object to the Report ...........................
Table of Contents Load the Report From File..................................................................... 211 Chapter 6 Customizing RSBizWare Charts and Tables Customizing Charts ................................................................................ 213 Working With the Component Parts of a Chart ....................... 214 Resizing a Component ................................................................. 215 Moving a Component ........................................................
Table of Contents Configuring Reports ................................................................................ 250 Chapter 8 FactoryTalk Metrics Icon Definitions Plant Model Element State Icons ......................................................... 253 Performance Parameter Event State Icons ......................................... 254 Chapter 9 Object Permissions Filter permissions ..................................................................................... 258 Report permissions.
Chapter 1 Welcome to FactoryTalk Metrics In this chapter you will learn about the following: • What Is FactoryTalk Metrics? (page 9) • Features and Benefits (page 10) • Intended Audience (page 10) • Where Can I Go for Help? (page 12) What Is 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.
Chapter 1 Welcome to FactoryTalk Metrics 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 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.
Welcome to FactoryTalk Metrics Chapter 1 Metrics and does not cover the installation and operation of underlying system services. This document is intended for the following types of users of the RSBizWare software: • RSBizWare administrators RSBizWare administrators configure the RSBizWare system so that it can capture performance data for use by report designers and report users. They should be familiar with: • Control systems, process information (line and plant), and databases.
Chapter 1 Welcome to FactoryTalk Metrics They should be familiar with: • Microsoft Windows operating systems. Where Can I Go for Help? Consult the following resources for additional information about the product: • Release Notes The release notes contain current information about the product, including hardware and software requirements, new features, known and fixed anomalies.
Welcome to FactoryTalk Metrics Chapter 1 A current TechConnect Support contract may be required to use some online features. Get Phone Support 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.
Chapter 1 Welcome to FactoryTalk Metrics 14 Rockwell Automation Publication PLTMT-UM001M-EN-P-June 2014
Chapter 2 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 The RSBizWare architecture is a scalable, multi-tiered, distributed architecture consisting of a data collection subsystem, an Oracle or SQL Server database repository, the Information Services Manager, and clients.
Chapter 2 Getting Started 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.
Getting Started Chapter 2 7. Select the data that you want to import. 8. Click Finish. The Processing page with the import status appears. After the import is complete, the Completing the Database Load and Update Wizard page appears. 9. Click Close. Connecting to the Information Services Manager RSBizWare reports created by the report designer are saved to the Information Services Manager, and are available online over a TCP/IP network.
Chapter 2 Getting Started 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 following 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 need to download several ActiveX controls from the server computer. The download will begin automatically.
Getting Started Chapter 2 2. If prompted, type the user name and password for the account that your RSBizWare administrator has authorized for you, type the name of the server computer where the Information Services Manager is running in the Server box, and then click Login. A client session with the RSBizWare server is established.
Chapter 2 Getting Started ability to modify and delete the reports listed in the Report Explorer depends on the licenses and features that you have been assigned by your RSBizWare administrator, and the permissions that you have been granted by the creator of each individual report. • The report design and display work area on the right. When you click an item in the Report Explorer, the specified RSBizWare report appears in this area.
Getting Started Chapter 2 The plant model may be used by all RSBizWare applications in your organization (FactoryTalk Metrics, FactoryTalk Historian Classic, and FactoryTalk Scheduler). The enterprises, sites, areas, lines, and workcells in your plant model are the subjects of your performance parameter evaluation.
Chapter 2 Getting Started A new site is added to the tree. 5. Change the default name to Sample Site. 6. Right-click Sample Site, and then click New Activity Area > Area. A new area is added to the tree. 7. Change the default name to Sample Area. 8. Right-click Sample Area, and then click New Activity Area > Line. A new line is added to the tree. 9. Change the default name to Sample Line. 10. Right-click Sample Line, and then click New Activity Area > Work Cell. A new workcell is added to the tree.
Getting Started Chapter 2 13. Click OK. Loading Sample Activity Areas NOTE Follow these steps on the database server computer, on which Report Expert is installed. For more information, see the Administration Guide, section "Clean installation: supported installation scenarios". To load FactoryTalk Metrics sample data: 1. Go to Start > All Programs > Rockwell Software > FactoryTalk Tools > Database Wizard. The Database Load and Update wizard appears. 2. On the Welcome page, click Next. 3.
Chapter 2 Getting Started TIP Select both options so that you have access to FactoryTalk Metrics and Report Expert sample data. 6. Click Finish to load data. 7. Click Close to exit the wizard. Now you can examine the OEE performance parameters that are configured for sample activity areas. The activity areas are listed in the Manage Performance Parameters dialog box, under PlantMetrics Demo Area.
Chapter 3 Collecting Performance Data The primary functions of FactoryTalk Metrics are collecting and analyzing 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.
Chapter 3 Collecting Performance Data 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 serious effect of this issue was observed when the counter used in a FactoryTalk Metrics part count formula was reset, and the resulting formula evaluated to a negative number.
Collecting Performance Data Chapter 3 OEE Rating FactoryTalk Metrics uses the OEE (Overall Equipment Effectiveness) model to measure the performance of manufacturing equipment. The OEE model yields a single performance rating for every activity area (workcell, line, area, or plant) being monitored, thereby providing a simple way to determine quickly if an activity area is performing adequately.
Chapter 3 Collecting Performance Data 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.
Collecting Performance Data Chapter 3 such, can only be used in summary report objects and cannot have aggregate functions applied. Mean Time To Repair MTTR = FaultTime ⁄ FaultCount Mean Time to Repair (MTTR) is the ratio of the time spent in a failure state to the total number of failures. It measures the average amount of time when a piece of equipment was in a failure state.
Chapter 3 Collecting Performance Data • Day A time pattern for a 24-hour day. • Week A time pattern for a standard 7-day week. • Custom A time pattern for arbitrary duration, e.g., a 14-day cycle or an 8-hour shift. 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 the start time, end time, value (e.g.
Collecting Performance Data Chapter 3 To configure time patterns: 1. On the Configure menu, click Time Pattern. The Time Patterns dialog box appears. 2. On the File menu, click New Folder. A new folder is added to the Time Patterns tree. 3. Change the default name to My Enter. Time Patterns, and then press 4. Right-click My Time Patterns, and then click New Time Pattern. A new time pattern is added to the My Time Patterns folder.
Chapter 3 Collecting Performance Data 5. Change the default name to Shift A, and then press Enter. In the right pane of the dialog box, the default settings of your new time pattern are displayed. TIP The State value type set to Unavailable indicates that any periods of time that are not listed as Available in the Time Spans list will be considered Unavailable. 6. Clear the Lock Times check box. The shift times will be relative to the start and end times specified in the Work Day time pattern. 7.
Collecting Performance Data Chapter 3 11. Under Time Spans, right-click the area and then click New Time Span. The Time Span dialog box appears. 12. Make sure that the value type is set to State and the value is set to Available. 13. Set the start time of the shift to 0:00, and the end time to 4:00. NOTE Since the shift times are relative, the start time in this example means “the start time of the shift”, and the end time means “4 hours into the shift time”. 14. Click OK.
Chapter 3 Collecting Performance Data NOTE Since the default value of the time pattern is Unavailable, the half hour between the time spans is considered unavailable, because it has not been defined as available. A time span that is unavailable shows 0 capacity in the time pattern chart. 16. Under Time Patterns, right-click Shift A, and then click Duplicate. A copy of the shift is added to the tree. 17. Change the name of the shift to Shift B. 18. Under Report Name, type Shift B. 19.
Collecting Performance Data Chapter 3 3. Under Time Spans, right-click the area and then click New Time Span. The Time Span dialog box appears. 4. Under Value Type, select Time Pattern. With the Time Pattern option, you will create a time pattern for a particular shift. 5. Under Value, select Shift A. 6. Set the start time to 0:00 (midnight), and the end time to 8:00 (AM). 7. Click OK. 8. Under Time Spans, right-click the area and then click New Time Span. The Time Span dialog box appears. 9.
Chapter 3 Collecting Performance Data 11. Set the start time to 8:00 (AM), and the end time to 16:00 (4 PM). NOTE Type the time in the 24-hour format. 12. Click OK. 13. Under Time Spans, right-click the area and then click New Time Span. The Time Span dialog box appears. 14. Under Value Type, select Time Pattern. 15. Under Value, select Shift C. 16. Set the start time to 16:00 (4 PM), and the end time to 24:00 (midnight). Configuring Work Week Time To configure a Work Week time pattern: Patterns 1.
Collecting Performance Data Chapter 3 5. Click OK. 6. Under Time Spans, right-click the area and select New Time Span. The Time Span dialog box appears. 7. Under Value Type, select Time Pattern. 8. Under Value, select Work Day. 9. Under Start, select Monday 0:00 (Monday at midnight). 10. Under End, select Tuesday 0:00 (Tuesday at midnight). 11. Click OK. 12.
Chapter 3 Collecting Performance Data Time span for Thursday For this item: Select: Value Type Value Start End Time Pattern Work Day Thursday 0:00 Friday 0:00 Time span for Friday For this item: Select: Value Type Value Start End Time Pattern Work Day Friday 0:00 Saturday 0:00 Your My Time Patterns folder should contain now the following time patterns: Composites and Schedule Exceptions 38 A composite is a base time pattern that is associated with an activity area.
Collecting Performance Data Chapter 3 additional available times such as overtime hours or extended seasonal hours. Configuring Composites and In this tutorial you will use your Work Week time pattern created in "Configuring Work Week Time Patterns (page 36)", as the base Schedule Exceptions time pattern for your Sample Line and Sample Work Cell 1 created in "Configuring the Plant Model (page 21)". You will also schedule an exception for the New Year's Day.
Chapter 3 Collecting Performance Data The activity area for which you are scheduling an exception (in this tutorial it is Sample Line), is listed in the right pane of the dialog box, under Application. TIP Exceptions are created for the activity areas that are listed under Application. If you want to add several activity areas to the exception that you are configuring, select them under Elements, and then use the arrows to move them under Application. 5. Under Description, type New Year’s Day. 6.
Collecting Performance Data Chapter 3 9. Click OK. The new exception appears under Exceptions in the Composite Time Patterns dialog box. Configuring OEE Performance After you have created a plant model and a time pattern, and Parameters For Activity Areas associated the time pattern with activity areas in the plant, you can set additional parameters that will be used to measure the OEE rating and gather custom events for these activity areas.
Chapter 3 Collecting Performance Data 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.
Collecting Performance Data Chapter 3 In this dialog box you can configure the parameters that will be used to collect performance data and measure the OEE rating for the activity area. The upper section of the dialog box provides basic information on the activity area that you have selected, and the following options that you can use with your activity area: • Enable Manual Activity Area Select this option if you want to create a manual workcell.
Chapter 3 Collecting Performance Data Select this option if you want to start the data collection for the activity area that you have selected. NOTE Configuring Data Collection Enabling the data collection for the activity area also consumes one workcell license for the Information Services Manager to which the Configuration Console is connected. To configure the Data Collection: • In the list, select a FactoryTalk Transaction Manager configuration for data collection.
Collecting Performance Data Chapter 3 The Ideal Cycle Time parameter is part of the Throughput value in the OEE equation. It indicates the time, in seconds, which the activity area should take to produce a single good part. It can have a decimal value. If the activity area produces parts faster than the ideal cycle time, the OEE rating will improve. If the activity area produces parts slower than the ideal cycle time, the OEE rating will deteriorate.
Chapter 3 Collecting Performance Data In the Lookup list, select the lookup list that you want to use: • Click Create List to create a new list. • Click Edit List to modify the list that you have selected. TIP For more information on creating and editing Part Id/Cycle Time lists, see "Configuring a Part ID/Cycle Time Lookup List (page 47)". • Monitor an Unscheduled data point for Ideal Cycle Time Select this option to obtain the most accurate ideal cycle time.
Collecting Performance Data Chapter 3 TIP To delete the data point that you have selected, click Clear. 5. (Optional) Set the actual ideal cycle time using a FactoryTalk Transaction Manager expression: 1. Select the Use a FactoryTalk Transaction Manager Expression to determine the Ideal Cycle Time value check box. 2. Click Edit. The Expression Editor - Ideal Cycle Time Expression dialog box appears. 3. Create or modify the expression that you want to use.
Chapter 3 Collecting Performance Data • Cycle times for individual Part Ids. Click the links below to learn how to: • Configure the default cycle time for Total Parts. (page 48) • Configure the ideal cycle time values for individual Part Ids. (page 48) • Manage Part Id configurations. (page 49) • Import the cycle time values for individual Part Ids. (page 49) Configuring the Default Cycle Time for Total Parts To configure the default Cycle Time for Total Parts: 1.
Collecting Performance Data Chapter 3 4. In the Cycle Time box, type an ideal cycle time value in seconds. 5. Click OK. The Part Id and its cycle time value appear under Part Ids and Cycle Times in the Part Id/Cycle Time List Configuration dialog box. 6. Repeat the steps for other Part Ids for which you want to set individual ideal cycle time values.
Chapter 3 Collecting Performance Data 6. Click Yes. The Open dialog box appears. 7. Navigate to the file that you want to import, and then click Open. The table under Part Ids and Cycle Times is populated with the data imported from the file. Configuring Part Id How do I access the dialog box? 1. On the Configure menu, click FactoryTalk Metrics > Performance Parameters. The Manage Performance Parameters dialog box appears. 2.
Collecting Performance Data Chapter 3 The Part Id parameter 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 what type of part is 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.
Chapter 3 Collecting Performance Data 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: 1. Click Select.
Collecting Performance Data Chapter 3 3. If necessary, select the FactoryTalk Transaction Manager configuration for the activity area. 4. In the left pane of the dialog box, click Summarization Criteria. Summarization criteria take the form of a user-defined parameter, similar to the Shift, Part Id, and Ideal Cycle Time parameters, for which data can be collected. When the value of the parameter changes, it triggers the summarization of historical performance data for the activity area.
Chapter 3 Collecting Performance Data Select this option if you do not want the application to collect values for this parameter. 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 set a single value for the summarization criterion. The OEE rating for the activity area will always be based on this value.
Collecting Performance Data Chapter 3 2. Under Filtering Tools, in the FT Transaction Manager Topic/Device list, select the device from which you want to load data points. 3. At the top of the dialog box, click Refresh Points. The Data Points area at the bottom of the dialog box is populated with data points for the selected device. 4. Double-click the data point that you want to use. The data point appears in the Data Point box in the Configure Performance Parameters dialog box.
Chapter 3 Collecting Performance Data It is important to make sure that the total part counter and the good/bad part counter fire at the same time (e.g., when the part leaves the activity area). If the total part counter fires when a part arrives, but the good/bad part counter does not fire until the part leaves, the two part counters may be incremented in different summarization periods, resulting in misleading part counts in reports. To configure the Part Count parameter: 1.
Collecting Performance Data Chapter 3 Select this option if you do not want to collect this type of part count. For manual activity areas, you can select this option for all three tabs. • 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 the activity area.
Chapter 3 Collecting Performance Data example, if the activity area for which you configure performance parameters is actually two separate physical machines, you can create a formula to add the part counts from the two machines, in order to create a single good part count. Click Edit to define the formula (page 60). Configuring Part Count Using To use an unscheduled Data Point: an Unscheduled Data Point 1. Click Select. The Select Data Point dialog box appears. 2.
Collecting Performance Data Chapter 3 3. Click Edit. The Expression Editor - Total Part Count Expression dialog box appears. TIP The title of the dialog box reflects the part count type for which you are performing the actions. 4. Create or modify the expression that you want to use. If you use a FactoryTalk Transaction Manager expression with this option, the only data point it can reference is the one selected in the Data Point box.
Chapter 3 Collecting Performance Data Configuring a Formula How do I access the dialog box? 1. In the left pane of the Configure Performance Parameters dialog, click Part Count. 2. Click the Total Part Count, Good Part Count, or Scrap/Bad Part Count tab. 3. Click The Plant Model Activity Area evaluates a Formula to determine Part Count. 4. Click Edit. The performance parameter formulas are used to perform an advanced calculation for an OEE Performance Parameter.
Collecting Performance Data Chapter 3 Under Formula Part Operator, the Starting Value operator is preselected, since it is the first value in the arithmetic formula. 2. Under Formula Part Data Point, click Select. The Select Data Point dialog box appears. 3. Under Data Points, double-click the data point that you want to evaluate in the formula. 4. Click Close, and then click Next. The formula part that you have just created is displayed under Formula Text and Formula Parts. 5.
Chapter 3 Collecting Performance Data To add another value: 1. Under Formula Parts, click Add >. 2. Under Formula Part Operator, select (+) Add Value. 3. Under Formula Part Data Point, click Select. 4. Under Data Points, double-click the data point that you want to evaluate in the formula. 5. Click Close, and then click Next. The formula part that you have just created is displayed under Formula Text and Formula Parts. To subtract another value: 1. Under Formula Parts, click Add >. 2.
Collecting Performance Data Chapter 3 6. Click Finish. The formula is added to the Configure Performance Parameters dialog box. Availability Availability is the ratio of running time to available time, and is a key component of the OEE formula.
Chapter 3 Collecting Performance Data • Scheduled breaks, meetings, etc. • Planned maintenance. • External conditions that prevent the machine from working, such as being starved or blocked. In FactoryTalk Metrics, Available Time is the result of two other measures: Scheduled Availability and Monitored Availability. Scheduled Availability is the expected availability that results from a predictable shift schedule (including exceptions such as meetings or planned maintenance).
Collecting Performance Data Chapter 3 • Combining a time pattern optionally with Monitored Availability, so that a control system condition can override the predetermined schedule. This is how dynamic conditions such as blocked and starved are commonly handled. The Monitored Availability may be determined by: • A control system condition. This may be the state of a single data point or the resolution of a complex expression or formula involving one or more data points. • The current state of the machine.
Chapter 3 Collecting Performance Data 4. In the left pane of the dialog box, click Scheduled Availability. The Scheduled Availability parameter is part of the Availability value in the OEE equation. It indicates when the activity area is supposed to be available to produce parts. Scheduled Availability and Monitored Availability are used together to determine the availability (page 63) component of the OEE equation and to accumulate available time.
Collecting Performance Data Chapter 3 Since no shift information is collected, the reporting by shift is not allowed. • Collect Scheduled Availability information from the control system. Select this option if shift schedule changes on the site are frequent and variable. With this option selected, both shift information and an optional Scheduled Availability value are collected from the control system and used to define availability.
Chapter 3 Collecting Performance Data 4. Double-click the data point that you want to use. The data point appears in the Data Point box in the Configure Performance Parameters dialog box. TIP To delete the data point that you have selected, click Clear. • Select a lookup list to provide a description for the numeric shift value collected from the control system. Select the lookup list that you want to use: • Click New to create a new list. • Click Edit to modify the list that you have selected.
Collecting Performance Data Chapter 3 The data point appears in the Data Point box in the Configure Performance Parameters dialog box. TIP To delete the data point that you have selected, click Clear. If no data point is selected, the scheduled availability will be determined from the current shift. If the optional data point for the scheduled availability is selected, that is the only value used to determine the state of the scheduled availability.
Chapter 3 Collecting Performance Data negatively affected by time periods that are scheduled as unavailable (e.g., weekends, evenings). Click one the available buttons to access the respective editors that you can use to create or modify composites, exceptions, or time patterns: • Click Composite to assign time patterns and exceptions to activity areas. • Click Exception to define availability exceptions and apply them to appropriate activity areas.
Collecting Performance Data Chapter 3 Shift Data Point Value Value < 0 Value < 0 Scheduled Available Data Point Value Value is not 0 Value is 0 Creating Shift Description Lookup Lists Scheduled Availability Accumulating Shift information that is written to the database Yes No description. < 0 value for shift number with no shift description. < 0 value for shift number with no shift description. How do I access the dialog box? 1.
Chapter 3 Collecting Performance Data 5. Click OK. The value appears under Lookup Code Values. Instead of manually configuring a lookup code list, you can import an existing list from a comma-separated values file (.csv). NOTE If a shift description lookup list already contains values, and you intend to import other values to this list, the original values will be replaced with the new ones. To import Shift Description lookup list values: 1. Under Previous Import File Path, click Import.
Collecting Performance Data Chapter 3 Configuring Monitored Availability This item: Is data of type: Normal State Boolean: • 1, 0, or • true, false (case-insensitive). How do I access the dialog box? 1. On the Configure menu, click FactoryTalk Metrics > Performance Parameters. The Manage Performance Parameters dialog box appears. 2. Select the activity area for which you want to associate machine states, and then click Configure. The Configure Performance Parameters dialog box appears. 3.
Chapter 3 Collecting Performance Data scheduled to be available for an 8-hour shift, there can be times during that shift when the machine is not capable of producing output through no fault of its own. It might be starved by an upstream process, blocked by a downstream process, or it may have no work orders. If these times are excluded from the available time, the result is a more accurate picture of the machine’s actual efficiency.
Collecting Performance Data Chapter 3 Select this option if you want to use machine state to determine Monitored Availability. When machine states are defined, the (Monitored) Availability of each machine state is set. If machine states are configured for the current activity area, then at any point in time the activity area will be in one and only one machine state, and the Monitored Availability of that machine state (either available or unavailable) will be used.
Chapter 3 Collecting Performance Data The Select Data Point dialog box appears. 2. Under Filtering Tools, in the FT Transaction Manager Topic/Device list, select the device from which you want to load data points. 3. At the top of the dialog box, click Refresh Points. The Data Points area at the bottom of the dialog box is populated with data points for the selected device. 4. Double-click the data point that you want to use.
Collecting Performance Data Chapter 3 Select this option if you want to determine the availability of the activity area based on the results of a formula. This option specifies a formula that is constructed from one or more unscheduled numeric or binary data points, and when the result of that formula has a non-zero or true value, it indicates that the activity area is Monitored Available.
Chapter 3 Collecting Performance Data • Available Formula Point Configuring Running State How do I access the dialog box? 1. On the Configure menu, click FactoryTalk Metrics > Performance Parameters. The Manage Performance Parameters dialog box appears. 2. Select the activity area for which you want to associate machine states, and then click Configure. The Configure Performance Parameters dialog box appears. 3. If necessary, select the FactoryTalk Transaction Manager configuration for the activity area.
Collecting Performance Data Chapter 3 With this option selected, 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.
Chapter 3 Collecting Performance Data running state value using a FactoryTalk Transaction Manager expression: 1. Click Select. The Select Data Point dialog box appears. 2. Under Filtering Tools, in the FT Transaction Manager Topic/Device list, select the device from which you want to load data points. 3. At the top of the dialog box, click Refresh Points. The Data Points area at the bottom of the dialog box is populated with data points for the selected device. 4.
Collecting Performance Data Chapter 3 • 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 State 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 nor in a fault condition.
Chapter 3 Collecting Performance Data 3. If necessary, select the FactoryTalk Transaction Manager configuration for the activity area. 4. In the left pane of the dialog box, under Custom, click Events. The Performance Parameter events are used by FactoryTalk Metrics to collect data for performance monitoring. There are two types of the Performance Parameter events: system-generated (page 83) and user-defined (page 85). Both types of the events can be manual events (page 88).
Collecting Performance Data Chapter 3 • To copy a user-defined event from another performance parameter configuration to the current performance parameter configuration, click Copy. • To import new performance parameter events that you have created or overwrite existing performance parameter events that you have modified in Excel (.csv) or XML (.xml) files, click Import. • To export existing performance parameter event information to an Excel (.csv) or XML (.xml) file, click Export.
Chapter 3 Collecting Performance Data • Overall Available An Overall Available event record is created for each workcell for each continuous period of Overall Availability. Overall Availability takes into account all of the applicable availability factors that may determine if a workcell is available: schedule, schedule unavailable time, availability data point, and activity area exception unavailable time.
Collecting Performance Data Chapter 3 collection begins, remains open for as long as the data for the Part Count Formula is collected, and is subject to the event data summarization rules. Each record contains a zero for the start value and the cumulative result of the part count formula over the time duration of the event record for the end value. • Part Count Formula Point One of these system-level events is created for every component of a part count formula, when used in a workcell.
Chapter 3 Collecting Performance Data example, you can create user-defined events to trap and record downtime occurrences, e-stops, the 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. It is up to you what is captured and how it is interpreted.
Collecting Performance Data Chapter 3 • 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 it goes low at the end of the event). For more information, see "Set the Event Trigger Parameters" in the Configuration Console online help. • 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.
Chapter 3 Collecting Performance Data Manual Events Manual events are events without a physical data point attached to them. They can be both system-generated events and user-defined events. There is only one type of system-generated manual events, Activity Area Good Part Count - Manual, and only one event of this type may exist in a workcell. Manual events can be created only in an activity area configured as a manual activity area.
Collecting Performance Data Chapter 3 For user-defined manual events you can enter additional information about manual configuration in the event name. The properties of manual events are the same like for the user-defined events (page 85). For more information on manual events, refer to "Manual Events (page 88)" in the Configuration Console online help. The Recycle Bin The Recycle Bin is a system-generated category similar to the categories for available or running events.
Chapter 3 Collecting Performance Data 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 then create new available events.
Collecting Performance Data Chapter 3 The Configure Performance Parameter Event dialog box appears. To configure the event data summary: 1. In the Description box, type a name for the event. 2. In the Category list, either select a category from the list, or create a new one. To create a new category: 1. Next to the Category list, click New. The New Event Category dialog box appears. 2. Under Enter Event Category Name, type a name for the new category. 3. Click OK. 3.
Chapter 3 Collecting Performance Data TIP For information on individual data summarization types, see "Event Data Summarization Types (page 92)". 4. Continue with "Configuring the Event Trigger (page 93)". Event Data Summarization Types Event data summarization defines how FactoryTalk Metrics will handle the creation of multiple summary records in the database for a single occurrence of an event.
Collecting Performance Data Chapter 3 Use this data summarization type: To: Scheduled Shift Start and End or Summarization Criteria Change Summarize the event data at the beginning of each shift, at the end of each shift that is followed by Out of Shift time, and when there is a change in any Summarization Criteria, Part Id, or Cycle Time that is being monitored for the Performance Parameters configuration.
Chapter 3 Collecting Performance Data 4. In the left pane of the dialog box, under Custom, click Events. In the right pane of the dialog box, a list of available categories and events appears. 5. Click New. The Configure Performance Parameter Event dialog box appears. To configure the event trigger: 1. In the left pane of the dialog box, click Event Trigger. 2.
Collecting Performance Data Chapter 3 Select a data point: 1. Under Data Point, click Select. The Select Data Point dialog box appears. 2. Under Data Points, select a data point, and then click Select. The data point that you have selected appears in the Data Point box. 3. Continue with "Configuring the Event Value (page 99)". If you have selected any of these event trigger types: • Monitored Formula Low to High Transition • Monitored Formula High to Low Transition Create a formula: 1.
Chapter 3 Collecting Performance Data • None Continue with "Configuring the Event Value (page 99)". Event Trigger Types There are the following types of event triggers: • Event trigger types for system-generated events only (page 96). • Event trigger types for system-generated and user-defined events (page 97). • Event trigger types for manual events (page 99).
Collecting Performance Data Chapter 3 Event Trigger Types for System-generated and User-defined Events The following event trigger types are available for system-generated events and user-defined events that are not manual: Use this event trigger type: To: Monitored Bit Low to High Transition Monitor a bit value in the control system. For this event trigger type, you need to specify a control system value as the trigger data point.
Chapter 3 Collecting Performance Data Use this event trigger type: To: Monitored Value Monitor any change of a value in the control system. For this event trigger type, you need to specify a control system value as the trigger data point for this event trigger type. The trigger data point can be either a numeric or string data type.
Collecting Performance Data Chapter 3 Event Trigger Types for Manual Events There are the following event trigger types available for manual events: Event trigger type Description Manual active/inactive event The behavior of this trigger type is similar to the following trigger types available for user-defined events: • Monitored Bit Low to High Transition • Monitored Bit High to Low Transition • Monitored Formula Low to High Transition • Monitored Formula High to Low Transition The difference between
Chapter 3 Collecting Performance Data 5. Click New. The Configure Performance Parameter Event dialog box appears. To configure the event value: 1. In the left pane of the dialog box, click Event Value. 2.
Collecting Performance Data Chapter 3 2. Under Data Points, select a data point, and then click Select. The data point that you have selected appears in the Data Point box. • Configure a FactoryTalk Transaction Manager Expression for the Event Value 1. Under Expression, click Edit. The Expression Editor dialog box appears. 2. Follow the steps described in "Using the Expression Editor (page 104)", and define your expression. 3.
Chapter 3 Collecting Performance Data The historical event data contains fields to record an initial value and an ending value for an event. The Event Value type defines which of these fields is used as well as what is stored there. There are the following event value types: Event value type Description Plant Model Unit Part Count Sets the initial value of the event to be zero and the ending System-generated events value of the event to be the accumulated Part Count for the duration of the event.
Collecting Performance Data Chapter 3 Event value type Description This event value type is available for: • System-generated Collects a value when the event is activated and when it is events terminated. The initial and ending value fields are both used by this type of event. Use this Event Value type when • User-defined events you are interested in the data that will be collected when • Manual events the Event Trigger is activated and at the termination of the Event Trigger.
Chapter 3 Collecting Performance Data Using the Expression Editor The Expression Editor is a FactoryTalk Transaction Manager tool that you can use to create expressions, the result of which can be passed to a column in a database table or a parameter in a stored procedure in a database. After all data has been collected, expressions are evaluated.
Collecting Performance Data Chapter 3 Time Format and Processing Functions Use the following time format and processing functions: Item Description UTC Specifies that a timestamp will be displayed in Coordinated Universal Time (UTC) format. This format can be attributed to the TransTimestamp(), the TimeStampOf(), and OPCTimeStampOf() functions. The letters 'UTC' will be appended to all expressions.
Chapter 3 Collecting Performance Data Item Description MOPCTimestampOf() Uses a single data point as a parameter to return the millisecond component of the OPCTimestampOf() function. This value is an integer between 0 and 999 milliseconds. Tips: • The Transaction Control Manager will correctly evaluate the time as it was received from the OPC or FactoryTalk Live Data server.
Collecting Performance Data Chapter 3 Use the following data point functions: Item Description SUM() Returns the sum of multiple parameters for data points, ranges, numbers, or numeric expressions. Uses two parameters to return the difference between the previous value and the current value. The first parameter is a data point, usually a counter accumulator. The second parameter is a rollover value and is used when the current value is less than the previous value.
Chapter 3 Collecting Performance Data Item Description QualityOf() Uses one parameter to return three OPC server values. The values in parentheses in the first column of the following table represent the OPC bit values for quality. The corresponding converted QualityOf() return values are displayed in the second column. This function only applies to OPC or FactoryTalk data servers. If you are using a DDE server, a Good value is always returned.
Collecting Performance Data Chapter 3 Advanced Functions Use the following advanced functions: Item Description Parse() The Parse function uses four parameters to return the requested value from a data point array. • The first parameter is the data point to parse. The data point is usually created as a starting data table address and a length, for example, N7:0,L8 returns an array of eight elements from N7:0 to N7:7 in one data point.
Chapter 3 Collecting Performance Data The Lookup Code Configuration dialog box appears. To configure an Event Value Reason Code lookup list: 1. In the Lookup Code Description box, type a name for the Event Value Reason Code lookup list. 2. Under Lookup Code Values, click Add. The Lookup Code Value dialog box appears. 3. In the Value box, type a value. 4. In the Description box, type a description of the value. 5.
Collecting Performance Data Chapter 3 To import Shift Description lookup list values: 1. Under Previous Import File Path, click Import. The Open dialog box appears. 2. Select a file that contains the lookup list, and then click Open. See "Event Lookup Value CSV Format (page 72)" for the required file format of the Comma Separated Values (.csv) file. 3. Click OK. Configuring the Machine State / Faults How do I access the dialog box? 1.
Chapter 3 Collecting Performance Data • This event is not used in calculating Fault Metrics. • This event represents a Fault for the purposes of calculating Fault Metrics. • This event's collected value is used to calculate Fault Metrics based on the Event Lookup Code List. The availability of the options depends on the event trigger that you selected in "Configuring the Event Trigger (page 93)", and on whether you have selected the Manual Event option for the particular event.
Collecting Performance Data Chapter 3 The availability of the options depends on the event trigger that you selected in "Configuring the Event Trigger (page 93)", and on whether you have selected the Manual Event option for the particular event. 4. Continue with "Configuring the Reporting (page 113)". Configuring the Reporting How do I access the dialog box? 1. On the Configure menu, click FactoryTalk Metrics > Performance Parameters. The Manage Performance Parameters dialog box appears. 2.
Chapter 3 Collecting Performance Data You will need to select the reporting value, if you have selected the Collect Value at the Start and the End of the Event option in "Configuring the Event Value (page 99)". 3. Under Event Severity Level, select one of the following options: • Do not record Severity Level for this Event. • Specify a Severity Level for this Event.
Collecting Performance Data Chapter 3 Advanced Properties How do I access the dialog box? 1. On the Configure menu, click FactoryTalk Metrics > Performance Parameters. The Manage Performance Parameters dialog box appears. 2. Select the activity area for which you want to associate machine states, and then click Configure. The Configure Performance Parameters dialog box appears. 3. If necessary, select the FactoryTalk Transaction Manager configuration for the activity area. 4.
Chapter 3 Collecting Performance Data You can set the collection rate in the range of 1 to 60 seconds. This setting does not affect unscheduled part counters, which are collected as often as they change. When configuring the setting, take into account the following: • The lower the number, the more often the data will be collected from the control system. Using a lower number enables a greater resolution in data collected from rapid processes.
Collecting Performance Data Chapter 3 • Any scheduled Shift Change • Summarization Criteria Change • Scheduled Shift Start or Summarization Criteria Change • Scheduled Shift Start and End or Summarization Criteria Change • Any scheduled Shift Change or Summarization Criteria Change • Performance Trending Summarization Availability Interpretation Options Under Availability Interpretation Options, specify how FactoryTalk Metrics should determine the overall availability.
Chapter 3 Collecting Performance Data When you select this option, the Metrics Server Manager calculates availability in the least restrictive way. It means that either the Scheduled Availability or the Monitored Availability must evaluate to available for the activity area to be considered overall available.
Collecting Performance Data Chapter 3 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 the machine state at all times. The advantage of using machine states is that it is possible to account for all the time in the activity area by means of the defined machine states, without gaps and without double counting the time.
Chapter 3 Collecting Performance Data Machine States at the Sample Let us assume that the machines and the activity areas of the Sample Enterprise that you created in "Configuring the Plant Model (page Enterprise 21)" can be in one of the following machine states at any particular time: State Description Running The machine is producing output. This state represents the ideal state for this machine because the machine is available and running. The machine is being changed over for a new production run.
Collecting Performance Data Chapter 3 • FT.SampleEnterprise.Workcell_STATE This monitored value data point can have one of the following values: This value: Maps to this machine state: 0 (running) 1 (setup) 2 (test) 3 (down) 4 (off) Running Setup Test Down This value does not map to any 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.
Chapter 3 Collecting Performance Data Prioritizing Machine States After you have defined your machine states, you need to 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.
Collecting Performance Data Chapter 3 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 the Linefault state, the Blocked state, or some down condition that maps to the Down state). 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.
Chapter 3 Collecting Performance Data 3. In the State Name box, type a unique name for the state. 4. In the Color list, select the color that will be used to represent the state in graphical reports. NOTE The read-only Priority box indicates the priority of this machine state relative to other machine states. It is assigned automatically to the given machine state. You can change the priority using the Priority arrows in the Configure Machine States dialog box. 5.
Collecting Performance Data Chapter 3 6. Click OK. 7. Repeat steps 2-6 and add other machine states. 8. Under Machines States, use the Priority arrows to put the states in the correct order. An example of the machine state configuration is presented in the figure below.
Chapter 3 Collecting Performance Data map a value to a particular state though if that value has no meaning within your set of defined machine states. To map a machine state to a particular performance event, use the Machine State/Faults tab in the Configure Performance Parameter Event dialog box. For more information, see "Configuring the Machine State / Faults (page 111)".
Collecting Performance Data Chapter 3 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: • Any time the machine is not running. • Any on-shift time the machine is not running.
Chapter 3 Collecting Performance Data Metrics that you should evaluate for your organization. Each approach has its own advantages and considerations: • Running versus downtime. (page 128) • User-defined downtime events. (page 129) • Machine state. (page 130) Running Versus Downtime This measure of downtime is suitable for the organizations that consider downtime to be "any time a machine is available to produce parts, but is not actually running".
Collecting Performance Data Chapter 3 To report on running versus downtime data, use the Running Percent and Downtime Percent columns in the PlantMetrics Workcell Detail report data source. For more information, see "Report Data Sources (page 261)". The advantage of using the method of downtime tracking is that very little configuration or control system data is required.
Chapter 3 Collecting Performance Data User-defined events can also be configured as Faults, for the purposes of calculating Mean Time Between Failure (MTBF) and other metrics. Considering only the Fault events as downtime is another option for downtime reporting. Reports of user-defined events can be created using the PlantMetrics Event History report data source, with specific filters applied so that only the data associated with the desired events or event categories is displayed.
Collecting Performance Data Chapter 3 For more information, see "Configuring the Machine States (page 123)". 2. Configure a performance parameter event for each activity area for which you want to collect downtime data. For more information, see "Configuring User-defined Performance Parameter Events (page 90)". 3. Define how the event affects machine states. For more information, see "Configuring the Machine State / Faults (page 111)".
Chapter 3 Collecting Performance Data Review the following for additional information. This column: Indicates whether or not: Created The transaction was created when you enabled data collection for the activity area. The Not Applicable value means that the event does not require input from the control system, therefore, the transaction has not been created. Manual events whose trigger type is Manual active/inactive event or Manual monitored continuous event have the Not Applicable value.
Collecting Performance Data Chapter 3 Click Yes. • To remove orphaned transactions, i.e. transactions that are no longer bound to a specific data point or event, press and hold down the Ctrl key and click Generate Transactions. The following message appears: Click Yes.
Chapter 3 Collecting Performance Data It lists the FactoryTalk Transaction Manager configurations that have been imported, and the applications to which they apply. In the dialog box, you can evaluate the running status of FactoryTalk Transaction Manager configurations that are collecting data from the control system, as well as start, stop, or restart the configurations. 2. Select a FactoryTalk Transaction Manager configuration, and then click Start. The configuration is started.
Collecting Performance Data Chapter 3 To perform the manual data collection, you must be granted the Manage FactoryTalk Metrics Manual Data Collection privilege by your RSBizWare administrator. NOTE: To manually edit collected data: 1. On the Tools menu, click FactoryTalk Metrics > Manual Data Collection. The FactoryTalk Metrics Detail / Manual Data Collection dialog box appears. 2.
Chapter 3 Collecting Performance Data When you click: These values are displayed: Event The user-defined events that occurred during the specified period of time for the selected activity area. In this table, you can type reason codes and comments for each user-defined event. The OEE and other performance values calculated from the values collected during a specified period of time for the selected activity area. In this table, you cannot edit any records.
Collecting Performance Data Chapter 3 Click: To: Update the table with the data range that you have chosen. Show data without any time filters applied. Show data between a start and end date. For example: Show data for the past X time units. For example: Show data for the past X time units before the end date that you have specified. For example: Show data for the next X time units after the start date that you have specified. For example: Click , and then automatically.
Chapter 3 Collecting Performance Data 5. Edit the values that you want to change. In the example presented in the figure below, we subtracted 6 minutes from the Actual Availability value, due to the power outage. 6. Click OK.
Chapter 4 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 (UDT). The additional content provided with FactoryTalk Metrics includes: • FactoryTalk Metrics UDT (page 139). • FactoryTalk Metrics Configuration Tool (page 154).
Chapter 4 Automated Configuration UDT Tags and FactoryTalk Metrics Performance Parameters The following table lists the UDT tags from a ControlLogix controller and their corresponding performance parameters in FactoryTalk Metrics. You may need to modify the UDT tags in the controller to ensure that they contain valid data for FactoryTalk Metrics to collect. All the items listed in the table are unscheduled, unless otherwise stated.
Automated Configuration Chapter 4 These items of the UDT workcell template: Are mapped to these performance parameters in FactoryTalk Metrics: Item Data type Item Description TotalParts INT Total Part Count The value is not taken from the controller, but calculated by FactoryTalk Metrics as: Good Parts + Scrap Parts = Total Parts Shift INT Scheduled Availability - Shift Running BOOL Running State Monitored_Availability BOOL Monitored Availability Monitored_Value INT Custom Events, monit
Chapter 4 Automated Configuration These items of the UDT workcell template: Are mapped to these performance parameters in FactoryTalk Metrics: Item Data type Item Events_Digital BOOL[32] Events_Analog FTM_AnalogEvent[5] Trigger Value BOOL INT Custom Events (with An array of Boolean values interpreted by FactoryTalk no event values) Metrics as triggers for 10 user-defined digital events.
Automated Configuration Chapter 4 These items of the UDT workcell template: Are mapped to these performance parameters in FactoryTalk Metrics: Item Data type Item Description Flex_Integer INT[5] Flex Fields (Integer type) Flex_Bool BOOL[32] Flex Fields (Boolean type) Flex_String STRING[5] Flex Fields (String type) An array of 5 integer flex fields. This type of flex fields is not used by the FactoryTalk Metrics Configuration Tool.
Chapter 4 Automated Configuration 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 workcell level. The FactoryTalk Metrics Configuration Tool only configures plant model entries at the workcell level. If you want to create the RSBizWare environment from scratch, refer to the following documents: • RSBizWare Administration Guide, section "Performing a clean installation of RSBizWare".
Automated Configuration Chapter 4 servers may also be required if you use controllers other than ControlLogix as sources for FactoryTalk Metrics data. To configure RSLinx Enterprise: 1. Open the FactoryTalk Administration Console. 2. In the Explorer pane, right-click Network, and then click New Application. TIP All the OPC servers and controllers that are used by FactoryTalk Metrics should be contained within a single application in the FactoryTalk Directory. The New Application dialog box appears. 3.
Chapter 4 Automated Configuration The new server appears under the application. 8. (Optional) Add an area: TIP Areas organize and subdivide a distributed network application into logical or physical divisions. For example, separate areas may correspond to separate manufacturing lines in a facility, separate plants in different geographical locations, or different manufacturing processes. 1. Right-click the new application, and then click New Area. The New Area dialog box appears. 2.
Automated Configuration Chapter 4 The shortcut will reference all data tags within a given ControlLogix device. If the device contains data tags from only one workcell, it is recommended that you give the same name to both the workcell that you created for the FactoryTalk Metrics UDT in your plant model and the shortcut. If the device contains data tags from more than one workcell, use some other meaningful name for the shortcut. Create a shortcut for each ControlLogix device. 12.
Chapter 4 Automated Configuration The Shortcut Verifier dialog box appears. The dialog box displays the shortcut verification status. For details on messages that may appear in the dialog box, click How to use the Shortcut Verifier. 16. Click Close. 17. At the bottom of the window, click OK.
Automated Configuration Chapter 4 4. Click Open. The project is loaded to the Logix Designer window. In the Controller Organizer, under Data Types, right-click User-Defined, and then Import Data Type. The Import Data Type dialog box appears. 5. Navigate to \Rockwell Software\RSBizWare, and then select the FTM_Workcell.L5X file. TIP represents the path to the Program Files folder in which you installed the RSBizWare suite. 6. Click Import.
Chapter 4 Automated Configuration • FTM_Workcell This UDT defines the structure used to collect the information for a standard FactoryTalk Metrics workcell and references the FTM_AnalogEvent UDT. You will use these data types to create an array of tags specifically designed to store FactoryTalk Metrics data. Creating Tags Based on the FactoryTalk Metrics UDT In this step you will create an instance of the FactoryTalk Metrics UDT for the workcell that you want to be included in FactoryTalk Metrics.
Automated Configuration Chapter 4 To create an array of the FactoryTalk Metrics UDT instances: 1. In Studio 5000, in the Controller Organizer, double-click FTM_Workcell. In the right pane of the window, tags that constitute the FTM_Workcell UDT are displayed. For details on how the tags in the UDT relate to individual performance parameters in FactoryTalk Metrics, see "UDT Tags and FactoryTalk Metrics Performance Parameters (page 140)". 2.
Chapter 4 Automated Configuration 4. Next to the Data Type box, click . The Select Data Type dialog box appears. 5. Under Data Types, click FTM_Workcell. 6. In the Dim 0 box, change the value to the number of workcells in your controller. 7. Click OK. In this example, we created an array of 6 workcells. 8. Click Create. The array of UDT instances appears at the bottom of the list of the controller tags. The tags are named Workcell[0], Workcell[1], etc.
Automated Configuration Chapter 4 9. 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.
Chapter 4 Automated Configuration Creating FactoryTalk Transaction Manager and FactoryTalk Metrics Configurations The FactoryTalk Metrics Configuration Tool lets you enhance the process of creating configurations of multiple work cells for use in FactoryTalk Transaction Manager and FactoryTalk Metrics. Depending on the configuration type selected, certain stages of the process are automated.
Automated Configuration Chapter 4 Select workcells and define the configuration for them. 3. (New configurations only) Register your FactoryTalk Transaction Manager configuration for data collection (page 162). If you created a new configuration, register it in the Service Console. 4. (Optional) Import lookup lists and machine states (page 164). Import lookup lists and machine states from CSV files to modify the workcells. 5. Define your FactoryTalk Metrics configuration (page 166).
Chapter 4 Automated Configuration • FTM UDT For this configuration, data is loaded from the FactoryTalk Metrics SQL Server database with properties specific to the FTM UDT. Use this configuration to manually modify certain properties of the workcell data loaded from the SQL Server database that are related to a given control connector. 3. In the Data Source Name list, select the name of the ODBC data source configured for your RSBizWare SQL Server database. 4.
Automated Configuration Chapter 4 8. Do any of the following: • If you are creating a new FactoryTalk Transaction Manager configuration, go to "Step 2. Define a FactoryTalk Transaction Manager Configuration (page 157)". • If you are creating or updating a FactoryTalk Metrics configuration, go to "Step 5. Define a FactoryTalk Metrics Configuration (page 166)". • If you want to load additional machine states or lookup lists for your FactoryTalk Metrics configuration, go to "Step 4.
Chapter 4 Automated Configuration NOTE If you create a configuration for the workcells that have already been configured, the existing workcell information will be overwritten in the database when the configuration is imported and registered. 4. Next to the FTTM XML out file box, click . The Open dialog box appears. 5. Navigate to the location in which you want to store the FactoryTalk Transaction Manager XML configuration file.
Automated Configuration Chapter 4 Administration Console. Follow this structure: ComputerName\UserName or DomainName\UserName. 10. In the Connector password box, type the user password for the connector. If you do not enter a password and there is already an existing password assigned to the particular user, the password remains unchanged. 11. (Optional) Select the DataPoints only option, if you want to have only data points (data tags) generated for the modified workcells.
Chapter 4 Automated Configuration 15. Click OK. The configuration is imported to FactoryTalk Transaction Manager. If the configuration was imported with errors, a message listing the number and code of the errors appears. Check the error log file for details, correct the configuration, and then try again. The error log file is stored in the FTTM configuration path that you selected in step 8. The name of the file is structured in the following way: _XML.log. 16.
Automated Configuration Item Chapter 4 Description Work Cell Name from DB The name of the workcell in the FactoryTalk Metrics database. When a row is selected, the box is automatically filled with the first name from the list. You can assign a different name to it, as needed, in "Step 5. Define a FactoryTalk Metrics Configuration (page 166)". Shift Lookup List The shift lookup list for a workcell that you import in "Step 4. Import Lookup Lists and Machine States (page 164)".
Chapter 4 Automated Configuration To set values for multiple workcells in the list: 1. Select the Generate check box next to the workcells that you want to modify. 2. Type the values in the respective boxes. Each box applies to the column right below it. 3. Click Apply. Step 3. Register the FactoryTalk Transaction Manager Configuration for Data Collection NOTE If you have updated an existing FactoryTalk Transaction Manager configuration that is already registered in the Service Console, go to "Step 4.
Automated Configuration Chapter 4 6. Click Next. 7. On the Select FactoryTalk Transaction Manager Configuration page, select the configuration that you imported to FactoryTalk Transaction Manager. 8. Under Choose which... select the FT Metrics option. 9. Click Next, and then click Finish. The registered configuration appears under Data Collection. It is named with the name that you provided in the FTTM configuration name in "Step 2. Define a FactoryTalk Transaction Manager Configuration (page 157)". 10.
Chapter 4 Automated Configuration Step 4. Import Lookup Lists and Machine States NOTE This step is optional. In this step you can import to your configuration machine states, shift and event lookup lists from CSV files. To load machine states: 1. On the FT Metrics Lists tab, in the Machine State list box, to navigate to the CSV file type the location of or click that contains machine states. 2. Click Create. The following message appears: The machine state list is added to your configuration.
Automated Configuration Chapter 4 The shift lookup list is added to your configuration. To create a state event lookup list: 1. Click State Event Lookup List. 2. In the List Name box, type a name for the list. 3. In the Dictionary list box, type the location of or click to navigate to the CSV file that contains the lookup code values. 4. (Optional) Select the Bind event list with states check box, if you want to have each state event automatically associated with a machine state of the same name. 5.
Chapter 4 Automated Configuration Step 5. Define a FactoryTalk Metrics Configuration To create and import the FactoryTalk Metrics configuration file: 1. Click the FT Metrics tab. 2. (PackML UDT configuration only) Assign shift and state event lookup lists to the selected workcells, if needed. For details, see "PackML UDT Configuration Items (page 160)". NOTE In this step, you can exclude from the configuration some workcells that you selected in "Step 2.
Automated Configuration Chapter 4 9. In the FTTM configuration list, select the name of the FactoryTalk Transaction Manager configuration that you want to use. 10. In the Event categories box, type the location of or click to navigate to the location of a CSV file with control connector values and event categories assigned to them, which you want to add to the configuration. 11.
Chapter 4 Automated Configuration The error log file is stored in the FTTM configuration path that you provided in "Step 2. Define a FactoryTalk Transaction Manager Configuration (page 157)". The name of the log file is WorkcellDeployment.log. Guidelines for Modifying Imported Performance Parameters After you imported the FactoryTalk Metrics performance parameters with FactoryTalk Metrics Configuration Tool to FactoryTalk Metrics, you can customize them in the Configuration Console.
Automated Configuration Chapter 4 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 workcell is disabled and you need to enable it manually. • If you have chosen to disable events in the configuration tool, you need to manually enable all the events that you want FactoryTalk Metrics to use.
Chapter 4 Automated Configuration 170 Rockwell Automation Publication PLTMT-UM001M-EN-P-June 2014
Chapter 5 Analyzing FactoryTalk Metrics Data FactoryTalk Metrics provides a graphical environment for analyzing production and process data. In this chapter you will learn how to use FactoryTalk Metrics to create and view RSBizWare reports containing OEE charts (bar, pie, and line) and tables.
Chapter 5 Analyzing FactoryTalk Metrics Data To create a new, blank report: 1. Open the Configuration Console. 2. On the File menu, click New Report. A blank report page appears. Insert Text, Pictures, and Hyperlinks To add a title, a picture, and a hyperlink: 1. Click the report area, and type a title for your report, e.g., My Company Web Page. Select the title, and then, on the Report Formatting toolbar, change the title font to Arial, and the font size to 18. 2.
Analyzing FactoryTalk Metrics Data Chapter 5 8. Click OK. The logo appears under the title. 9. Click the image, and then on the Insert menu click Hyperlink. The Hyperlink dialog box appears. 10. In the URL box, type the address of the page which will open when you click the image. 11. Click OK.
Chapter 5 Analyzing FactoryTalk Metrics Data TIP You can also add a hyperlink to a text. To do so, select the text, and then, on the Reports Insertable Items toolbar, click . Then, repeat step 10. 12. On the Report Formatting toolbar, click the report will look like as a web page. to see, how When you point to the image, the alternative text will appear.
Analyzing FactoryTalk Metrics Data Chapter 5 2. In the Report Name box, type a name for your report file. In this example, the name is My Company Report. 3. Click Save. The report appears in the Report Explorer tree. Move the Report and Set Report Permissions To move the report to another folder, and set the report permissions: 1. On the menu, click Configure > Reporting > Report Explorer. The Report Explorer dialog box appears. 2. Click New Folder. 3.
Chapter 5 Analyzing FactoryTalk Metrics Data First, move the report under the folder, in which you want to put it. Then, click the right arrow to place the report in the folder. 5. Select your report, and then click Permissions. The Report Permissions dialog box appears. Use this dialog box to set permissions for viewing, editing, deleting, and applying security to the report. 6. On the Everyone tab, set permissions that you want to grant for all users that have access to the report.
Analyzing FactoryTalk Metrics Data Chapter 5 Add a Saved Report Object to The Configuration Console allows you to view report objects that other users have created, and add them to your report. For this the Report tutorial, we will add a saved report object that was created when the FactoryTalk Metrics sample data was installed. This report object will be used in section "Create a New Chart (page 185)". To add a saved report object to the report: 1.
Chapter 5 Analyzing FactoryTalk Metrics Data Item Description Report Data Source The list of report data sources from which the data will be shown in the report object and to which you have been granted permissions. The list of available report objects, grouped by the report data source from which they get their data.
Analyzing FactoryTalk Metrics Data Chapter 5 Item Description Select Which Toolbars to Show options Select the check box near the toolbar name which you want to display on the report. The check boxes allow you to add toolbars to the report object. The end users of your report will use these toolbars to adjust the report object to suit their needs. The following toolbars can be selected: • General • Time Selection • Status Bar • Report Data Source • Report Object • Filter 4.
Chapter 5 Analyzing FactoryTalk Metrics Data Adjust the Time Range For a When you create a new chart or table that is based on a time selection-enabled report data source, the Time Selection toolbar Time-based Report Object shown below will automatically appear 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.
Analyzing FactoryTalk Metrics Data Chapter 5 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.
Chapter 5 Analyzing FactoryTalk Metrics Data 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. Refer to the Add Dynamic Text Fields To a Report Object topic in the online help for the instructions to perform this task.
Analyzing FactoryTalk Metrics Data Chapter 5 To configure a report object to use Global Credentials: 1. Click the FactoryTalk Metrics Workcell History report object, and on the main menu, select View > Properties. The Report Object Properties dialog box appears. 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.
Chapter 5 Analyzing FactoryTalk Metrics Data • Require user to login Select this option if you want to require the users to provide their 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 log on 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.
Analyzing FactoryTalk Metrics Data Chapter 5 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.
Chapter 5 Analyzing FactoryTalk Metrics Data Step 1: Plan the Chart Take a look at the table report object inserted in "Add a Saved Report Object to Your Report (page 177)". This table shows a representation of the data you will be charting. You will be creating a chart with a bar for each workcell description; therefore, the Workcell Description field is the series.
Analyzing FactoryTalk Metrics Data Chapter 5 To insert the chart: 1. Place the mouse pointer where you want the chart to appear in the report and select Insert > Chart to display the authoring user name and server prompt. 2. Click Yes to accept the default user name and server. The New Chart wizard appears. This wizard will lead you through the process of creating a new chart for your RSBizWare report.
Chapter 5 Analyzing FactoryTalk Metrics Data 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 example of a table where the series is in columns. For this type of table, you would select the Columns option. However, since you have determined that the data is in rows, make sure the Rows option is selected and click Next to continue.
Analyzing FactoryTalk Metrics Data Chapter 5 Step 6: Select the Fields To Be In the Chart Fields step, you will select the fields from the report data source that will be shown in the chart. This dialog box would Charted look different if you had selected the Columns option in the Data Configuration step of the wizard. To select the fields to be charted: 1.
Chapter 5 Analyzing FactoryTalk Metrics Data workcells by hour. From the X-Axis list, select Start Time. 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 then select HOUR from the menu. 6. Click Next to continue. Step 7: Enter the Chart Title To enter the chart title: 1. The Report Object Name dialog box appears.
Analyzing FactoryTalk Metrics Data Chapter 5 • The “prompt-at-runtime” filter which allows the user to select the filter values every time the filter is used. For this tutorial, you are going to create a prompt-at-runtime filter that allows the users to select the work cells that they want to report on when the report is run. NOTE Prompt-at-runtime filters cannot be used with report objects that will be scheduled. To create a new filter: 1. Click New Filter. The Configure Filter dialog box appears. 2.
Chapter 5 Analyzing FactoryTalk Metrics Data 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.
Analyzing FactoryTalk Metrics Data Chapter 5 Step 9: Insert Your New Chart Now that you have selected the report data source, created the chart report object, and created a prompt-at-runtime filter, you are ready Into the Report to insert the chart into the report. 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.
Chapter 5 Analyzing FactoryTalk Metrics Data 7. Click OK to display the chart with the average running time for the two workcells that you selected. For information on how to further customize your chart by changing the title or bar/line colors, see "Customizing RSBizWare Charts and Tables (page 213)". Create a New Text Report Object 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.
Analyzing FactoryTalk Metrics Data Chapter 5 click list. to add the selected fields to the Fields in report Each field that you add to the list will be a column in your text report object. 3. Click Next. Step 3: Group the Records To specify how your table will be grouped: 1. On the Grouping Levels page under Fields in report, select the Part and Workcell Description fields, and then click . The fields are added to the Grouped fields list. 2. For this tutorial, group the records by Part first.
Chapter 5 Analyzing FactoryTalk Metrics Data 3. Click Next. Step 4: Sort the Records 196 The Sort Order page allows you to specify the order in which the columns will be sorted and to calculate totals for columns. Since you chose to group by Part and Workcell Description, those columns automatically have a sort order applied to them.
Analyzing FactoryTalk Metrics Data Chapter 5 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.
Chapter 5 Analyzing FactoryTalk Metrics Data 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.
Analyzing FactoryTalk Metrics Data Chapter 5 4. Select the Convert from option and ensure that Seconds is selected from the 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. 6. Click Next to continue. Step 6: Name the Report Object On the Report Object Name page, you need to provide a unique name for the report object. 1. For this tutorial, enter Demo Table. 2. Click Next.
Chapter 5 Analyzing FactoryTalk Metrics Data 7. Double-click the box outline to view the table. 8. Click OK to return to the report object. The table is displayed as a simple box in the report. 9. from the Default Filter list. 10. Click OK to return to the report object. The table is displayed as a simple box in the report. 11. Double-click the box outline to view the table. 12. Set the time selection option and refresh the table as you did in the chart tutorial.
Analyzing FactoryTalk Metrics Data Chapter 5 3. Click Yes. A blank OEE Box chart appears on the report. Step 2: Select an Activity Area To select the activity area: 1. Right-click the OEE Box chart, and then click Properties. The RSBizWare OEE Box Control Properties dialog box appears. 2. On the Activity Area tab, select the area for which you want to create the OEE chart.
Chapter 5 Analyzing FactoryTalk Metrics Data Step 3: Specify the Layout of To specify the layout of the chart: the Chart 1. In the RSBizWare OEE Box Control Properties dialog box, click the Layout tab. On this tab, you can 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.
Analyzing FactoryTalk Metrics Data Chapter 5 The chart displays the OEE bar from bottom to top on the left side of the OEE Box chart. Now you will 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. In your chart, include also the Mean Time Between Failures (MTBF) and Mean Time to Repair (MTTR). 3.
Chapter 5 Analyzing FactoryTalk Metrics Data 1. On the Layout tab, select the Apply a Custom Filter check box. 2. Click New.... The OEE Box Filter dialog box appears. You can 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. 3. In the Filter Name box, type Past 30 Minutes. 4. Clear the All Times check box. 5. Click . The The Past text box becomes editable. 6.
Analyzing FactoryTalk Metrics Data Chapter 5 9. To specify the parts that you want to filter on, under Additional Filtering, select Parts in the Filter On list. 10. Make sure the default All Parts option is selected. NOTE If you have User-defined Summarization Criteria configured for the activity area that you are reporting on, you can filter also on these criteria. 11. Click OK to save your filter. A message appears informing that your filter has been saved. 12.
Chapter 5 Analyzing FactoryTalk Metrics Data 2. For this tutorial, combine the two lower ranges so that you have two ranges instead of three. Under OEE Performance Level Configuration, select the 50 to 75 range. 3. Click Delete. A message appears asking if you want to delete the range. 4. Click Yes to remove the middle range from the list. The ranges are automatically adjusted to include the missing values.
Analyzing FactoryTalk Metrics Data Chapter 5 Step 6: Preview Your OEE Box To preview the OEE Box chart: Chart 1. In the RSBizWare OEE Box Control Properties dialog box, click OK. The OEE Box chart is displayed as a simple box in the report. 2. In order to see the OEE Box chart properly, click . The report is displayed in preview mode. The filter icon in the upper right corner indicates that the filter you specified is being applied. 3. Click to continue editing your report in design mode.
Chapter 5 Analyzing FactoryTalk Metrics Data The FactoryTalk Metrics Detail chart allows you to view the following information for an activity area: • Event • Counts • Scrap • OEE This is the same chart that is displayed in the Manual Data Collection dialog box (for more information see "Manual Data Collection (page 134)"). To create a FactoryTalk Metrics Detail chart: 1. Click a place in the report area, where you want to add the chart. 2. On the Insert menu, click FactoryTalk Metrics Detail.
Analyzing FactoryTalk Metrics Data Chapter 5 4. Right-click the chart, and then click Properties. The FactoryTalk Metrics Detail Control Properties dialog box appears. Use this dialog box to set the activity area for which you want to display FactoryTalk Metrics details. 5. Do either of the following: • Leave the Show Plant Model Editor Tree option selected, if you want the user to select the activity area when viewing the report.
Chapter 5 Analyzing FactoryTalk Metrics Data 6. In the Report Type list, select the type of the report that you want to generate for the selected activity area. Choose one of the following: • Event • Counts • Scrap • OEE • Schedule 7. Click OK 8. Double-click in the box area. You can now edit the box. 9. Click , and then click . All FactoryTalk Metrics detail data collected for the selected activity area is displayed.
Analyzing FactoryTalk Metrics Data Chapter 5 HTML editor or make the page part of a website, you need to export the report to an .htm file. To export the report to HTML: 1. On the File menu, click Export To File. The Save As dialog box appears. 2. Navigate to the location, in which you want to save the report. 3. In the File name box, type a name for the report file. In this example, the name is My Company Report.
Chapter 5 Analyzing FactoryTalk Metrics Data 212 Rockwell Automation Publication PLTMT-UM001M-EN-P-June 2014
Chapter 6 Customizing RSBizWare Charts and Tables This chapter will help you understand how to customize charts and tables that have been added to RSBizWare reports. For this example it is assumed that you have: • An RSBizWare report containing chart and table report objects open in the Configuration Console. • A FactoryTalk Metrics Author license. • Edit Report and Edit Report Object permissions for the report and report objects that you are working with.
Chapter 6 Customizing RSBizWare Charts and Tables NOTE Working With the Component Parts of a Chart 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. The default layout is fine for most charts, however, you can also change the layout of your chart if needed.
Customizing RSBizWare Charts and Tables Chapter 6 When you finish working with the chart component, click outside the chart to remove the resizing handles and highlighted border. Resizing a Component To resize a component: 1. Make sure that the sizing handles and highlighted border are visible around the component. 2. Point to one of the sizing handles, and when the cursor changes to , drag the handle until the component is the desired size. Moving a Component To move a component: 1.
Chapter 6 Customizing RSBizWare Charts and Tables 3. Modify the text and then click OK to save your changes. Changing Chart Component Properties 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 specific properties that relate only to its type. For example, the chart legend has properties that specify how the keys will be displayed within the legend.
Customizing RSBizWare Charts and Tables Chapter 6 Customizing Text Report Objects When your RSBizWare report contains a text report object or table, you can interactively show/hide, resize, and rename the columns, change the grouping and sorting of the columns, and apply aggregate functions to them. These are shortcuts to features that are normally available in the properties dialog box of the report object. The shortcuts have been created to allow you to quickly change the look and format of the table.
Chapter 6 Customizing RSBizWare Charts and Tables To hide a column: • Right-click the column that you want to remove from the table, and then click Hide Column. The columns that are removed from the table can be added again later. To show a column that is not currently included in the table: • Right-click the table and then click Insert Column > . The column will be inserted to the right of the column that is selected.
Customizing RSBizWare Charts and Tables Chapter 6 • Change the sort order of the table. • Rename the selected column heading. If your table is not using the Interactive Grid style, you need to change the table style. To change the style of the table to the Interactive Grid style: 1. Click the table, and then on the View menu click Properties. The Report Object Properties dialog box appears. 2. On the Advanced tab click Format. 3. The Global Report Object Formats dialog box appears. 4.
Chapter 6 Customizing RSBizWare Charts and Tables Aggregate To apply the SUM aggregate function to a column, right-click the column header, and then click Aggregate > SUM. The aggregate functions available on the menu vary from column to column. Only the functions that apply to a particular column are displayed. For example, it only makes sense to apply the SUM function to a numeric field. To remove the aggregate function from a column, right-click the column header, and then click Aggregate > None.
Customizing RSBizWare Charts and Tables Chapter 6 Sort To apply an ascending (A to Z) order to a column, right-click the column header, and then click Sorting > Sort 1 > Ascending. The table records are sorted by the selected column. Each time you click Sorting in the shortcut menu for additional columns, the additional sort numbers are added to the menu. This allows you to sort by as many columns as your table displays.
Chapter 6 Customizing RSBizWare Charts and Tables To create a quick filter: 1. Click the default quick filter to display a list containing all unique column values. 2. Select the value by which you want to filter. The table is trimmed using the value as the criterion.
Chapter 7 Advanced Reporting Topics The Excel Add-in The Excel Add-in allows you to retrieve RSBizWare data (general reporting or grid data, and time-series data) directly in 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.
Chapter 7 Advanced Reporting Topics 4. Click OK to save your changes and close the dialog box. A valid connection to the RSBizWare server is made and the RSBizWareSetup worksheet is created by the Excel Add-in. The worksheet contains the information required to retrieve data for the reports that you create in your Excel workbook. To add and modify reports in your Excel workbook: NOTE Each Excel workbook can contain up to 255 RSBizWare reports. 1.
Advanced Reporting Topics Chapter 7 2. Click Save to save your report. 3. To create a new time-series report, select Time-Series in the Report Type list, and then click . The Time Series Parameters dialog box appears, in which you can specify the report parameters.
Chapter 7 Advanced Reporting Topics 4. Click Save to save your report. 5. To modify the parameters of a grid or time-series report, click the column defining the report in the RSBizWareSetup sheet, and then click . 6. In the dialog box that appears, modify the desired parameters, and then click Save. NOTE To delete a report from the workbook, click Delete at the bottom of the dialog box. 7. To refresh the reports, click . The Report Name List dialog box appears.
Advanced Reporting Topics Chapter 7 8. Select the reports that you want to refresh, or select the Refresh All Reports check box. 9. Click Update to refresh the selected reports and close the dialog box. 10. Click Scheduling Report Objects and Reports to save your workbook. The Configuration Console allows you to schedule tasks to be run at some time in the future.
Chapter 7 Advanced Reporting Topics Schedule a Report Object To schedule a report object to be run at a later time: 1. Open the Configuration Console. 2. On the Configure menu, click Scheduled Report Objects. The Scheduled Report Objects dialog box appears. 3. Click Add. The Schedule Wizard appears. 4. On the Report Object Selection wizard page, select a report data source, a report object, and an optional filter. The preview of the selected data appears. 5. Click Next.
Advanced Reporting Topics Chapter 7 7. Under Frequency, select the desired option to specify the task frequency. For this example, select One Time. 8. Click Next. The Single Execution wizard page appears. 9. In the Date and Time boxes, specify the exact date and time of performing the task. 10. Click Next. The Delivery Method wizard page appears.
Chapter 7 Advanced Reporting Topics 11. Select one or more of the following distribution methods: • E-mail. Select this option to e-mail the task results. • In the To box, type the e-mail address to which the results will be sent as an e-mail attachment. • In the Format list, specify the file format to which the results will be saved. The available file formats depend on the type of the scheduled report object. • Printer. Select this option to send the task results to a printer.
Advanced Reporting Topics Chapter 7 A message appears informing you that the item has been successfully scheduled. The messages displays also information about the date and time of the next occurrence of the item. NOTE Schedule a Report NOTE To ensure that the scheduled task is successfully performed, you need to close the Configuration Console if the Report Schedule Manager and the Configuration Console are running on the same machine.
Chapter 7 Advanced Reporting Topics TIP To display the Report Explorer tree, you need to select the Report Explorer option. To do this, select Report Explorer on the View menu. The Report Explorer tree will appear on the left side of the Configuration Console window. The Report Explorer option is selected by default when you open Configuration Console. The Description and Frequency wizard page appears. 3. In the Task Description box, type the description of the task that will be performed.
Advanced Reporting Topics Chapter 7 5. Click Next. The Single Execution wizard page appears. 6. In the Date and Time boxes, specify the exact date and time of performing the task. 7. Click Next. The Delivery Method wizard page appears. 8. Select one or more of the following distribution methods: • E-mail. Select this option to e-mail the task results.
Chapter 7 Advanced Reporting Topics • In the To box, type the e-mail address to which the results will be sent as an e-mail attachment. • In the Format list, specify the file format to which the results will be saved. The available file formats depend on the type of the scheduled report object. • Printer. Select this option to send the task results to a printer. • In the Printer list, select the desired printer.
Advanced Reporting Topics Chapter 7 A message appears informing you that the item has been successfully scheduled. The messages displays also information about the date and time of the next occurrence of the item. NOTE View the History of the Scheduled Task To ensure that the scheduled task is successfully performed, you need to close the Configuration Console if the Report Schedule Manager and the Configuration Console are running on the same machine.
Chapter 7 Advanced Reporting Topics • 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 indicating the status of the task (e.g., Scheduled Item Created, Scheduled Item Dispatched, Scheduled Item Failed). • Run Results. An additional description of the task results.
Advanced Reporting Topics Chapter 7 Report Data Sources A report data source is a connection to a table or view within an external data source. A report data source describes a table or view to the Configuration Console. After your report data source has been created, you can design reports to analyze the data. For instructions on creating reports, see "Analyzing FactoryTalk Metrics Data (page 171)".
Chapter 7 Advanced Reporting Topics The Choose a Database Table or View page appears. 7. Select the desired database. The table at the bottom of the dialog box is filled with the tables and views that exist in the database. 8. Under Name, select the table or view to which you want to create a connection. 9. Click Next. The Column Selection page appears. 10. Select the column names that you want to add to the report data source: • Under Columns in Table or View, click a column name, and then click .
Advanced Reporting Topics Chapter 7 1. Under Field Name, type a name for the new field. 2. Under Data Type, select the data type for the field. 3. Under SQL Expression..., do either of the following: • Type the expression that will be evaluated to produce the derived field. • Choose one of available expressions: Under Columns, click a column name. Click Add Column to Expression. The expression from the column appears under SQL Expression....
Chapter 7 Advanced Reporting Topics 18. Under Supported Formats, select one of the following options that best describes your database table or view: Select this option: If: Table is not in a time-series format. Your table does not contain any time-series data. This setting will disable the time-series analysis and FactoryTalk Transaction Manager time-series data collection for the report data source. The reporting tag values are stored in a single column of the table.
Advanced Reporting Topics Chapter 7 The Data Point Configuration Table page appears. 22. Do either of the following: • Under Select the Data Point configuration table, select a table that holds information about the data points. • Under Or create a new table, click Create Configuration Table to have a new table created for you. The table fields are displayed under Match the configuration... 23.
Chapter 7 Advanced Reporting Topics The 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, you can create a summary derived field by summing up two fields of your choice, dividing one by the other, and then multiplying the result by 60 seconds.
Advanced Reporting Topics Chapter 7 Create Detailed Derived Fields To create detailed derived fields: 1. On the Configure menu in the Configuration Console, click Reporting > Report Data Sources, Objects, and Filters. The Configure Report Data Sources, Report Objects, and Filters dialog box appears. 2. Under Report Data Sources, click Add. The Report Data Source Configuration wizard appears. 3. Click Next. The Report Data Source Name page appears. 4.
Chapter 7 Advanced Reporting Topics TIP You can rename the columns listed under Columns in Report Data Source to make their names more intuitive (e.g., changing sDescription to Workcell or Machine Name). To do it, click a column, and then click Rename. The name becomes highlighted for editing. Change the name and then press Enter. 12. Click Derived Field, and then click Add Derived Field. The Add Derived Field dialog box appears.
Advanced Reporting Topics Chapter 7 2. Under Data Type, leave Number. 3. In the Columns list, click dRunSec. 4. Click Add Column to Expression. 5. Under SQL Expression..., edit the expression as follows: User.OEEQWorkCell.dRunSec/60 6. Click Validate to check for errors. If there are no errors, the Validate button becomes inactive. 7. Click Add. The Column Selection page appears. The derived field is displayed under Columns in Report Data Source. 8.
Chapter 7 Advanced Reporting Topics Field name PartsPerMinute Data type Add these columns to the expression Number • dTotalParts • dRunSec Complete SQL expression CASE WHEN User.OEEQWorkCell.dRunSec=0 THEN 0 ELSE (User.OEEQWorkCell.dTotalParts/User.OEEQWorkCell.dRunSe c)*60 END Notes PartsPerMinute is another way to represent the actual cycle time, in more familiar units.
Advanced Reporting Topics Chapter 7 The following picture shows a text report containing the created derived fields. Create Summary Derived Fields To create summary derived fields: 1. On the Configure menu in the Configuration Console, click Reporting > Report Data Sources, Objects, and Filters. The Configure Report Data Sources, Report Objects, and Filters dialog box appears. 2. Under Report Data Sources, click Add. The Report Data Source Configuration wizard appears. 3. Click Next. 4.
Chapter 7 Advanced Reporting Topics 8. Clear the Show Tables check box to display only the database views. 9. Select the OEEQWorkcell view. The selected database view is the view used by the standard FactoryTalk Metrics Workcell History report data source. 10. Click Next. The Column Selection page appears. 11. Click Derived Field, and then click Add Derived Field. The Add Derived Field dialog box appears. 12. Create a derived field called ActualCycleTimeTotals: 1.
Advanced Reporting Topics Chapter 7 7. Repeat the steps 1-6 to create the following summary derived field: Field name PartsPerMinuteTotal Data type Add these columns to the expression Number • dTotalParts • dRunSec Complete SQL expression CASE WHEN SUM(User.OEEQWorkCell.dRunSec)=0 THEN 0 ELSE (SUM(User.OEEQWorkCell.dTotalParts)/SUM(User.OEEQWorkCe ll.
Chapter 7 Advanced Reporting Topics Configuring Reports FactoryTalk Metrics contains over 40 configured reports in the Report Expert environment. However, customers require additional 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.
Advanced Reporting Topics Chapter 7 • Third-Party Reporting Tools. You can use third-party reporting tools to report on data in the FactoryTalk Metrics database.
Chapter 7 Advanced Reporting Topics 252 Rockwell Automation Publication PLTMT-UM001M-EN-P-June 2014
Chapter 8 FactoryTalk Metrics Icon Definitions In this chapter you will learn about the following: • Plant Model Element State Icons (page 253) • Performance Parameter Event State Icons(page 254) Plant Model Element State Icons Tree views in the Manage Performance Parameters and Configure Performance Parameters dialog boxes display the state of plant model elements. The table below lists the plant model element icons. Icon Plant Model element Enterprise. Site. Area. Line. Workcell.
Chapter 8 FactoryTalk Metrics Icon Definitions The table below lists the state icons that are applied to the plant model element icons to define their states. 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 it is not collecting data. The status of the plant model element is “Configured”.
FactoryTalk Metrics Icon Definitions Chapter 8 Icon State Definition An event that is waiting to receive initial data values or an event category that contains events that is waiting to receive initial data values. An event that is collecting data or an event category that contains events that is collecting data.
Chapter 8 FactoryTalk Metrics Icon Definitions 256 Rockwell Automation Publication PLTMT-UM001M-EN-P-June 2014
Chapter 9 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.
Chapter 9 Object Permissions Default object permissions are granted through the Service Console. For information, refer to the RSBizWare Administration Guide, "Configuring default object permissions". Filter permissions There are the following filter permissions: Item Description Delete Filter Allows the selected users or groups to delete the filter. Author Licenses only. Allows the selected users or groups to make changes to the filter. Author Licenses only.
Object Permissions Chapter 9 Report data source permissions There are the following report data source permissions: Item Description Allow Filter Selection Allows the selected users or groups to select the (all) filter from any column filter list associated with a report data source. Delete Report Data Source Allows the selected users or groups to delete the report data source. Author Licenses only.
Chapter 9 Object Permissions 260 Rockwell Automation Publication PLTMT-UM001M-EN-P-June 2014
Appendix A Report Data Sources FactoryTalk Metrics exposes the following important report data sources from which report designers can create charts and tables: • Workcell history (page 261). • Event history (page 263). • Machine state data (page 264). In order to create charts and tables effectively, you need to understand first the types of data included in these report data sources.
Appendix A Report Data Sources • Shift information. • The OEE calculation for that period of time. • The value for each configured user-defined summarization criterion. Records will be created as long as FactoryTalk Metrics is collecting data—24 hours a day, 7 days a week, whether the monitored equipment is running or not. The Performance Data Trending Rate interval selected for an activity area specifies the duration of the Workcell History record.
Report Data Sources Appendix A Event History 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 when that event ends.
Appendix A Report Data Sources 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.
Report Data Sources Appendix A • Shift information. • The number of the part being built and the ideal cycle time for that part number. • The number of parts built (good parts, scrap parts, and total parts). • The value for each configured user-defined summarization criterion.
Appendix A 266 Report Data Sources Rockwell Automation Publication PLTMT-UM001M-EN-P-June 2014
Index A Add a Saved Report Object to the Report 177 Adjust the Time Range For a Time-based Report Object 180 Advanced Functions 109 Advanced Properties 115 Advanced Reporting Topics 223 Aggregate 220 Aggregate, Group, Format, Sort, Chart, and Rename Columns 218 Analyzing FactoryTalk Metrics Data 171 Analyzing Non-RSBizWare Data 235 Automated Configuration 139 Availability 63 Availability Interpretation Options 117 C Changing Chart Component Properties 216 Chart 221 Collecting Part Count Data When the Metr
Index Create Detailed Derived Fields 242 Create Summary Derived Fields 246 Creating Event Value Reason Code Lookup Lists 109 Creating FactoryTalk Transaction Manager and FactoryTalk Metrics Configurations 154 Creating Shift Description Lookup Lists 71 Creating Tags Based on the FactoryTalk Metrics UDT 150 Customizing Charts 213 Customizing RSBizWare Charts and Tables 213 Customizing Text Report Objects 216 D Data Point Functions 106 Deleting a Component 215 Determining Availability and Running State From
Index Machine State Data 262 Machine States 118 Machine States at the Sample Enterprise 119 Managing Part Id Configurations 49 Manual Data Collection 134 Manual Events 87 Mapping Machine States to User-defined Events 125 Mean Time Between Failure 28 Mean Time To Repair 29 Move the Report and Set Report Permissions 175 Moving a Component 215 N New Product Satisfaction Return 270 O Object Permissions 255 OEE Rating 27 P PackML UDT Configuration Items 160 Performance Data Trending Rate 118 Performance Para
Index Step 3. Register the FactoryTalk Transaction Manager Configuration for Data Collection 162 Step 4 Create a Filter 203 Describe the Data 187 Sort the Records 195 Step 4. Import Lookup Lists and Machine States 164 Step 5 Customize the OEE Bar Colors 205 Format the Table 196 Select Summary or Detail 188 Step 5.
Index Rockwell Automation Publication PLTMT-UM001M-EN-P-June 2014 271
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 and application notes, sample code, and links to software service packs. You can also visit our Support Center at https://rockwellautomation.custhelp.com/ for software updates, support chats and forums, technical information, FAQs, and to sign up for product notification updates.
