USER GUIDE Rockwell Automation Publication HIST-UM001K-EN-E-June 2014 Supersedes Publication HIST-UM001J-EN-P-December 2011
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 Historian Classic What is FactoryTalk Historian Classic? .................................................. 9 Features and Benefits .............................................................................. 9 Intended Audience........................................................................................ 9 Where Can I Go for Help? .......................................................................
Table of Contents Save the Report ............................................................................................44 Add a Saved Report Object to Your Report ......................................... 45 Configure the Report Object To Use Global Credentials ................ 48 Create a New Chart ....................................................................................51 Step 1: Plan the Chart ...........................................................................
Table of Contents X-axis Comments ..................................................................................81 Y-axis Comments ...................................................................................82 Ad Comment As ....................................................................................84 Export the Report to HTML ................................................................... 84 Load the Report From File...................................................................
Table of Contents Step 2: Give the Report Data Source a Name ......................... 116 Step 3: Select a Database Table or View ................................... 117 Step 4: Choose the Columns That Will Be Included ........... 117 Step 5: Enable the Time Selection Toolbar ............................. 119 Step 6: Specify the Format of the Table or View.................... 120 Step 7: Specify the Role That Each Field Plays In Time-Series Analysis 122 Step 8: Create a Data Point Configuration Table ....
Table of Contents Saving and Compiling the Project .................................................. 151 Trying Out the Custom Analysis Tool.......................................... 153 Debugging Custom Analysis Tools in Visual C++ .................... 154 Why Use Custom Analysis Tools? ....................................................... 155 Chapter 8 Object Permissions Filter permissions ..................................................................................... 158 Report permissions...
Table of Contents 8 Rockwell Automation Publication HIST-UM001K-EN-E-June 2014
Chapter 1 Welcome to FactoryTalk Historian Classic What is FactoryTalk Historian The RSBizWare software is a suite of tools and services aimed at increasing your manufacturing floor effectiveness and profitability Classic? with solutions that target performance analysis and improvement and with data acquisition and integration. FactoryTalk Historian Classic is just one of the applications that is available within the RSBizWare software.
Chapter 1 Welcome to FactoryTalk Historian Classic FactoryTalk Historian Classic and does not cover 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.
Welcome to FactoryTalk Historian Classic Chapter 1 • 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.
Chapter 1 Welcome to FactoryTalk Historian Classic 12 Rockwell Automation Publication HIST-UM001K-EN-E-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 Information Services Manager 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 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. After you have downloaded the ActiveX controls from the Information Services Manager, you may be prompted to log on.
Chapter 2 Getting Started The status bar at the bottom of the client application shows your user name, the activations that have been assigned to you, and the Information Services Manager to which you are connected. Exploring the User Interface When you start the Configuration Console, you will notice that the user interface is made up of two main components: the Report Explorer and the report design and display work area.
Getting Started Chapter 2 Report Explorer. The work area is the region where report designers can create and modify reports. Shortcut Menus Many areas of the application give you access to shortcut menus. The shortcut menu allows you to perform frequently used commands without using the main application menu or toolbar buttons. To view the shortcut menu, you need to right-click in the area of the desired application. The shortcut menu contains commands that are appropriate for the selected area.
Chapter 2 Getting Started 18 Rockwell Automation Publication HIST-UM001K-EN-E-June 2014
Chapter 3 Collecting FactoryTalk Historian Classic Data The primary functions of FactoryTalk Historian Classic are to collect and analyze time-series data. Before the report designer can create time-series analysis reports for the report user, the RSBizWare administrator must set up the application to collect data from the control system. The tutorials in this chapter will help you understand how to use FactoryTalk Historian Classic to collect time-series data.
Chapter 3 Collecting FactoryTalk Historian Classic Data Item Description Workcell A location and/or group of equipment used to perform work in a manufacturing process. The operations in a manufacturing process are performed at workcells. A workcell is typically a physical location and a primary resource (e.g., a machine); however, it may also represent a logical grouping of primary resources from which a selection is made. A collection of one or more workcells that are combined to perform work.
Collecting FactoryTalk Historian Classic Data Chapter 3 The Plant Model dialog box appears. 2. Right-click in the area under the plant model tree, and then click New Root Enterprise. A new enterprise is added to the tree. 3. Change the default name to Sample Enter. Enterprise, and then press 4. Right-click Sample Enterprise, and then click New Activity Area > Site. A new site is added to the tree. 5. Change the default name to Sample Site. 6.
Chapter 3 Collecting FactoryTalk Historian Classic Data 12. Right-click each activity area that you have created, and then click Add Capacity. TIP The capacity of an activity area describes its availability over time. Add capacity for your activity areas so that you can associate them with time patterns. 13. Click OK. Configure Time-Series Data Collection FactoryTalk Historian Classic uses FactoryTalk Transaction Manager to collect data from the control system and log it into the RSBizWare database.
Collecting FactoryTalk Historian Classic Data Chapter 3 A data point is a specific data location or register in the control system that is made available to FactoryTalk Transaction Manager transactions. After it is defined, a data point can be used by any FactoryTalk Transaction Manager transaction. Types of control connectors for the data collection The FactoryTalk Transaction Manager interfaces with the industrial control system device via a control connector.
Chapter 3 Collecting FactoryTalk Historian Classic Data Enterprise Connectors The FactoryTalk Transaction Manager interfaces with the database via an enterprise connector. An enterprise connector is a Windows service that receives data from the FactoryTalk Transaction Manager and logs it to a database.
Collecting FactoryTalk Historian Classic Data Chapter 3 Tutorial Item Description Time-series Data Compression This connector stores time-series data in a pre-defined compressed format in either an Oracle database or a Microsoft SQL Server database. The compressed data point records contain binary data that can only be viewed through FactoryTalk Historian Classic. For a detailed description of data compression and the Compression connector, see the Administration Guide, section "Data Compression".
Chapter 3 Collecting FactoryTalk Historian Classic Data 1. The report data source is the database table or view where the data will be stored.
Collecting FactoryTalk Historian Classic Data Chapter 3 configurations that had Compression Enterprise Connections would be available here. Since we selected a non-compression report data source, any FactoryTalk Transaction Manager configurations that have non-compression (OLE DB, OCI, or ODBC) enterprise connectors will be available. 3. The Enterprise Connector is the service that will manage the connection between the FactoryTalk Transaction Manager configuration and the database.
Chapter 3 Collecting FactoryTalk Historian Classic Data 1. To select the data points from which data will be collected, click the Add button. The Select FactoryTalk Transaction Manager Data Points dialog that is displayed lists the data points that exist in the FactoryTalk Transaction Manager configuration. The top of the dialog is simply a set of tools that you can use to filter the data point list.
Collecting FactoryTalk Historian Classic Data Chapter 3 2. To add new data points to the FactoryTalk Transaction Manager configuration, click the Add/Edit Points button to display the (FactoryTalk Transaction Manager) FactoryTalk Data Point dialog box.
Chapter 3 Collecting FactoryTalk Historian Classic Data This dialog may look different depending on the type of control connector that you selected. This dialog allows you to add data points to the Control Connector and set their properties. 3.
Collecting FactoryTalk Historian Classic Data Chapter 3 The selected data points have been added to the list of data points for which you will be creating transactions. Since we are collecting data from newly selected data points, the FactoryTalk Historian Classic Reporting Tag column does not yet contain reporting tag names that will be associated with the values when they are stored in the database. 5.
Chapter 3 Collecting FactoryTalk Historian Classic Data Transaction Manager Unscheduled Transaction dialog box will display. If you have selected both scheduled and unscheduled data points, the FactoryTalk Transaction Manager Scheduled Transaction dialog box and the FactoryTalk Transaction Manager Unscheduled Transaction dialog boxes will both be displayed. Scheduled transactions.
Collecting FactoryTalk Historian Classic Data Chapter 3 2. Set the scan rate to 15 seconds. This means we will be collecting data every 15 seconds between the time the configuration is started and the time the configuration is stopped. 3. Click Next to continue. Unscheduled transactions. Unscheduled transactions are triggered by a change in the value of the data point that is being logged.
Chapter 3 Collecting FactoryTalk Historian Classic Data configuration is still running even if our unscheduled transaction has not been logged for a while. If you do not use a minimum collection frequency and your unscheduled transaction has not been logged for a while (this is called a deadband), it may be difficult to determine if the FactoryTalk Transaction Manager configuration is still running.
Collecting FactoryTalk Historian Classic Data Chapter 3 1. The Transaction Storage options allow you to specify how the data will be stored to the database. • Cache Transaction File—The FactoryTalk Transaction Manager will write data values to a file for a specified period of time or a specified number of transactions. When the file reaches the specified limit, the Enterprise Connector reads and processes the records in the file.
Chapter 3 Collecting FactoryTalk Historian Classic Data Step 6: Create Transactions The Summary dialog box gives you a chance to review the transactions that will be created. 1. If the transactions are correct, click Create. 2. The Results panel displays errors and warnings that occurred during the generation of FactoryTalk Transaction Manager transactions, if any.
Collecting FactoryTalk Historian Classic Data Chapter 3 will be creating reports; therefore, it is a good idea to organize your reporting tags. NOTE To manage time-series reporting tags, you must be granted the Manage Reporting Tags privilege by your RSBizWare administrator. 1. From the main menu, select Tools > FactoryTalk Historian Classic > Manage Time-Series Reporting Tags to display the Time-Series Reporting Tags dialog.
Chapter 3 Collecting FactoryTalk Historian Classic Data To perform an activity area search, click to the right of the Plant Model Activity Area box. Use the Plant Model Browser dialog that is displayed to select the activity area that you want to search. Click OK to return to the Time-Series Reporting Tags dialog. The Search Results list is refreshed to show the reporting tags in the report data source that are associated with the selected activity area.
Collecting FactoryTalk Historian Classic Data Chapter 3 5. Click OK to save your changes and return to the Time-Series Reporting Tags dialog. 6. Click OK to close the Time-Series Reporting Tags dialog. Start Data Collection After you have finished configuring the performance parameters, and enabled data collection for the activity areas that use a particular FactoryTalk Transaction Manager configuration, you need to start the FactoryTalk Transaction Manager configuration to begin the data collection.
Chapter 3 Collecting FactoryTalk Historian Classic Data 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. The green traffic light icon ( ) indicates that the configuration is running and collecting data from the control system.
Chapter 4 Analyzing FactoryTalk Historian Classic Data FactoryTalk Historian Classic provides a graphical environment in which to analyze manufacturing process data. This chapter will help report designers understand how to use FactoryTalk Historian Classic to create and view RSBizWare reports containing time-series charts; bar, pie, and line charts; and tables.
Chapter 4 Analyzing FactoryTalk Historian Classic Data The data in the report object may be restricted by a query (a filter), made up of one or more search criteria, that determine which records from the report data source will be shown. The use of a filter is optional. 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.
Analyzing FactoryTalk Historian Classic Data Chapter 4 The alternate text appears as a tooltip when you point to the image. 7. Under Layout and Spacing, set the display properties of the picture. 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.
Chapter 4 Analyzing FactoryTalk Historian Classic Data 11. Click OK. 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 Historian Classic Data Chapter 4 To save the report: 1. On the File menu, click Save Report As. The Save Report As dialog box appears. 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. Add a Saved Report Object to The Configuration Console allows you to view report objects that other users have created and to add them to your report.
Chapter 4 Analyzing FactoryTalk Historian Classic Data Click Yes to accept the default user name and server. Click No to connect to a different server and display the login dialog box where you provide the credentials and the server that you want to use to author the report object. For this tutorial, click Yes to accept the default user name and server. The RSBizWare Report Object Properties dialog box appears. 3. Use this dialog box to select the report object that you want to insert in your report.
Analyzing FactoryTalk Historian Classic Data Chapter 4 Item Description Filter Manage Report Objects Select Which Toolbars to Show options The list of available filtering criteria. The button for displaying the Configure Report Data Sources, Report Objects and Filters dialog box. 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.
Chapter 4 Analyzing FactoryTalk Historian Classic Data Configure the Report Object At run time, the RSBizWare report objects on your report will attempt to connect to an Information Services Manager to access the To Use Global Credentials production data necessary to draw the chart, bar graph, etc. The connectivity settings for each report object specify how they will connect to the Information Services Manager.
Analyzing FactoryTalk Historian Classic Data Chapter 4 To enable a report object to make use of a session logon, the report object must be configured to use Global Credentials. 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.
Chapter 4 Analyzing FactoryTalk Historian Classic 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 Historian Classic Data Chapter 4 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 4 Analyzing FactoryTalk Historian Classic Data Step 1: Plan the Chart The following table shows a representation of the data we will be charting. We will be creating a chart with a bar for each data point; therefore, the Description field is the series. Notice that one column in our table (Description) contains all of the data point descriptions, and the data for the data points is organized in rows.
Analyzing FactoryTalk Historian Classic Data Chapter 4 data point. This will be important to remember when we are using the New Chart Wizard. Place your cursor where you want the chart to appear in the report and select Insert >Chart to display the authoring user name and server prompt. Click Yes to accept the default user name and server. The New Chart Wizard will display. This wizard will lead you through the process of creating a new chart for your RSBizWare report.
Chapter 4 Analyzing FactoryTalk Historian Classic Data If the data points ID or descriptions 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.
Analyzing FactoryTalk Historian Classic Data Chapter 4 Step 6: Select the Fields To Be In the Chart Fields step, we select the fields from the report data source that will be shown in the chart. This dialog box would look Charted different if we had selected the Columns option in the Data Configuration step of the wizard. 1. Since we want to have a bar for each workcell and we want the names of the workcells to appear in the legend, select Description from the LEGEND list. 2.
Chapter 4 Analyzing FactoryTalk Historian Classic Data format to HOUR, select TimeStamp from the list, click Format, and select HOUR from the shortcut menu. 6. Click Next to continue. Step 7: Enter the Chart Title The Report Object Name dialog box appears. You must provide a unique name for the report object. The name you enter here will appear at the top of your new chart and will also be the name for this chart when it is saved as a report object for future use. 1.
Analyzing FactoryTalk Historian Classic Data Chapter 4 To create a new filter: 1. Click New Filter. The Configure Filter dialog box appears. 2. Enter the name Data box. Point Filter in the Edit Filter Name 3. A filter is made up of one or more search criteria. For this filter, you will create a single criterion. Click Add Criterion. The Search Criterion dialog box appears. 4. Select the Description field from the Field tree and select the = operator from the Operator list. 5.
Chapter 4 Analyzing FactoryTalk Historian Classic 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 Historian Classic Data Chapter 4 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 4 Analyzing FactoryTalk Historian Classic Data 6. For this tutorial, hold down the Ctrl key on your keyboard and select all of the Injection Molding data points from the list. 7. Click OK to display the chart with the data points that you selected. Refer to "Customizing RSBizWare Charts and Tables (page 87)" for information on how to further customize your chart by changing the title or bar/line colors.
Analyzing FactoryTalk Historian Classic Data Chapter 4 Step 1: Start the Text Report To start the Text Report Object Wizard: Object Wizard 1. In the Configuration Console, place your cursor where you want the table to appear in the report. 2. On the Insert menu, click Text Report. 3. Click Yes to accept the default user name and server name. The Report Wizard appears. 4. Click Next. Step 2: Select the Data On Which To Report To select the data that you want to include in the table: 1.
Chapter 4 Analyzing FactoryTalk Historian Classic Data TimeStamp, and Value fields and then click selected fields to the Fields in report list. to add the 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 The Grouping Levels dialog box allows you to specify how your table will be grouped. 1. The fields that we added to the table are listed in the box on the left side of the dialog box. We can group by any of these fields.
Analyzing FactoryTalk Historian Classic Data Chapter 4 3. Since we want to group the records by the hour portion of the timestamp, select TimeStamp in the box on the right and click the Grouping Interval button. The Format Field dialog box is displayed. Select the HOUR format and click OK to return to the Report Wizard. 4. Click Next to continue. Step 4: Sort the Records The Sort Order dialog box allows you to specify the order in which the columns will be sorted and to calculate totals for columns.
Chapter 4 Analyzing FactoryTalk Historian Classic Data NOTE The weighted average (WAVG) function is an average that takes into account the proportional relevance of each component (typically over time), rather than treating each component equally. Weighted average can be used in any table of information where the values of a particular column should be given more or less importance based upon the values of another column.
Analyzing FactoryTalk Historian Classic Data Chapter 4 Invoice style from the Report Style list. A sample of the style is displayed in the preview window to the right of the list. 2. The Styles by Field section of the dialog box allows you to set display formats for the individual fields. For this example, specify the time formatting that is applied to the AVG(Downtime Seconds) field. Select the field from the list box and click Customize Selected Field. The Customize Report Styles dialog box appears. 3.
Chapter 4 Analyzing FactoryTalk Historian Classic Data 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 Historian Data Point View Table. 2. Click Next. Step 7: Filter the Data On the Filter page, you can use the same filter that you created for the chart, or you can create a new one. For this tutorial, use the one created before. To filter the data: 1. Click Data Point Filter from the Filter list. 2.
Analyzing FactoryTalk Historian Classic Data Chapter 4 Refer to "Customizing RSBizWare Charts and Tables (page 87)" for information on how to further customize your chart by changing the title or bar/line colors. Create a Time-series Chart One of the primary features of FactoryTalk Historian Classic is the ability to analyze time-series data. Any data value that is collected over time is time-series data. A temperature or pressure value that is collected over time is an example of time-series data.
Chapter 4 Analyzing FactoryTalk Historian Classic Data Step 2: Name the Report Object We must provide a unique name for our time-series chart. For this tutorial, type Time-series Chart in the Report Object Name box and select the Include report object name as title on chart check box. This will cause the name to be shown at the top of the time-series chart. If you clear this check box, the chart title will default to “Time-Series Analysis.
Analyzing FactoryTalk Historian Classic Data Chapter 4 shown on the time-series chart. The tabs at the top of the Selected list represent the Y-axes that are shown in our chart. For example, if our chart contains two Y-axes, there will be two tabs at the top of the Reporting Tags Selected list. Since we have just created this time-series there is only one tab. For this tutorial, let’s chart the FactoryTalk Historian Classic Demo – Flow Rate reporting tag. 1.
Chapter 4 Analyzing FactoryTalk Historian Classic Data TIP Step 5: Customize the Chart Legend If you want to use the Configuration Console to chart a calculation that is unique to your process, see "Customizing RSBizWare Charts and Tables (page 87)". 1. Click the Legend tab. This tab enables you to specify the type of legend that will be shown on the time-series chart. For this tutorial, accept the default Authoring Legend option.
Analyzing FactoryTalk Historian Classic Data Chapter 4 users will not be able to change pen colors, line thicknesses, or other chart styles. The Authoring Legend is a table that contains the properties of the chart that you specify here. Users of your report will be able to customize their view of the chart by changing the values associated with these properties. This legend provides the maximum amount of flexibility for your report users. 2.
Chapter 4 Analyzing FactoryTalk Historian Classic Data you make a change to the settings on the Time Selection toolbar, you must click Refresh to view the change. is used to show all data that has • The All Times button ever been collected, without specifying the start and end times. This is especially useful if you do not know the start and end date for which data has been collected. • The Time Range button enables you to specify the start and end times to which the data will be restricted.
Analyzing FactoryTalk Historian Classic Data Chapter 4 When you save your report, the settings that you specified on the Time Selection toolbar during report authoring will be saved with the chart. These become the defaults for runtime users and they are also used when you schedule the report object to be run at a later date. Scheduling report objects and reports is discussed in Advanced Reporting Topics (page 97).
Chapter 4 Analyzing FactoryTalk Historian Classic Data 1. Click the chart in the report work area and select View > Properties from the main menu. The Configure Time-Series Report Object dialog box will appear again. 2. First, let’s remove the analysis tool that we added before. We will not need it for this example. Select the FactoryTalk Historian Classic Demo – Flow Rate reporting tag that has the mean analysis tool added to it and click the < button to remove it from the Reporting Tags Selected list.
Analyzing FactoryTalk Historian Classic Data Chapter 4 5. Click the General tab. You will notice that there are now two tabs at the top of the Reporting Tags Selected list. The Y2 tab represents the second Y-axis on the chart. Click the Y2 tab. 6. In the Reporting Tags Available list on the left, locate the FactoryTalk Historian Classic Demo– Flow Rate reporting tag and click the > button to add the reporting tag to the Y2 tab. Now add the SUM analysis tool.
Chapter 4 Analyzing FactoryTalk Historian Classic Data You will notice that the Y1 axis is shown to the left of the chart and the Y2 axis is shown to the right of the chart and that the value ranges for the two lines are very different. If you had placed the SUM tool on the same Y-axis with the Flow Rate, the large range of values for the SUM tool would have distorted the FactoryTalk Historian Classic Demo – Flow Rate line, making it appear deceptively flat, as shown below.
Analyzing FactoryTalk Historian Classic Data Chapter 4 time-series chart in order to see how the batch performed as compared to other similar batches or perhaps compared to an ideal batch. NOTE This example is for simple batch reporting only. For more information on setting up the batch parameter data collection, refer to the Rockwell Automation knowledgebase article titled “Simple Batch Reporting using RSBizWare Historian 5.0.
Chapter 4 Analyzing FactoryTalk Historian Classic Data 6. in this Legend list. Select the three User Fields in the Fields in this Legend list and use the arrow buttons to move these fields up so that they immediately follow the Reporting Tag and Units fields. 7. To display the relative time of each batch, repeat the same procedure to add the Relative Time Start and Relative Time End fields to the Authoring Legend. Use the arrow buttons to position these fields after User Field 3. 8.
Analyzing FactoryTalk Historian Classic Data Chapter 4 Batch ID field. If the selected value for a batch parameter field is enough to identify the batch uniquely—as is the case with the Batch ID field for the XYZ100 batch—the fields that follow will be filled in for you. TIP The first batch selected will drive the time axis (X-axis) on the time-series chart.
Chapter 4 Analyzing FactoryTalk Historian Classic Data annotation will enable you to supply information about this spike to other report users. NOTE Value Comments You must have the Add Time-Series Comment application-level privilege to perform tag annotation. An Author license is not required. A value comment is a comment that is associated with a specific value within a reporting tag. The value comment provides an explanation of why the value of a process parameter has deviated from the norm.
Analyzing FactoryTalk Historian Classic Data Chapter 4 3. Enter the text of your comment, which is restricted to 255 characters. 4. Click OK to save your comment and close the dialog. The comment is saved in the reporting tag along with the date/time when the comment was added and the ID of the user who entered the comment. On future displays of this reporting tag, a numbered yellow marker will indicate the annotated value.
Chapter 4 Analyzing FactoryTalk Historian Classic Data 2. The Timestamp field will default to a date and time nearest to where you right-clicked in the time-series chart. Select the exact date and time to which you want the X-axis comment to be applied. 3. Use the lists in the Line Properties area to specify the color, style, and thickness of the line that will be used to indicate your start of batch. 4. Enter the text of your comment, which is restricted to 255 characters. 5.
Analyzing FactoryTalk Historian Classic Data Chapter 4 2. The Value field will default to the value nearest to where you right-clicked in the time-series chart. Select the exact value to which you want the Y-axis comment to be applied. 3. Because time-series charts can have multiple Y-axes, you will be able to associate this comment with a specific Y-axis. Select the Y-axis with which you want to associate your comment. 4.
Chapter 4 Analyzing FactoryTalk Historian Classic Data Ad Comment As While the ability to add comments is restricted by an application-level privilege, the Add Comment As menu item will be enabled for all users. The Add Comment As feature allows a second user to add comments without ending the first user’s Configuration Console or Quick Web session.
Analyzing FactoryTalk Historian Classic Data Chapter 4 In this example, the name is My Company Report. The name of the file and its location is displayed on the title bar of the Configuration Console. You now have two copies of the report: one saved as an .htm file, and the other stored in the Information Services Manager. The .htm file contains text and some RSBizWare ActiveX controls. You can edit it in an HTML editor.
Chapter 4 Analyzing FactoryTalk Historian Classic Data 86 Rockwell Automation Publication HIST-UM001K-EN-E-June 2014
Chapter 5 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 Historian Classic Author license.
Chapter 5 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 5 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 5 Customizing RSBizWare Charts and Tables 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. To access the property page for a chart component: 1.
Customizing RSBizWare Charts and Tables Chapter 5 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. Your RSBizWare report must be in design mode in order to be modified. NOTE Show and Hide Columns 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.
Chapter 5 Customizing RSBizWare Charts and Tables 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. Resize Table Columns When you add a column to a table, it is assigned the default width.
Customizing RSBizWare Charts and Tables Chapter 5 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. On the Styles tab, in the Style drop-down list select Interactive Grid. 5. Click OK to return to the Report Object Properties dialog box. 6. Click OK to return to the report design mode.
Chapter 5 Customizing RSBizWare Charts and Tables To remove the aggregate function from a column, right-click the column header, and then click Aggregate > None. Group To group by field, right-click the column header, and then click Grouping > Group 1. The table records are grouped by the selected column. Each time you click Grouping in the shortcut menu for additional columns, additional group numbers are added to the menu. This allows you to group by as many columns as displayed in your table.
Customizing RSBizWare Charts and Tables Chapter 5 NOTE Chart You can also sort the data by clicking the column header; however, the new sorting order will not be saved when you save your table. To change the axis on which the chart is graphed, right-click the column header, and then click Chart > X-axis. To clear the chart axis, right-click the column header, and then click Chart > None. Rename To rename a column: 1. Right-click the column header, and then click Rename.
Chapter 5 Customizing RSBizWare Charts and Tables 96 Rockwell Automation Publication HIST-UM001K-EN-E-June 2014
Chapter 6 Advanced Reporting Topics In this chapter you will learn about the following: • The Excel Add-in 97 • Scheduling Report Objects and Reports 101 • Analyzing Non-RSBizWare Data 110 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.
Chapter 6 Advanced Reporting Topics 2. Type the name of the Information Services Manager to which your Excel workbook will connect. 3. Type the port number that you want to use for RSBizWare HTTP communications. The default number is 8080. NOTE Please contact your RSBizWare administrator for the specific port number that you should use. 4. Click OK to save your changes and close the dialog box.
Advanced Reporting Topics Chapter 6 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 6 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 100 .
Advanced Reporting Topics Chapter 6 The Report Name List dialog box appears. 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 6 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 6 For this example, type Workcell Production Scheduled Task. 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.
Chapter 6 Advanced Reporting Topics The Delivery Method wizard page appears. 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.
Advanced Reporting Topics Chapter 6 12. Click Finish. 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 6 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 6 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 6 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 6 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 6 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 6 Create a Report Data Source 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. Refer to "Analyzing FactoryTalk Historian Classic Data (page 41)" for instructions on creating reports.
Chapter 6 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 6 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 6 Advanced Reporting Topics 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. Your table has a separate column for each reporting tag.
Advanced Reporting Topics Chapter 6 • 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. If you have selected an existing table, for each database field under Column assign a value from the Time-series Use column. 24. Click Next.
Chapter 6 Advanced Reporting Topics Step 2: Give the Report Data The Report Data Source Name page of the wizard appears. Source a Name To name the report data source: 1. On the Report Data Source Name page, enter the name that you will use to refer to your report data source in the application. The name must be unique among all report data sources. 2. (Optional) To define other users' permissions related to your report data source, click Permissions.
Advanced Reporting Topics Chapter 6 Step 3: Select a Database Table or View The Choose a Database Table or View page (shown below) allows you to specify the database table or view to which the report data source is providing a connection. 1. Select the name of the external data source that contains the table or view. In the example above, the Coffee Datalog Data external data source was selected. 2.
Chapter 6 Advanced Reporting Topics 1. Highlight the column names that you want to make available to the user and click the Add (>) button to move the column names to the Columns in Report Data Source list. 2. Columns that have been added to the Columns in Report Data Source list can be renamed so the names are more meaningful to users. To rename a column, select the column name in the list and click the Rename button. The name is highlighted to indicate that it is ready to be changed.
Advanced Reporting Topics Chapter 6 4. Enter a name for your new field and type the expression or SQL statement that will be evaluated to produce the derived field. 5. Click the Validate button to check for errors. 6. Click Add to return to the Report Data Source wizard. Your derived field will be displayed in the Columns in Report Data Source list. 7. Click Next to continue.
Chapter 6 Advanced Reporting Topics 1. The drop-down list contains all timestamp fields that you selected to include in the report data source. To enable the Time Selection toolbar for your report data source, select the timestamp field on which the Time Selection query will be run. 2. Click Next to continue. Step 6: Specify the Format of The Time-series Format page allows you to specify whether the table is going to be used for time-series analysis (as shown below).
Advanced Reporting Topics Chapter 6 1. Select the option that best describes your database table or view. • Select the Table is not in a time-series format option if the table does not contain time-series data. This will disable time-series analysis and FactoryTalk Transaction Manager time-series data collection for the report data source. • Select the Narrow Format option if the reporting tag values are stored in a single column of the table.
Chapter 6 Advanced Reporting Topics NOTE If you selected the “not a time-series” option, the wizard will skip steps 7 and 8. The Review Results page will display a summary of the new report data source that will be created. Review your selections and click Finish to create the report data source. Step 7: Specify the Role That This step displays the Match Time-series Columns page. In this step, you will need to specify the role that each database field plays in Each Field Plays In time-series analysis.
Advanced Reporting Topics Chapter 6 Step 8: Create a Data Point Configuration Table The final step of the wizard contains the Data Point Configuration Table page shown below. Here you set up the data point configuration table, which is a database table that contains descriptive information about the reporting tags, including a reporting tag ID field, a reporting tag description field, and an engineering unit field.
Chapter 6 Advanced Reporting Topics be created. Review your selections and click Finish to create the report data source. NOTE 124 If the underlying database table or view changes after you create your report data source, you must recreate the report data source to take advantage of the changes.
Chapter 7 Creating RSBizWare Custom Analysis Tools An RSBizWare custom analysis tool is a user-defined plug-in to the Configuration Console that allows you to develop custom computations that operate on time-series data. The result of the custom analysis tool computations then can be displayed on a time-series chart. Why Use Custom Analysis Tools? The Configuration Console ships with several standard statistical analysis tools.
Chapter 7 Creating RSBizWare Custom Analysis Tools • If you plan to develop custom analysis tools, we recommend that you read the next three sections of this chapter followed by the section that describes how to develop a custom analysis tool using your chosen development tool. NOTE If you will be using a development tool other than Visual Basic or Visual C++, make sure you read the RSBizWare Calculator COM Interface section.
Creating RSBizWare Custom Analysis Tools Registering a Sample Analysis Tool Chapter 7 Before you can use a custom analysis tool, you must first register it with the Configuration Console by doing the following: 1. Select Tools > FactoryTalk Historian Classic > Analysis Tools from the main menu. The Configure Custom Analysis Tools dialog box, shown below, is displayed. This dialog box enables you to manage the custom analysis tools that are registered on your machine.
Chapter 7 Creating RSBizWare Custom Analysis Tools 4. If the DLL has not yet been registered with the Windows operating system, the Configuration Console will offer to do this for you. Click Yes. 5. You will then return to the Configure Custom Analysis Tool screen where you will see all custom analysis tools that are present in the DLL you chose. You will see how the analysis tools get their names in the development sections.
Creating RSBizWare Custom Analysis Tools Chapter 7 following the analysis tool name. That is a global unique identifier (GUID), which is what Microsoft Windows uses to identify software components uniquely. You can ignore the GUID. NOTE If you select a DLL, EXE, or OCX file that does not contain a valid custom analysis tool, you will see the following message: “The selected file is not a valid Analysis Tool (it does not contain a type library).
Chapter 7 Creating RSBizWare Custom Analysis Tools You will see that the Visual Basic project contains only one file–a Visual Basic class named VbFlatCalculatorClass. The section on developing a custom analysis tool with Visual Basic will detail the steps necessary to develop a custom analysis tool, but you will notice that the name of the class in Visual Basic is the name that is used in the Configuration Console to display the custom analysis tool.
Creating RSBizWare Custom Analysis Tools Chapter 7 you can register multiple custom analysis tool DLLs with a Configuration Console. Each custom analysis tool will show up under the Analysis Tool list associated with each reporting tag selected for use within a reporting object. To create a custom analysis tool, you need to implement a single COM interface published by Rockwell Automation: RSBizWare::IRSBizWareCalculator.
Chapter 7 Creating RSBizWare Custom Analysis Tools What a Time-series Data Set Usually, RSBizWare custom analysis tools are used to analyze time-series data sets. Before looking in-depth at how to build a Looks Like custom analysis tool, it is essential to understand what a time-series data set looks like, as you will need to interpret the parameters that will be passed into your Calculate() function.
Creating RSBizWare Custom Analysis Tools Chapter 7 Calculate() function you develop. The following table shows an example of what an RSBizWare time-series data set looks like. Data point Timestamp Min value Max value Sample count Pressure Pressure Pressure Pressure Pressure Pressure 2000-06-20 07:00:00 2000-06-20 08:00:00 2000-06-20 09:02:00 2000-06-20 10:03:00 2000-06-20 11:04:00 2000-06-20 12:05:00 7.5 8.3 8.5 9.5 13.4 17.5 8.3 9.5 9.5 13.4 17.5 16.
Chapter 7 Creating RSBizWare Custom Analysis Tools • Count input array–This array contains double precision floating point values, which are the counts of the number of samples for each X-axis sample of the data set. When the Information Services Manager determines that sampling is not required, the counts will be 1. When implementing the Calculate() function, your job is to fill up two output parameters which will contain the X and Y values of your custom analysis tool algorithm.
Creating RSBizWare Custom Analysis Tools Chapter 7 tool), the Configuration Console automatically generated a COM Category entry for the analysis tool for you. Looking at the Type Library As mentioned in "Analysis Tool Architecture (page 130)", developing an RSBizWare custom analysis tool requires you to implement a specific COM interface called RSBizWare::IRSBizWareCalculator.
Chapter 7 Creating RSBizWare Custom Analysis Tools The RSBizWare::IRSBizWareCalculator interface requires you to implement a function called Calculate(). COM uses the Interface Definition Language (IDL) to describe the syntax of functions in a language independent manner.
Creating RSBizWare Custom Analysis Tools Creating a New Project Chapter 7 To create a new custom analysis tool in Visual Basic, do the following: 1. Start the Visual Basic application. 2. If the New Project dialog box is not automatically displayed, select File > New Project from the Visual Basic menu. 3. Select ActiveX DLL from the list on the New Project dialog box and click OK. You will be placed in the Visual Basic code editor with a default project name and a default class name created for you. 4.
Chapter 7 Creating RSBizWare Custom Analysis Tools Referencing the RSBizWare Calculator Component Next, you must specify to Visual Basic that you are going to be implementing an RSBizWare custom analysis tool as follows: 1. Add a reference to a COM or ActiveX object in Visual Basic by selecting Project >References. 2. In the References dialog box, scroll down the list of all registered COM interfaces until you see the RSBizWareCalculator 1.0 Type Library. Select it and click OK. 3.
Creating RSBizWare Custom Analysis Tools Chapter 7 carriage returns and line continuation characters were added to this code for readability.
Chapter 7 Creating RSBizWare Custom Analysis Tools 2. Change the Y values to negative values. This task would be simple if you were dealing with single data points; however, you have to take sampling into consideration because the passed in data set may be sampled. If it is, the program must contain an algorithm to determine the value to make negative.
Creating RSBizWare Custom Analysis Tools Chapter 7 2. To compile your project, select File > Make MyDemo.dll. You will be prompted for a directory to save the DLL to. As far as the Configuration Console is concerned, it does not matter where the DLL resides on the machine, so pick the directory of your choice. Once you have saved and compiled your project for the first time, you should change the Version Compatibility of the project as follows: 1. Select Project > MyDemo Properties.
Chapter 7 Creating RSBizWare Custom Analysis Tools Your report object should look like this: If the name of your custom analysis tool in the Configuration Console is not what you expected (MyDemo.NegativeCalculator), then you may not have renamed the default project or class name in the Visual Basic project. If you did not rename these, then your analysis tool may be named Project1.Class1. You can go back to Visual Basic, change the names, and recompile your project.
Creating RSBizWare Custom Analysis Tools Chapter 7 After the debugging settings are complete, you can set one or more breakpoint in your Visual Basic Calculate() function. When you then run the project, the Configuration Console will start up. Create a time-series chart using the analysis tool you are debugging (you may have to first register the analysis tool if you haven't yet). When the chart calls the analysis tool, your breakpoints should be called in Visual Basic.
Chapter 7 Creating RSBizWare Custom Analysis Tools develop the C++ analysis tool should require no other distribution DLLs. • Decreased Memory Usage. The Visual Basic MSVBVM60.DLL adds a considerable memory footprint to a custom analysis tool. The Visual C++ custom analysis tools are very memory efficient and, with no dependencies, they require loading no other DLLs. • Increased Performance.
Creating RSBizWare Custom Analysis Tools Chapter 7 (DLL) option. Leave the check boxes at the bottom of the screen cleared as shown in the example. 5. Click Finish and then click OK on the next screen. Visual C++ will create the shell of the project for you. You now have an empty COM DLL from which you can build the analysis tool.
Chapter 7 Creating RSBizWare Custom Analysis Tools 3. Specify NegativeCalc as the short name of this class. Filling in the Short Name field will fill in default values for the rest of the fields on the screen. 4. Click OK to complete the creation of the class. Visual C++ then will create a new empty COM class. 5.
Creating RSBizWare Custom Analysis Tools Working with VARIANTs in Visual C++ Chapter 7 Visual C++ supports the VARIANT data type, but VARIANTs are not handled as elegantly in Visual C++ as they are in Visual Basic. When RSBizWare is installed, a set of C++ source code files that contain utility functions are also installed. In the Variant.cpp file, there are functions that are useful when handling VARIANT data types.
Chapter 7 Creating RSBizWare Custom Analysis Tools VARIANT *varray); You will use these utility functions when you write the Calculate() function in the next section. Writing the Calculate() Function Writing the Calculate() function (contained in the NegativeCalc.h file) in Visual C++ involves the same basic steps described in the Visual Basic section: 1. Accessing the passed in data set from the Configuration Console. 2. Computing the desired algorithm. 3.
Creating RSBizWare Custom Analysis Tools Chapter 7 The first thing the program must do is check that valid output pointers were passed into the Calculate() function. The following code is created automatically for Calculate() function by Visual C++: if (xOutArray == NULL) return E_POINTER; if (yOutArray == NULL) return E_POINTER; To complete the Calculate() function, do the following by adding the specified code to the function (contained in the NegativeCalc.h file): 1.
Chapter 7 Creating RSBizWare Custom Analysis Tools double *yMaxIn = new double[yMaxSize]; double *countIn = new double[countInSize]; // Integer to hold data values int actualNum; // Convert VARIANT arrays to non-VARIANT arrays bool xInRet = ExtractVariantDoubleArray(&xInArray, xIn, xInSize, &actualNum); bool yMinRet = ExtractVariantDoubleArray(&yMinInArray, yMinIn, yMinInSize, &actualNum); bool yMaxRet = ExtractVariantDoubleArray(&yMaxInArray, yMaxIn, yMaxSize, &actualNum); bool countInRet = ExtractVariant
Creating RSBizWare Custom Analysis Tools Chapter 7 // to caller CreateVariantDoubleArray(xOut, xInSize, xOutArray); CreateVariantDoubleArray(yOut, xInSize, yOutArray); 6. Having completed the data algorithm, the only thing left to do is to clean up the temporary variables used during the computations. Make sure that you use the array delete operator (delete[]) when deleting the temporary arrays, otherwise your custom analysis tool will leak memory each time it is run.
Chapter 7 Creating RSBizWare Custom Analysis Tools 3. Include Register.h before the class definition in the NegativeCalc.h header file (by adding an #include “Register.h” statement to the NegativeCalc.h header file). Before compiling the project, you need to alter the project settings as follows: 1. Select Project > Settings. 2. On the dialog, select Win32 Release MinDependency from the Settings For list at the top of the dialog box. 3.
Creating RSBizWare Custom Analysis Tools Chapter 7 • After the custom analysis tool is debugged, it should be recompiled in non-debug mode for production use and distribution. There are several choices of non-debug compilation in Visual C++. You should select the Win32 Release MinDependency compilation mode. This minimizes the dependencies of the compiled DLL so you don't have to ship any other DLLs with the custom analysis tool. To compile the project, select Build > Rebuild All.
Chapter 7 Creating RSBizWare Custom Analysis Tools Debugging Custom Analysis Tools in Visual C++ If your custom analysis tool does not work in the Configuration Console the first time, you may need to debug your Calculate() function. The easiest way to do this is to use the Visual C++ debugger when running the Configuration Console as follows: 1. Select Project > Settings from the menu. 2. On the Project Settings dialog box shown below, select the Debug tab.
Creating RSBizWare Custom Analysis Tools Why Use Custom Analysis Tools? Chapter 7 The RSBizWare installation creates a directory structure that contains samples and utility files that are useful when creating custom analysis tools. The directory contents are described below. • \RSBizWare Calculators: This is the root directory of the Calculator SDK on the DVD.
Chapter 7 Creating RSBizWare Custom Analysis Tools 156 Rockwell Automation Publication HIST-UM001K-EN-E-June 2014
Chapter 8 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 8 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 8 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 8 Object Permissions 160 Rockwell Automation Publication HIST-UM001K-EN-E-June 2014
Index Customizing Text Report Objects 90 A A Quick Tour of a Sample Custom Analysis Tool 126 Ad Comment As 84 Add a Comment to a Value, X-axis, or Y-axis on a Time-series Chart 79 Add a Saved Report Object to Your Report 45 Advanced Reporting Topics 97 Aggregate 93 Aggregate, Group, Format, Sort, Chart, and Rename Columns 92 Analysis Tool Architecture 130 Analyzing FactoryTalk Historian Classic Data 41 Analyzing Non-RSBizWare Data 110 C Changing Chart Component Properties 90 Chart 95 Collecting FactoryTal
Index L Limitations 134 Load the Report From File 85 Looking at the Type Library 135 M Moving a Component 89 N New Product Satisfaction Return 164 O Object Permissions 157 Organize FactoryTalk Historian Classic Reporting Tags 36 Q Quick Filter 95 R Referencing the RSBizWare Calculator Component 138, 145 Registering a Sample Analysis Tool 127 Rename 95 Report data source permissions 159 Report object permissions 159 Report permissions 158 Resize Table Columns 92 Resizing a Component 89 Rockwell Automat
Index Name the Report Object 66 Select the Fields To Be Charted 55 Specify the Format of the Table or View 120 Step 7 Adjust the Time Range 71 Enter the Chart Title 56 Filter the Data 66 Specify the Role That Each Field Plays In Time-Series Analysis 122 Step 8 Create a Data Point Configuration Table 123 Filter the Data 56 Insert Your New Table Into the Report 66 Step 9 Insert Your New Chart Into the Report 59 Remove a Reporting Tag or an Analysis Tool 76 T The Excel Add-in 97 The Plant Model 19 The Report
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.
