SYSTEM VERSION 6.

ABB Ability™ System 800xA

Information Management
Getting Started
SYSTEM VERSION 6.1

ABB Ability™ System 800xA

Information Management
Getting Started

Document Number: 3BUF001091-610

Document Revision: A
Release: February 2019

Trace back information Main Publication:

Tool version: 5.2.025
Build date: 2019-02-05 at 12:24:42
Domain: ABBPA
Workspace, version, checked in: 800xA Main, a210, 2019-02-05
Master: ix-344646-Information Management Getting Started.xml
Recipe: ix-363870-6.1_Information Management Getting Started.rcp
PDF stylesheet: ix-315381-PDF-Stylesheet.xml
Customer stylesheet: ix-315380-CustomerStylesheet.xml
Notice
This document contains information about one or more ABB products and may include a description of or a reference
to one or more standards that may be generally relevant to the ABB products. The presence of any such description of
a standard or reference to a standard is not a representation that all of the ABB products referenced in this document
support all of the features of the described or referenced standard. In order to determine the specific features supported
by a particular ABB product, the reader should consult the product specifications for the particular ABB product.

ABB may have one or more patents or pending patent applications protecting the intellectual property in the ABB
products described in this document.

The information in this document is subject to change without notice and should not be construed as a commitment
by ABB. ABB assumes no responsibility for any errors that may appear in this document.

Products described or referenced in this document are designed to be connected, and to communicate information and
data via a secure network. It is the sole responsibility of the system/product owner to provide and continuously ensure
a secure connection between the product and the system network and/or any other networks that may be connected.

The system/product owners must establish and maintain appropriate measures, including, but not limited to, the
installation of firewalls, application of authentication measures, encryption of data, installation of antivirus programs,
and so on, to protect the system, its products and networks, against security breaches, unauthorized access, interference,
intrusion, leakage, and/or theft of data or information.

ABB Ltd and its affiliates are not liable for damages and/or losses related to such security breaches, any unauthorized
access, interference, intrusion, leakage and/or theft of data or information.

ABB verifies the function of released products and updates. However system/product owners are ultimately responsible
to ensure that any system update (including but not limited to code changes, configuration file changes, third-party
software updates or patches, hardware change out, and so on) is compatible with the security measures implemented.
The system/product owners must verify that the system and associated products function as expected in the environment
they are deployed.

In no event shall ABB be liable for direct, indirect, special, incidental or consequential damages of any nature or kind
arising from the use of this document, nor shall ABB be liable for incidental or consequential damages arising from use
of any software or hardware described in this document.

This document and parts thereof must not be reproduced or copied without written permission from ABB, and the
contents thereof must not be imparted to a third party nor used for any unauthorized purpose.

The software or hardware described in this document is furnished under a license and may be used, copied, or disclosed
only in accordance with the terms of such license. This product meets the requirements specified in EMC Directive
2014/30/EU and in Low Voltage Directive 2014/35/EU.

Trademarks
All rights to copyrights, registered trademarks, and trademarks reside with their respective owners.

Copyright © 2019 by ABB.

All rights reserved.
Table of Contents

Table of Contents

About this User Manual

User Manual Conventions ................................................................................. 9
Warning, Caution, Information, and Tip Icons ...................................... 10
Terminology ....................................................................................................... 10
Released User Manuals and Release Notes .................................................... 10

1 Introduction
1.1 Information Locations ........................................................................................ 13
1.2 Section Overviews ............................................................................................ 15

2 Configuring Basic Functionality

2.1 Verifying Installation of Information Management ............................................. 18
2.2 Log-In User Authority ........................................................................................ 19
2.3 Building a Process Simulation ........................................................................... 20
2.4 Configuring SoftPoints ...................................................................................... 20
2.4.1 Set-up Requirements for SoftPoints .................................................... 20
2.4.2 Adding a New SoftPoint Object Type ................................................... 25
2.4.3 Configuring the SoftPoint Object Type ................................................. 27
2.4.4 Adding a Signal .................................................................................... 27
2.4.5 Configuring Signal Properties ............................................................. 28
2.4.6 Configuring Alarm Trip Points .............................................................. 31
2.4.7 Adding a Signal to Support the Calculation Logic ................................ 34
2.5 Applying the Calculation .................................................................................... 35
2.5.1 Specify that the Calculation be Copied to Instantiated SoftPoints ....... 40
2.6 Instantiating and Deploying SoftPoints ............................................................. 41
2.6.1 Deploying a SoftPoint Configuration .................................................... 46
2.6.2 Enabling the Calculations .................................................................... 47

3BUF001091-610 A 5
Table of Contents

2.7 Collecting and Viewing Historical Data ............................................................. 49

2.7.1 Configuring Node Assignment for Trend Logs ..................................... 50
2.7.2 Creating a Log Template ...................................................................... 52
2.7.3 Adding a Log Configuration Aspect to an Object ................................. 63
2.7.4 Viewing Historical Data using DataDirect System 800xA Toolbar ....... 79
2.7.5 Alarm/Event Data ................................................................................. 82

3 Report and Scheduling for Operations

3.1 Creating a History Report using DataDirect System 800xA Toolbar ................. 86
3.2 Creating a Process Value Report using DataDirect System 800xA Toolbar ..... 88
3.3 Creating an Alarm and Event Report using DataDirect System 800xA Toolbar
........................................................................................................................... 91
3.4 DataDirect Report Templates for Scheduler ...................................................... 93
3.5 Adding Report Parameters for User-defined Template ..................................... 94
3.6 Attaching Report Templates to File Viewer Aspects ......................................... 95
3.7 Scheduling a Report .......................................................................................... 96

4 Reports and Scheduling

4.1 Use of Log Template ......................................................................................... 104
4.2 Creating a User-defined Report Template using DataDirect System 800xA ..... 104
4.3 Adding Parameters to User-defined Report Templates using DataDirect System
800xA ................................................................................................................ 109
4.4 Creating a Simple History Report using ODBC and ODA ................................. 110
4.5 Adding Parameters to the History Report ......................................................... 116
4.6 Creating a Real-Time Report with Excel ........................................................... 124
4.7 Creating a History Report with Crystal Reports ................................................ 130
4.8 Attaching Report Templates to File Viewer Aspects ......................................... 133
4.9 Scheduling a Report ..........................................................................................134
4.10 Historizing a Report ...........................................................................................141
4.11 Alternative Tag Query ........................................................................................142
4.11.1 Create Workbook (Spreadsheet) ......................................................... 143
4.11.2 Configure Bulk Import Filter ................................................................. 143
4.11.3 Fill Workbook ....................................................................................... 144

3BUF001091-610 A 6
Table of Contents

4.11.4 Customize Report (Sheet) ................................................................... 144

5 Configuring Additional Functionality

5.1 Configuring a Message Log .............................................................................. 145
5.1.1 Message Log Configuration Procedure ............................................... 146
5.1.2 Specify Message Log Operating Parameters ...................................... 148
5.1.3 Reading the Message Log ................................................................... 148
5.2 Configuring Historical Data Archiving ................................................................152
5.2.1 Adding an Archive Device ....................................................................153
5.2.2 Adding the Archive Group Object ........................................................ 157
5.2.3 Adding Archive Groups ........................................................................ 158
5.2.4 Setting Up the Archive Schedule for an Archive Group ....................... 160
5.3 Accessing Archive Data .................................................................................... 164
5.3.1 Publishing an Archive Volume ............................................................. 165
5.3.2 Accessing Published Logs .................................................................. 166
5.3.3 Viewing Published Archive Data with DataDirect ................................ 170
5.3.4 Unpublishing a Volume ........................................................................ 170
5.4 Inform IT Authentication .................................................................................... 171
5.4.1 Configuring Access Control ................................................................. 171
5.4.2 Checking Access Control .....................................................................172

6 Batch Integration
6.1 PDL for Batch Management Overview .............................................................. 174
6.2 Configure Information Management for Batch .................................................. 175
6.2.1 Add Batch Specific Message Log ........................................................ 175
6.2.2 Set Up the Batch Report Job ............................................................... 175
6.2.3 Set Up Batch Archive ...........................................................................176
6.3 Configure Batch for Information Management .................................................. 177
6.3.1 Adding Equipment and Variables ......................................................... 177
6.3.2 Adding Recipe Procedure .................................................................... 178
6.3.3 Run the Batch From the Batch Overview ............................................ 182
6.3.4 Verify Output using PDL Browser ........................................................ 183
6.4 Viewing the Executed Batch Report ..................................................................183

3BUF001091-610 A 7
Table of Contents

6.5 Additional Lessons ............................................................................................ 184

6.5.1 Views for Batch Management .............................................................. 184
6.5.2 Creating Reports using Typical Queries and Views. ............................ 184
6.5.3 Batch Archiving .................................................................................... 185
6.5.4 Looping Recipe Limitations ..................................................................186
6.5.5 User Message Formats ....................................................................... 188

Revision History ..................................................................................................... 189

Index .......................................................................................................................... 191

3BUF001091-610 A 8
About this User Manual
User Manual Conventions

About this User Manual

The System 800xA Safety AC 800M High Integrity Safety Manual (3BNP004865*)
must be read completely by users of 800xA High Integrity. The recommendations
and requirements found in the safety manual must be considered and implemented
during all phases of the life cycle.
Any security measures described in this user manual, for example, for user access,
password security, network security, firewalls, virus protection, and so on, represent
possible steps that a user of an 800xA System may want to consider based on a risk
assessment for a particular application and installation. This risk assessment, as well
as the proper implementation, configuration, installation, operation, administration,
and maintenance of all relevant security related equipment, software, and procedures,
are the responsibility of the user of the system.
This user manual provides basic instructions for configuring Information Management
functionality for the 800xA System. This includes:
• Configuring basic functionality using softpoints and calculations to build a process
simulation and History Services to collect numeric process data.
• Using reports and scheduling to view the simulation data.
• Additional functionality such as archiving.
This instruction is intended for application engineers who are responsible for configuring
and maintaining these applications. This instruction is not the sole source of instruction
for this functionality. It is recommended that you attend the applicable training courses
offered by ABB.

User Manual Conventions

Microsoft Windows conventions as defined in the Microsoft Manual of Style are normally
used for the standard presentation of material when entering text, key sequences,
prompts, messages, menu items, screen elements, and so on.

3BUF001091-610 A 9
About this User Manual
Terminology

Warning, Caution, Information, and Tip Icons

This user manual includes Warning, Caution, and Information where appropriate to
point out safety related or other important information. It also includes Tip to point out
useful hints to the reader. The corresponding symbols should be interpreted as follows:

Electrical warning icon indicates the presence of a hazard that could result in electrical
shock.

Warning icon indicates the presence of a hazard that could result in personal injury.

Caution icon indicates important information or warning related to the concept

discussed in the text. It might indicate the presence of a hazard that could result in
corruption of software or damage to equipment/property.

Information icon alerts the reader to pertinent facts and conditions.

Tip icon indicates advice on, for example, how to design your project or how to use
a certain function.

Although Warning hazards are related to personal injury, and Caution hazards are
associated with equipment or property damage, it should be understood that operation
of damaged equipment could, under certain operational conditions, result in degraded
process performance leading to personal injury or death. Therefore, fully comply with
all Warning and Caution notices.

Terminology
A complete and comprehensive list of terms is included in System 800xA Terminology
and Acronyms (3BSE089190*). The listing includes terms and definitions that apply to
the 800xA System where the usage is different from commonly accepted industry standard
definitions.

Released User Manuals and Release Notes

A complete list of all User Manuals and Release Notes applicable to System 800xA is
provided in System 800xA Released User Documents (3BUA000263*).
System 800xA Released User Documents (3BUA000263*) is updated each time a
document is updated or a new document is released.

3BUF001091-610 A 10
About this User Manual
Released User Manuals and Release Notes

It is in pdf format and is provided in the following ways:

• Included on the documentation media provided with the system and published to
ABB Library and myABB/My Control System portal when released as part of a major
or minor release or System Revision.
• Published to ABB Library and myABB/My Control System portal when a User Manual
or Release Note is updated in between any of the release cycles listed in the first
bullet.

3BUF001091-610 A 11
3BUF001091-610 A 12
1 Introduction
1.1 Information Locations

1 Introduction

This instruction provides a series of tutorials that show you how to go from staring blankly
at your installed Information Management software to building and using real-world
Information Management applications. This instruction does not cover every application
in complete detail. This is left for the standard documentation which is readily available
on CD and online via the ABB Library or myABB/My Control System.

1.1 Information Locations

Table 1.1 lists the instructions and the specific information they contain concerning
Information Management.

Table 1.1: Information Management Documentation

Document Number Document Title Topics
3BSE034678* System 800xA Manual Basic system and Information Management
Installation installation
3BSE041389* System 800xA System Information Management planning and
Planning considerations
3BUA000156* System 800xA Post Post installation steps for configuring the
Installation Information Management server
3BUF001091* System 800xA Information Configuration tutorial covering:
Management Getting • Numeric Logs
Started
• SoftPoints
• Calculations
• Reporting
• Archiving
• Batch Management

3BUF001091-610 A 13
1 Introduction
1.1 Information Locations

Table 1.1: Information Management Documentation

(Continued)
Document Number Document Title Topics
3BUF001092* System 800xA Information Configuring SoftPoints
Management Configuration Configuring calculations
Configuring the history database
Configuring production data and message logs
Configuring archiving
Configuring ODBC connectivity
History database maintenance (Backup and
restore)
3BUF001093* System 800xA Information AdvaInform display servers
Management Configuration Display creation
for Display Services
Display operation
Scripting language
3BUF001094* System 800xA Information Inform IT Excel Data Access (DataDirect)
Management Data Access System 800xA Excel Data Access (DataDirect)
and Reports
Desktop trends
Report scheduling
General scheduling
User tag management utility
Reading and managing archives
Message logs and tables
Production data log tables
Numeric tables
ODBC connectivity

3BUF001091-610 A 14
1 Introduction
1.2 Section Overviews

1.2 Section Overviews

Section 2 Configuring Basic Functionality describes how to:
• Verify your system installation. This lesson gives a quick run-down of installation
and set-up requirements that are sometimes overlooked and must be in place before
beginning to use Information Management software.
• Build a process simulation. This lesson describes how to simulate a live process
with SoftPoint and Calculation Services. The purpose of this exercise is to provide
moving data points to serve as data sources for historical data collection. Similar
data sources could be constructed in Control Builder M.
• Collect and view historical data. This lesson describes how to use History Services
to collect numeric process data, and then view this information using various desktop
data access tools including DataDirect (Excel Data Access).
Section 4 Reports and Scheduling provides a series of tutorials that describe how to
use:
• DataDirect reports (Creating a User-defined Report Template using DataDirect
System 800xA on page 104).
• History reports using Excel (Creating a Simple History Report using ODBC and ODA
on page 110).
• Report parameters (Adding Parameters to the History Report on page 116).
• Real-time reports using Excel (Creating a Real-Time Report with Excel on page
124).
• Crystal reports (Creating a History Report with Crystal Reports on page 130).
• File Viewer aspects (Attaching Report Templates to File Viewer Aspects on page
133).
• Scheduling reports (Scheduling a Report on page 134).
• Historizing reports (Historizing a Report on page 141).
Section 5 Configuring Additional Functionality provides a series of tutorials that describe
how to:
• Configure an Information Management message log for extending online storage
and offline archival.
• Configure archiving for process (numeric) and alarm/event data.
• Publish an archive volume and read archived data.
• Configure authentication to help meet FDA 21CFR part 11 requirements.

3BUF001091-610 A 15
1 Introduction
1.2 Section Overviews

Section 6 Batch Integration describes how to:

• Populate the Production Data Log for a batch recipe and create logs as a result of
using batch start/end, phase start/end, and so forth. This includes the use of:
– Task Variables
– History Association
– Message Log and PDL Log association
• Pass parameters from the Batch Recipe to the Schedule argument structure and
into the report.
• Create reports using typical queries and views.
• Define batch archiving and aging of the online data.
These activities are designed to follow the flow of information from Batch Management
into the Information Manager, out to reports and finally the safe off line storage of the
Batch Production Data in an archive.

3BUF001091-610 A 16
2 Configuring Basic Functionality

2 Configuring Basic Functionality

Upon completion of this tutorial you will be able to use SoftPoint and Calculation Services
to simulate a live process, configure History Services to collect process and alarm/event
data from the SoftPoints, and view the data using Information Management desktop
tools. Mostly, base 800xA System functionality is used in this part of the tutorial. Any
extended Information Management functionality is identified to show the benefits of using
extended methods.
To meet these objectives you will:
• Use the Information Management Configuration Assistant to ensure that you have:
– met the minimum system requirements.
– installed all required software.
– performed all required post-installation procedures.
• Use the SoftPoint and Calculation Services to build a process simulator that produces
moving data points. These data points will serve as data sources for historical logs
configured in History Services.
• View historical data using DataDirect.
The system architecture for this tutorial is illustrated in Figure 2.1.

3BUF001091-610 A 17
2 Configuring Basic Functionality
2.1 Verifying Installation of Information Management

Figure 2.1: System Architecture for this Tutorial

2.1 Verifying Installation of Information Management

Use the Information Management Configuration Assistant to ensure you have completed
all procedures required to install and set up an Information Management server (if used).
If you find that any of these requirements have not been met, then return to the installation
and post installation activities for an Information Management server.
To launch the assistant, from the Windows task bar, choose:
ABB Start Menu > ABB System 800xA > Information Mgmt > IM Configuration
Assistant
Check the Status column for both Prerequisite Software and Information Management
Configuration (Figure 2.2). All statuses should be Complete.

3BUF001091-610 A 18
2 Configuring Basic Functionality
2.2 Log-In User Authority

Figure 2.2: Configuration Assistant

2.2 Log-In User Authority

This tutorial requires creating object types in the Aspect Directory. To do this, log in as
a user belonging to the IndustrialITAdmin user group.
Use the SAME user that installed the Information Management software. New users
are required to add DataDirect and Bulk Import add-ins to Microsoft Excel. These
procedures are covered in the operation and configuration books for Information
Management.

3BUF001091-610 A 19
2 Configuring Basic Functionality
2.3 Building a Process Simulation

2.3 Building a Process Simulation

The purpose of this exercise is to provide moving data points to serve as the data sources
for historical data collection.
SoftPoint Services is used to configure and use internal process variables not connected
to an external physical process signal. Once configured, the SoftPoints may be accessed
by other 800xA system applications as if they were actual process points.
Each SoftPoint object will have:
• An integer signal driven by a calculation that counts from 0 to 100 and back to 0.
• Historical data for each signal collected by a property log configured in History
Services.
• A second integer signal used to support the calculation logic.
• High and low limits will be configured for the signals so that alarms will be generated.
These alarms will be collected by the system message services and may be viewed
via alarm and event list aspects for the SoftPoint signal objects.
As an option, a message log may be configured in History Services for extended online
storage and offline archival of alarm/event data. This is described in another lesson in
Section 5 Configuring Additional Functionality.

2.4 Configuring SoftPoints

SoftPoint objects are instantiated from SoftPoint object types configured in the Object
Type Structure. The object types are templates from which the actual SoftPoint objects
are instantiated.

2.4.1 Set-up Requirements for SoftPoints

SoftPoints are instantiated in the Control Structure under a SoftPoint Generic Control
Network object. This object establishes the connection with a specific SoftPoint server.
Configuration of the SoftPoint Generic Control Network and related objects is completed
as a post installation procedure and should already be done (refer System800xA 6.0
Post Installation (2PAA111693*)). This will automatically configure the following:
• SoftPoint service group object and service provider object(s).
• Virtual control network by which other system applications (History, desktop
applications and so on) can access the SoftPoint data on that node.

3BUF001091-610 A 20
2 Configuring Basic Functionality
2.4 Configuring SoftPoints

• Source Definition aspect for each network. This is used to deploy the SoftPoints on
their respective nodes.
• Integrates the SoftPoint alarm and event messages into the 800xA system message
service.
Before beginning this tutorial, confirm that this configuration has been completed. If this
setup is complete, skip to Adding a New SoftPoint Object Type on page 25.

Open the Workplace

Use the Plant Explorer workplace to access the Structure Selector.
1. From the Windows task bar choose:
ABB Start Menu > ABB System 800xA > System > Workplace.
2. Select Plant Explorer Workplace, and click Open. The initial view of the Plant
Explorer Workplace shows the 800xA system objects and aspects within their
structural organization.
3. Use the Structure drop-down list in the upper left part of the Plant Explorer (Figure
2.3), to select the Control Structure.

Figure 2.3: Plant Explorer Initial View - Selecting Control Structure

Configuring SoftPoint Services

1. In the Control Structure, select the Root, Domain and choose New Object from
the context menu. This displays the New Object dialog.
2. Expand the Object Types category, and select SoftPoint Generic Control Network
(under SoftPoint Basic Object Types). Enter a name to identify the network (for
example: SoftPoint), then click Create.

3BUF001091-610 A 21
2 Configuring Basic Functionality
2.4 Configuring SoftPoints

3. Select the Generic Control Network Configuration aspect of the new object and
click on the Configure tab as shown in Figure 2.4.

Figure 2.4: Generic Control Network Configuration Aspect

4. Click the Server Settings Configure button (Figure 2.4).

3BUF001091-610 A 22
2 Configuring Basic Functionality
2.4 Configuring SoftPoints

5. Select the primary Connectivity Server Node where SoftPoints is installed (Figure
2.5), and click OK.

Figure 2.5: Choose Connectivity Server Node (Primary)

6. Click OK at the configuration completed message. The configuration of the server

settings for a non-redundant SoftPoint network is complete (Figure 2.6).

Figure 2.6: Generic Control Network Configuration (Primary Server)

7. Click the Server Settings Configure button again if redundant connectivity servers
were created.

3BUF001091-610 A 23
2 Configuring Basic Functionality
2.4 Configuring SoftPoints

8. Check the box Node is redundant provider and then select the redundant
Connectivity Server Node where SoftPoints is installed (Figure 2.7) and click OK.

Figure 2.7: Choose Connectivity Server Node (Redundant)

9. Click OK at the configuration completed message. The configuration of the server

settings for a redundant SoftPoint network is complete.

Integrating SoftPoint Alarms and System Messages

In order for the system message service to collect alarms and events from the SoftPoints
on this network, the ABB 800xA Soft Alarms OPC Server must be added to an Event
Collector, Service.
This is done automatically when the Alarm and Event Settings part of the Generic Control
Network Configuration aspect is configured:
1. Click the Alarm and Event Settings Configure button (Figure 2.6).
2. Add providers in the same way was done for the Server Settings.

3BUF001091-610 A 24
2 Configuring Basic Functionality
2.4 Configuring SoftPoints

2.4.2 Adding a New SoftPoint Object Type

Create an object type template. This template will be used to instantiate SoftPoint objects
into the Control Structure under the SoftPoint Generic Control Network object.
1. Open the Object Type Structure using the Structure selector.
2. Select SoftPoint Object Types and choose New Object from the context menu as
shown in Figure 2.8.

Figure 2.8: Creating a New SoftPoint Object Type

3BUF001091-610 A 25
2 Configuring Basic Functionality
2.4 Configuring SoftPoints

3. In the New Object dialog (Figure 2.9) select SoftPoint Process Object Type, assign
a name to the new object (Counter in this example), then click Create.

Figure 2.9: New Object Dialog, Counter

3BUF001091-610 A 26
2 Configuring Basic Functionality
2.4 Configuring SoftPoints

2.4.3 Configuring the SoftPoint Object Type

Add an integer signal type via the Process Object Configuration aspect (Figure 2.10):
1. Select the new SoftPoint object type in the Object browser (left hand pane).
2. Then click on the Process Object Configuration aspect in the object’s aspect list
(right hand pane).

Figure 2.10: Configuring the New Object Type

2.4.4 Adding a Signal

The Add Signal buttons are located in the upper left part of the SoftPoint Process Object
Configuration aspect as shown in Figure 2.11.

Figure 2.11: Add Signal Buttons

3BUF001091-610 A 27
2 Configuring Basic Functionality
2.4 Configuring SoftPoints

To add the integer signal type,

1. Click the Integer signal button.
2. Enter a meaningful name in the New Signal Type dialog, for example Count (Figure
2.12).
3. Click OK.

Figure 2.12: New Signal Type Dialog, Count

2.4.5 Configuring Signal Properties

Signal properties that may be configured include range (high/low limits), engineering
units label, and whether or not the signal should be controllable.

3BUF001091-610 A 28
2 Configuring Basic Functionality
2.4 Configuring SoftPoints

To configure signal properties:

1. With the new signal type selected, click the Signal Configuration aspect (Figure
2.13).

Figure 2.13: Displaying the SoftPoint Signal Configuration Aspect

2. The signal must be made controllable to let the calculation drive the signal value.
To make a signal controllable, click the Controllable tab, and then click the Is
Controllable check box (Figure 2.14), and then click Apply.
For this tutorial, DO NOT check the Log operator actions check box. This would
cause every signal value change to be logged as an event (calculation updates to
SoftPoints are treated as operator actions).

Figure 2.14: Making the Signal Controllable

3BUF001091-610 A 29
2 Configuring Basic Functionality
2.4 Configuring SoftPoints

3. To set limits for signal, click the Range tab, key in the required limits, and click
Apply. In the example shown in Figure 2.15, the Low limit is 0 and the High limit is
100.

Figure 2.15: Setting the High and Low Limits

3BUF001091-610 A 30
2 Configuring Basic Functionality
2.4 Configuring SoftPoints

2.4.6 Configuring Alarm Trip Points

SoftPoint limiters are trip points in the signal’s overall range that, when crossed, generate
an alarm and/or an event. These will be recorded in the system message services. Up
to eight limiters can be specified for a signal. To do this (reference Figure 2.16):
1. With the signal type selected in the left pane, select the Alarm Event Configuration
aspect.

3BUF001091-610 A 31
2 Configuring Basic Functionality
2.4 Configuring SoftPoints

2. On the Limiter tab, select 1 Limiter1 and enable the Use Limiter option. This
activates the limiter configuration fields.

Figure 2.16: SoftPoint Limiters Configuration Aspect

Reference Figure 2.17 for Step 3. through Step 6..

Figure 2.17: Adding a Limiter

3. The name defaults to Limiternumber. Rename the limiter to make it more easily
identifiable, for example: CountHigh.

3BUF001091-610 A 32
2 Configuring Basic Functionality
2.4 Configuring SoftPoints

4. Specify the Type to indicate whether the limiter will trigger an event when the signal
rises above a maximum value (Max), or drops below a minimum value (Min).
5. Enter a Limit. This is the threshold that the signal must cross to trip an alarm (drop
below if type is Min, or exceed if type is Max).
The Hysteresis may be set to filter spurious alarms caused by signals that fluctuate
around the limit. This is optional and is not covered here.
6. Click Apply.
7. Repeat Step 2. through Step 6. to configure up to four limiters. An example of a
completed limiter list is shown in Figure 2.18.
Summary:
• CountHigh, Max, 95
• CountMidHigh, Max, 90
• CountMidLow, Min, 10
• CountLow, Min, 5

Figure 2.18: Example, Completed Limiter List

The limiter can be deactivated by selecting the limiter and unchecking the Use limiter
option.

3BUF001091-610 A 33
2 Configuring Basic Functionality
2.4 Configuring SoftPoints

To enable the alarms for this signal:

1. Check the Is an event option on the Event tab.
2. Select a limiter signal and check Is an alarm (Figure 2.19) on the Alarm tab. Repeat
this for each limiter. Then click Apply.

Figure 2.19: Enabling Alarms for this Signal

2.4.7 Adding a Signal to Support the Calculation Logic

The calculation logic that drives the Count signal value requires an integer variable whose
value is set to 1 or -1, depending on whether the signal value is being increased or
decreased. This is implemented by adding an integer signal to the SoftPoint object, and
then writing the integer value (1 or -1) from the calculation.
1. Select the Counter, SoftPoint Process Object Type as shown in Figure 2.10.
2. Select the Process Object Configuration aspect.
3. Use the Add Integer Signal button (Figure 2.11).

3BUF001091-610 A 34
2 Configuring Basic Functionality
2.5 Applying the Calculation

4. Give this signal the name upDown as shown in Figure 2.20.

Figure 2.20: New Signal Type Dialog, UpDown

5. Configure signal properties to make the signal controllable as demonstrated in Figure

2.14 and Figure 2.15.

2.5 Applying the Calculation

Add a Calculation aspect to the SoftPoint object type to drive the SoftPoint’s Count signal
value and thus simulate a live process. By adding the aspect to the object type, the
Calculation may be applied to each object instance that is created from the object type.
To begin (reference Figure 2.21):
1. Select the Counter object type and choose New Aspect from the context menu.
2. In the New Aspect dialog select the Calculation aspect.
3. Enter a meaningful name, for example: CountUpDown, then click Create.

Figure 2.21: Adding a Calculation Aspect

3BUF001091-610 A 35
2 Configuring Basic Functionality
2.5 Applying the Calculation

4. Click on the Calculation aspect to display its configuration view (Figure 2.22).

Figure 2.22: Displaying the Calculation Aspect View

3BUF001091-610 A 36
2 Configuring Basic Functionality
2.5 Applying the Calculation

5. Use the variable grid (top part of aspect view) to map calculation variables to their
respective OPC data points (in this case the Count and upDown SoftPoint signals
are mapped to the Value property), Figure 2.23. Both are declared as Output
variables so the calculation will update the signal values each time the calculation
executes.

Figure 2.23: Mapping Variables

a. Use the Insert Line button on the tool bar to add a line in the variable grid (Figure
2.24). Two variables are required: OutputVar and upDown.

Figure 2.24: Insert Line Button

Complete the mapping as shown in Figure 2.23 and as described below.

b. Declare an output Variable named OutputVar and upDown as shown in Figure
2.23. Use the Object and Property columns to specify the signal’s Value property
as a data point to be updated by the calculation.
c. Specify the Object as a relative object reference (./). Relative referencing allows
the same calculation to be used for multiple object instances without having to
change object references. Check case sensitivity to ensure the correct object
is referenced.
d. Select the Property from the pull-down list. The contents of this list is based on
the object specified.
e. Select the Direction as Output from the pull-down list. Output values are written
to the property AFTER the calculation has executed. Output values are also
available for use in the script as it executes.
f. Set the State to Online for both signals.
g. Enter an initial Offline Value of 1 for OutputVar and -1 for upDown.

3BUF001091-610 A 37
2 Configuring Basic Functionality
2.5 Applying the Calculation

6. Enter the calculation script as shown in Figure 2.25. This script ramps the Count
value up to 100 and then back to 0.

Figure 2.25: Calculation Script

7. Click the Editor/Scheduler toggle button on the toolbar to change the view to
Scheduler. This is used to specify either a cyclic schedule, or a time-based schedule.
For this tutorial, specify a cyclic schedule (Figure 2.26).

Figure 2.26: Change to Scheduler Button

3BUF001091-610 A 38
2 Configuring Basic Functionality
2.5 Applying the Calculation

8. Check the Cycle check box. In the corresponding fields specify the interval unit
(hours, minutes, seconds), and the number of intervals. The example in Figure 2.27
shows a 2-second cycle. This will cause the calculation to execute, and the Count
signal value to change, every two seconds.

Figure 2.27: Cyclic Schedule

3BUF001091-610 A 39
2 Configuring Basic Functionality
2.5 Applying the Calculation

9. Save the calculation configuration by clicking the Save button on the tool bar (Figure
2.28).

Figure 2.28: Save Button

The Calculation Editor View does not prompt the user when exiting and changes are
pending. Use Save button before leaving the display.

10. Check whether or not the calculation is working by manually executing the calculation
off line. To do this, click the test off line button a few times (Figure 2.29). If the
calculation is working. The Offline Value for the OutputVar variable will be
incremented or decremented by one each time the button is clicked.

Figure 2.29: Test Off Line

2.5.1 Specify that the Calculation be Copied to Instantiated SoftPoints

Even though the calculation aspect was added to an object type, the calculation will not
be copied into the instantiated objects created from the object type unless this functionality
is specified. To do this (reference Figure 2.30):
1. Go to the Counter Type Definition aspect for the SoftPoint object type.
2. Click the Aspect Control tab.
3. Select the Calculation category, in this case: CountUpDown.

3BUF001091-610 A 40
2 Configuring Basic Functionality
2.6 Instantiating and Deploying SoftPoints

4. Check the box labeled Copy to all instances.

5. Click Apply.

Figure 2.30: Type Definition Aspect

The calculations must be enabled once they have been instantiated in the Control
Structure. How to instantiate the SoftPoints and then enable the calculations is covered
in the following sections.

2.6 Instantiating and Deploying SoftPoints

SoftPoint objects are instantiated in the Control Structure. The objects can be created
one-object-at-a-time or a bulk instantiation of a specified number of objects of the same
object type can be performed. This section demonstrates the bulk instantiation method.
To do this (reference Figure 2.31):

3BUF001091-610 A 41
2 Configuring Basic Functionality
2.6 Instantiating and Deploying SoftPoints

Figure 2.31: Selecting the SoftPoint Process Objects Group

1. Go to the Control Structure using the Structure selector.

2. Select the SoftPoint Generic Control Network object in the Control Structure, and
click the Generic Control Network Configuration aspect.
3. Click the Create New Object button in the top left corner of this aspect view. This
displays the Create New Object dialog (Figure 2.32).

3BUF001091-610 A 42
2 Configuring Basic Functionality
2.6 Instantiating and Deploying SoftPoints

4. Select the Counter SoftPoint object type from which to instantiate the new SoftPoint
objects as shown in Figure 2.32.

Figure 2.32: Create New Object Dialog

5. Create 10 new objects with a starting number of 1 and enter the object name, in this
case counter.

3BUF001091-610 A 43
2 Configuring Basic Functionality
2.6 Instantiating and Deploying SoftPoints

6. Click OK. The result is shown in Figure 2.33. A unique name is created for each
new object consisting of the basic name plus a sequential numeric suffix starting
with the specified Starting number.

Figure 2.33: Bulk Instantiation Result

7. After creating new objects in the Control Structure, rename all the Count and
upDown SoftPoint Signal types with the parent object name as the prefix. For
example, rename Count and upDown SoftPoint Signal type under Counter1
SoftPoint object type, as Counter1 Count and Counter1 upDown respectively.
Repeat the same for all the Count and upDown SoftPoint Signal types under
Counter2 to Counter10 SoftPoint objects instantiated. Refer to Figure 2.34.

3BUF001091-610 A 44
2 Configuring Basic Functionality
2.6 Instantiating and Deploying SoftPoints

Figure 2.34: Renaming Count and upDown SoftPoint Signal types

3BUF001091-610 A 45
2 Configuring Basic Functionality
2.6 Instantiating and Deploying SoftPoints

2.6.1 Deploying a SoftPoint Configuration

Whenever new SoftPoint objects are created, or changes to existing SoftPoint objects
made, the new configuration will not go into effect until the changes are deployed. While
SoftPoint configurations are being deployed, SoftPoint processing is suspended, current
values and new inputs are held. This process is generally completed within five minutes,
even for large configurations. To do this (reference Figure 2.35):
1. In the Control Structure, select the SoftPoint Generic Control Network object for
the node where the SoftPoints will be deployed.
2. Select the Deploy aspect.

Figure 2.35: Deploying the SoftPoint Configuration

3BUF001091-610 A 46
2 Configuring Basic Functionality
2.6 Instantiating and Deploying SoftPoints

3. Click the Deploy button to start the deploy process. Completion of the deploy
process is indicated by the Deploy ended message, Figure 2.36.

Figure 2.36: Deploy Ended Indication

2.6.2 Enabling the Calculations

The calculations will not execute until they have been assigned to a Calculations service
provider and enabled. Use the Calculation Status Viewer.
To do this (reference Figure 2.37):
1. Open the Service Structure using the Structure selector.
2. Select the Calculation Server, Service.
3. Select the Calculation Status Viewer aspect.

3BUF001091-610 A 47
2 Configuring Basic Functionality
2.6 Instantiating and Deploying SoftPoints

4. Select the calculations in the viewer and choose Service from the context menu.

Figure 2.37: Enabling Calculations via the Calculation Status Viewer

5. Use the dialog to select a service group (Figure 2.38) and click OK.

Figure 2.38: Selecting a Service Provider

3BUF001091-610 A 48
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

6. Select the calculations in the viewer and choose Enable from the context menu as
shown in Figure 2.39.

Figure 2.39: Enabling the Calculations

7. This completes the SoftPoint/calculation configuration.

2.7 Collecting and Viewing Historical Data

Basic History and Information Management History Services collect and store historical
information for the process. Desktop Tools is used to view the historical data. Property
logs collect data from user-specified numeric (floating point or integer) aspect object
properties. For this tutorial, the property logs will be configured to collect integer values
from the SoftPoint signals.
The property log structure is used to integrate the basic History trending function and
Information Management history logs.
The trend log collects directly from an OPC data source; in this case, a SoftPoint signal.
The trend log resides on an 800xA system connectivity server and supports storage and
viewing of operator trend data.
Information Management History logs support extended storage and advanced historical
data management functionality including offline storage.
An example is shown in Figure 2.40. For this tutorial, the Connectivity and Information
Management servers reside on the same node.

3BUF001091-610 A 49
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

Figure 2.40: Example, Property Log Hierarchy

Historical collection and viewing for the SoftPoint signal is implemented by:
1. Defining a history source for the SoftPoints in the Control Structure (Configuring
Node Assignment for Trend Logs).
2. Creating a Log Template in the Library Structure.
3. Adding a Log Configuration Aspect to an Object.
4. Viewing Historical Data using DataDirect System 800xA Toolbar.

2.7.1 Configuring Node Assignment for Trend Logs

Trend logs require a History Source aspect to specify the connectivity server where the
logs will reside. The History Source aspect must be located above the objects where the
log configurations will be added.
For this tutorial, the logs will be collecting from SoftPoints residing on a SoftPoint generic
control network in the Control Structure. Therefore, add the History Source as an aspect
of the SoftPoint generic control network object.
This is illustrated in Figure 2.41.

3BUF001091-610 A 50
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

Figure 2.41: Using One History Source

To add a History Source aspect:

1. Open the Control Structure using the Structure selector.
2. Select SoftPoint Generic Control Network object in the Control Structure and
choose New Aspect from the context menu.
3. Select the History Source aspect in the New Aspect dialog, then click Create,
(Figure 2.42).

Figure 2.42: Adding History Source Aspect

3BUF001091-610 A 51
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

4. Select the History Source aspect, then use the Service Group pull-down list to select
the Service Group for the node on which the SoftPoint generic control network is
configured (Figure 2.43).
5. Click Apply.

Figure 2.43: Configuring the History Source

2.7.2 Creating a Log Template

The log template establishes the log hierarchy and data collection scheme for the property
logs which will be instantiated from the template.
1. Open the Library Structure using the Structure selector and select History Log
Templates, History Log Templates Library.
2. Select Default Templates, History Log Templates Library and choose New Object
from the context menu (Figure 2.44).
3. Select History Log Template in the New Object list, enter a name for the log
template object that identifies the template. The name shown in Figure 2.44 indicates
the template is for a log configuration that will collect samples at 10-second intervals,
store one week of data in a trend log, and 52 weeks in a history log.

3BUF001091-610 A 52
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

4. Click Create.

Figure 2.44: Adding a Log Template Object

3BUF001091-610 A 53
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

5. Select the new log template object in the left-hand browser and click on the Log
Template aspect. This displays the aspect’s configuration view for building the log
hierarchy and specifying data collection parameters (Figure 2.45).
The hierarchy starts with the Property Log placeholder which represents the data
source (the object property for which data will be collected). All component logs in
the hierarchy (trend and history) will be added under the Property Log placeholder.

Figure 2.45: Display the History Log Template Configuration View

3BUF001091-610 A 54
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

Adding a Direct Trend Log

The first log in the hierarchy is a trend log which collects directly from an OPC source
(in this case, a SoftPoint signal). This log will support storage and viewing of operator
trend data, and will serve as the source for the Information Management log. To add the
trend log:
1. Select the Property Log to highlight it and click Add.
2. From the New Log Template dialog (Figure 2.46) select OPC from the Source
pull-down list. The Log Type defaults to Direct. The Collector Link option is NOT
applicable for direct trend logs.
This log must be added as a Direct Log Type which means it will collect directly
from an OPC data source.

Figure 2.46: New Log Template Dialog

3BUF001091-610 A 55
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

3. Click OK when finished. This displays the configuration view for the direct trend log.
This configuration view has two tabs as shown in Figure 2.47.

Figure 2.47: Basic History Trend Log Configuration View - Log Definition Tab

While the default log name (Log1) may be retained, it is recommended that the log
be renamed to help operators when browsing for logs to view.

3BUF001091-610 A 56
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

4. Use the Log Definition tab to specify a log name (Figure 2.48). Use a name that
helps you recognize the function this log will perform. For example, the name in
Figure 2.48 identifies the log as a trend log with a one-week storage size.

Figure 2.48: Specifying a Name for the Trend Log

5. Click the Data Collection tab and then configure the Storage Interval and Storage
Size attributes. Figure 2.49 shows how to configure the log to collect samples at
10-second intervals, and hold up to one week of data.
If the Max Time check box is selected, the value of the Max Time should be greater
than the Min Time.

Figure 2.49: Data Collection Configuration for the Trend Log

It is also possible to add a direct log by right clicking the Property Log and selecting
Add Log > OPC from the context menus (Figure 2.50).

3BUF001091-610 A 57
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

Figure 2.50: Adding a Direct Log

3BUF001091-610 A 58
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

Adding a Hierarchical History Log

Add a hierarchical Information Management log under the direct trend log. This log will
collect from the direct trend log. It will extend the storage capacity, and support other
advanced data collection/storage functions. To add this log:
1. Select the direct log and click Add.
This displays the New Log Template dialog for a hierarchical log type. The log type
defaults to Hierarchical.
2. Check Linked in the Collector Link area, and then choose IM History Log from the
Server Type pull-down list, as shown in Figure 2.51.

Figure 2.51: Configuring a Hierarchical Information Management-type Log

3. Click OK when finished.

It is also possible to add a hierarchical Information Management log by right clicking
the direct log and selecting Add Log > IM History Log from the context menus
(Figure 2.52).

3BUF001091-610 A 59
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

Figure 2.52: Adding a Hierarchical Log to the Direct Log

3BUF001091-610 A 60
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

Configuring an Information Management Log

The log configuration view for Information Management-based history logs has four tabs
(refer to Figure 2.53). Most of the log attributes on these tabs have valid default values,
or are not mandatory to complete the configuration.
1. Use the Log Definition tab to specify a Log Name and Service Group.
The Service Group pull-down list contains all History servers defined in the Aspect
System. This list may be used to specify the server where this log will reside. The
list defaults to the local node. This is suitable for this tutorial.

Figure 2.53: History Log - Log Definition Tab

3BUF001091-610 A 61
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

2. Click on the Data Collection tab (Figure 2.54). For this example, this log needs to
collect samples at 1-minute intervals and store 52 weeks worth of data. To do this:
a. Configure the Sample Interval to establish the base sample rate as 10 Seconds.
Set the Storage Interval to the same value. The Sample Blocking Rate defaults
to a multiple of the Sample Interval, in this case, 1 Hour. This determines the
interval at which samples collected by the trend log will be forwarded to the
history log.
b. Enter the Log Period: 52 Weeks. This determines the Log Capacity (log capacity
= log period * storage interval).
It is strongly recommended that the defaults be used for the calculation algorithm
(Store As Is or Instantaneous do not use a calculation) and storage type. It is generally
not necessary to use calculations for data collection. Desktop tools is used to perform
calculations during data retrieval.

Figure 2.54: Data Collection Tab

3. Click Apply when finished with both the trend and history log configurations. This
completes the template configuration. (Deadband is not being configured for this
tutorial.)

3BUF001091-610 A 62
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

2.7.3 Adding a Log Configuration Aspect to an Object

Property logs are instantiated on their respective objects (in this case, SoftPoint signals)
by adding and configuring a log configuration aspect for each object. The log configuration
aspect specifies the object property whose values will be logged, and also specifies the
log template that will establish the log structure, data collection parameters, and other
log attributes.
There are two methods for adding a log configuration aspect to an object.
• Add the aspect via the Plant Explorer. This is the easiest method for adding log
configuration aspects to just one or two objects.
• Use the Bulk Configuration add-ins in Microsoft Excel (extended Information
Management functionality). This is the recommended method for adding a large
number of log configuration aspects, especially when the aspects are being
instantiated from the same Log Configuration Template.
This section first demonstrates how to add a log configuration aspect to one object via
the Plant Explorer, and then shows how to add the remainder of the Log Configuration
aspects using the Bulk Configuration tool.
The first aspect does not have to be added via the Plant Explorer in order to use the
Bulk Configuration tool. This method is included in this tutorial to show how to add a
single Log Configuration aspect using base system functionality.

Using the Plant Explorer

For this tutorial the log configuration aspects are being added to the Count Signal objects
for the SoftPoint objects created in Building a Process Simulation on page 20. Reference
Figure 2.55 for Steps 1-3 below:
1. Open the Control Structure using the Structure selector.
2. Navigate to the first Counter SoftPoint object under the SoftPoint Object group.

3BUF001091-610 A 63
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

3. Expand the object tree for the object, select the Count Signal and choose New
Aspect from the context menu.

Figure 2.55: Adding a History Aspect to a SoftPoint Signal Object

This displays the New Aspect dialog.

3BUF001091-610 A 64
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

4. Select the Log Configuration aspect (Figure 2.56). Click Create (there is generally
no advantage to renaming this aspect).

Figure 2.56: Selecting the Log Configuration Aspect

This adds the Log Configuration aspect to the object’s aspect list.

3BUF001091-610 A 65
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

5. Click the log configuration aspect in the object’s aspect list to display the configuration
view (Figure 2.57).

Figure 2.57: Log Configuration Aspect Added to the Object’s Aspect List

The Logged Properties pane shows the name of the selected OPC object where
the log configuration aspect has been added.

3BUF001091-610 A 66
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

6. Select the OPC object name and choose Add Property Log from the context menu
(or click the Add Property Log button). Refer to Figure 2.58.

Figure 2.58: Adding a Property Log

This displays the New Property Log dialog (Figure 2.59). This dialog is used to select
one of the object’s properties for which to collect data. This dialog also is used to
select the template to establish the log hierarchy and data collection scheme.
7. From the Property list, select the Value property.
8. Select the Log_10s_1W_52W template from the Template list.
9. Click OK when finished.

Figure 2.59: New Property Dialog

3BUF001091-610 A 67
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

The instantiated log configuration for Counter1 Count based on the selected property
and log template is shown in Figure 2.60.

Figure 2.60: Instantiated Log Configuration

3BUF001091-610 A 68
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

The status light indicates whether or not the log is connected to a history source.
Green indicates good connection. Red indicates bad or no connection. If the light
is red, check the History Source configuration (Configuring Node Assignment for
Trend Logs on page 50).
1. Click Apply to create the log (log state is Inactive).
2. Select the History Log and then click the IM Definition tab (Figure 2.61).
3. Click Activate to activate the log. This will cause the log stat to change to active.

Figure 2.61: Activating a Log

This aspect does not require any further configuration. Some adjustments to the
configuration can be made via the aspect view for each component log in the property
log hierarchy; however, this procedure is not covered (nor is it required) in this tutorial.
Confirm that the log is properly configured and operational by selecting a log, for example
Trend1Wk, selecting the Status tab, and then clicking Read, Refer to Figure 2.62.
Data will not be available in the history log (History52Wk) until the interval specified
by the sample blocking rate has elapsed. The default for this log configuration is 20
minutes. It is also possible to add a hierarchical Information Management log by right
clicking the direct log and selecting Add Log > IM History Log from the context menus
(Figure ).

3BUF001091-610 A 69
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

Figure 2.62: Confirming Log Operation

Finish adding log configuration aspects using the Bulk Configuration tool as described
in the following procedure.

Using the Bulk Configuration Tool

This procedure describes how to use the Bulk Import tool in DataDirect (Microsoft Excel)
to instantiate log configuration aspects for their respective signals. This tool is used to
instantiate a large quantity of property logs without having to use the Plant Explorer. This
can substantially reduce the time spent configuring logs.
If multiple property log configurations are created using the Bulk Import tool and
Industrial IT Basic History and Information Management logs stop collecting follow
these steps:
1. Locate the Basic History Service Providers for the log configurations just created.
2. Restart these Basic History Service Providers located in step a.

3BUF001091-610 A 70
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

To configure property logs with the Bulk Configuration tool:

1. Launch Microsoft Excel and create a new workbook.
If you are logged on as a different user than the one that installed the Information
Management software, then add the Bulk Import add-ins to Excel for that user. Learn
about configuring Property Logs in System 800xA Information Management
Configuration (3BUR001092*).
The first time an Excel Worksheet is opened with the add-ins, a prompt to enable
macros may be displayed. Macros MUST be enabled (click the Enable macros button)
in order to use the add-in tools.
2. To set up the workbook for bulk configuration, choose Bulk Import > Initialize
Sheet, Figure 2.63. Click OK to delete all sheet data.

Figure 2.63: Initializing the Workbook for Bulk Configuration

This adds row and column headings related to bulk configuration. Also, a dialog is
provided for connecting to a system, Figure 2.64.

3BUF001091-610 A 71
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

3. Click Set System to connect the spreadsheet to the Aspect System as indicated in
the Select a System dialog.

Figure 2.64: Initialized Workbook

4. Import a list of object properties for which historical data will be collected - in this
case the Value property of the Count SoftPoint signals. It is recommended that an
import filter be applied so the import list can be limited to just those object properties
needed. This minimizes the duration of the import operation and makes it easier to
work with the Bulk Configuration tool.
A filter can be specified based on object name, aspect, and property as shown in
Figure 2.65. This filter limits the list of returned properties to Value properties for all
Integer PCA aspects in all Objects whose name pattern fits *Count.
Object = *Count (* is a wild card character string)
Aspect = Integer PCA
Property = NAME:Value

Figure 2.65: Specifying an Import Filter

3BUF001091-610 A 72
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

5. Once the filter is specified, choose Bulk Import > Load Sheet from System, Figure
2.66. This displays the Object Browser dialog.

Figure 2.66: Loading the Spreadsheet with Object Properties

6. Use the Object Browser to select the root object, in this case, the SoftPoint Generic
Control Network object created in Adding a New SoftPoint Object Type on page 25.
This establishes the starting point where the importer will begin looking for properties
to add to the list.

3BUF001091-610 A 73
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

7. Check the Include child objects, Include Logged Properties, and Include All
Properties check boxes, Figure 2.67. This tells the importer to include in the search
all child objects under the SoftPoint Generic Control network object (SoftPoint and
SoftPoint signal objects).

Figure 2.67: Selecting the SoftPoint Process Object Group

3BUF001091-610 A 74
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

8. Click Add. The import result is shown in Figure 2.68.

Note that the log configuration aspect created is also in the list. This is because the
Include Logged Properties check box was selected.

Figure 2.68: Import Filter Result

3BUF001091-610 A 75
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

9. For this tutorial, all logs will use the same log template and log configuration aspect
name.
Every object property to be logged must have a property log template that meets
the data collection requirements of the object property. Also, the name of the log
configuration aspect must be specified.
These parameters are already specified for the Counter 1 object to which the log
configuration aspect was added (refer to Using the Plant Explorer). Make these
specifications for the remaining objects as described below.
• Use the log template specified for the Counter 1 object property to apply the
same template to any number of contiguous properties in the list by clicking the
bottom right corner of the Property Template cell and pulling down to highlight
the Property Template column for other contiguous properties, Figure 2.69. The
template specification will be entered in the highlighted cells when the mouse
button is released.

Figure 2.69: Applying Property Log Specification to Contiguous Object Properties

The Bulk Configuration tool supports other methods to specify the log template and
log configuration aspect name for the first object property in the list when a Log
Configuration aspect is not added via the Plant Explorer. The alternatives are:
• entering the name directly if it is known.
• using the template list dialog (available via the context menu).
These methods are not covered in this tutorial.
• Use the same Log Configuration aspect name for all object properties in the
list by copying the Log Configuration cell into the other rows in the list in the
same manner as the property template.

3BUF001091-610 A 76
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

• Save the spreadsheet using a unique name.

It is recommended that the spreadsheet be saved before running the Bulk
Configuration function. This will enable Excel to be exited without losing the
configuration data in the event of a problem. Give the sheet a unique name. If Excel
is opened using DataDirect, DO NOT save the sheet using the default name.
DataDirect opens the default spreadsheet whenever DataDirect is opened.
10. Once the log template and log configuration aspect definitions have been filled in,
run the Bulk Configuration utility to update the log aspects from the spreadsheet.
To do this, choose Bulk Import > Update Log Aspects from Sheet, Figure 2.70.

Figure 2.70: Updating Log Aspects from the Sheet

3BUF001091-610 A 77
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

11. When prompted to confirm this action, click OK to complete the update, Figure 2.71
and then close the Bulk Import tool.

Figure 2.71: Confirm Update

12. Verify that Log Configuration aspects have been added to the specified signals by
returning to the Control Structure, looking at the aspect list for one of the signals,
and checking for the presence of a Log Configuration aspect.
The log operation may also be confirmed by selecting a log, selecting the Status
tab, and clicking Read, Figure 2.72.

Figure 2.72: Confirming that Log Configuration Aspects Have Been Added

3BUF001091-610 A 78
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

2.7.4 Viewing Historical Data using DataDirect System 800xA Toolbar

The Status tab on the Log Configuration aspect is a quick way for verifying log operation
and viewing log data. This section shows how to use DataDirect (Excel Data Access)
for more extensive viewing and reporting capability from the desk top. The following
tutorial shows how to read the SoftPoint values stored in the corresponding history logs:
Launch DataDirect from Excel.
DataDirect integrates add-in tools into Microsoft Excel.
DataDirect add-ins to Excel may need to be added if a different user than the one
that installed the Information Management software is logged in.
Follow the procedure below to add DataDirectSystem800xA msi:
Choose File> Options > Add-Ins and then click Go. Check the DataDirect System
800xA check box and click OK on the Add-Ins screen that appears.
C:\ProgramData\ABB\800xA\DataDirect\bin\ABBDataDirectSystem800xA.xlam file
is added into the Excel options.
The first time an Excel Worksheet is opened with the DataDirect add-in tools, a
message asking whether or not to enable macros may be shown. If this happens,
click the Enable macros button to set the security level to Low for this session. Macros
MUST be enabled in order to use the DataDirect add-in tools.

3BUF001091-610 A 79
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

1. Specify the starting cell where the query result will be displayed. To do this, click
the applicable cell in the Excel Spreadsheet.
2. Open the System 800xA History Values dialog by either clicking the tool bar button,
Figure 2.73, or choosing DataDirect System800xA> Industrial IT History Values
from the menu bar.

Figure 2.73: Opening the History Values Dialog

If these options are not available, click Options and go to the View tab to enable these
options.

The History Values dialog is shown in Figure 2.74. This dialog provides access to
both basic trend logs and Information Management history logs.
3. Use the object browser section (left side) to select the object whose logs will be
accessed. The trend and history logs for the selected object will be listed in the Items
list (right side). If the Include Child Objects check box is checked, the Items list
will include logs for all child objects of the selected object (not shown in this example).
A filter may be specified to limit the number of items; however, that is neither required
nor covered in this tutorial.
4. Use the Output radio buttons to specify whether to execute a one-time (ad-hoc) data
query, or insert a reusable formula. Either option is okay for this tutorial. To create
a report from this spreadsheet, select the Formula option.
5. Specify whether to retrieve Raw Data or Interpolated Data.
6. A Log Calculation Algorithm (aggregate) may be applied to Interpolated Data when
it is retrieved. The default is to apply no calculation (Any).
7. Specify the maximum Number of Values to return (use 100).

3BUF001091-610 A 80
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

8. The default time span is one hour from the current time (Dynamic Time). Adjust this
time span as required.
9. Select the property logs whose values are needed (Trend1Wk).
10. Click Apply or OK to retrieve the data.

Figure 2.74: History Values Dialog

An example query result is shown in Figure 2.75.

3BUF001091-610 A 81
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

Figure 2.75: History Retrieval Result

2.7.5 Alarm/Event Data

Alarms and events generated by the SoftPoints are collected by the system message
service and may be viewed via a SoftPoint signal Alarm and Event List aspect. To support
this functionality, the OPC alarm server for SoftPoints must be added to the Information
Management’s Event Collector Service Group Definition. This set-up should already
have been done as described in Integrating SoftPoint Alarms and System Messages on
page 24.

Viewing Alarms and Events

Once this connection is established, the alarm/event data for a SoftPoint signal may be
viewed via the signal’s Alarm and Event aspect Main view. Change the default
configuration to: Common Event List Configuration : Alarm and Event List
Configuration (the default is Alarm List). This list, Figure 2.76, will contain entries for
events that have occurred for the selected object (CountHigh, CountLow, etc...).

3BUF001091-610 A 82
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

Figure 2.76: Viewing an Event List

Adding an Event List to the Object Type

The Event Data may be integrated into an Excel spreadsheet for reporting purposes.
This functionality is supported by the System 800xA Alarm and Event dialog in
DataDirect, Figure 2.77.
As a further option, configure a message log in Information Management History to
support extended online storage and offline archival alarm/event data. This is
demonstrated in Section 5 Configuring Additional Functionality.
Since the default configuration of the Alarm and Event List aspect was to display alarms,
do the following to set up an Event List for Counters 1 to 10.
1. Open the Object Type Structure to the Counter, SoftPoint Process Object Type.
2. Add a new Alarm and Event List aspect and name it Event List.
3. Change the default configuration to: Common Event List Configuration: Alarm
and Event List Configuration (the default is Alarm List). By default, the aspect is
set to inherit in the Counter Type Definition, Aspect Control.
Go to the Control Structure to see the Event List aspect added to each Counter
object.
4. Return to DataDirect and select the IIT Alarms and Events button, Figure 2.77.
5. Select the Counter1, Counter and then select the Event List aspect name.

3BUF001091-610 A 83
2 Configuring Basic Functionality
2.7 Collecting and Viewing Historical Data

6. Click OK to retrieve the Event List data.

7. Save the XL file as C:\Data\Reports\Counter1Trend1Wk.xls for example. Do not
use the EmptyDoc.xls name.

Figure 2.77: DataDirect Alarm and Event Dialog

If the ActiveX control for the Edit Filter button freezes, press the Esc key.

3BUF001091-610 A 84
3 Report and Scheduling for Operations

3 Report and Scheduling for Operations

Reports are created using DataDirect or a third party application such as Excel. A report
is scheduled to run using the Application Scheduler and the Report action plug-in. The
System 800xA functions are as follows:
• Process Values
• History Values
• Alarm and Event

Figure 3.1: Toolbar

The examples given in this section include:

• Creating a History Report using DataDirect System 800xA Toolbar on page 86.
• Creating a Process Value Report using DataDirect System 800xA Toolbar on page
88.
• Creating an Alarm and Event Report using DataDirect System 800xA Toolbar on
page 91.
• DataDirect Report Templates for Scheduler on page 93.
• Adding Report Parameters for User-defined Template on page 94.
• Attaching Report Templates to File Viewer Aspects on page 95.
• Scheduling a Report on page 96.

3BUF001091-610 A 85
3 Report and Scheduling for Operations
3.1 Creating a History Report using DataDirect System 800xA Toolbar

3.1 Creating a History Report using DataDirect System

800xA Toolbar
This example shows how to quickly create a history report using DataDirect functionality
which is included in the base functionality of the 800xA System.
1. Launch DataDirect from Excel.
2. Select a cell in the spreadsheet which will be the starting point for inserting the
history data.

3BUF001091-610 A 86
3 Report and Scheduling for Operations
3.1 Creating a History Report using DataDirect System 800xA Toolbar

3. Click the History Values button, or choose DataDirect System 800xa> Industrial
IT History Values from the menu bar and do the following to configure the dialog,
Figure 3.2:

Figure 3.2: History Values Dialog

a. Use the Output radio buttons to insert a reusable formula.

b. Specify raw data. The default is no calculation with this selection.
c. Specify the Number of Values to return to be 100.
d. Use the default time span of one hour from the current time (Dynamic Time).
e. Select the property log whose values you want to see, in this case select the
Counter 1 Count history log, History52Wk.
f. Click either Apply or OK to retrieve the data.

3BUF001091-610 A 87
3 Report and Scheduling for Operations
3.2 Creating a Process Value Report using DataDirect System 800xA Toolbar

4. The resulting report is shown in Figure 3.3.

Figure 3.3: History Reports

5. Save the report file as C:\Data\Reports\Counter1History52Wk.xls.

3.2 Creating a Process Value Report using DataDirect

System 800xA Toolbar
1. Launch DataDirect from Excel.
2. Select a cell in the spreadsheet which will be the starting point for inserting the
history data.

3BUF001091-610 A 88
3 Report and Scheduling for Operations
3.2 Creating a Process Value Report using DataDirect System 800xA Toolbar

3. Click IIT Process Values icon on the Custom ToolBar, or choose DataDirect
System 800xa > Industrial IT Process Values from the menu bar and do the
following to configure the dialog, Figure 3.4:

Figure 3.4: IIT Process Value

a. Use the Output radio buttons to insert a reusable formula.

b. Click either Apply or OK to retrieve the data.

3BUF001091-610 A 89
3 Report and Scheduling for Operations
3.2 Creating a Process Value Report using DataDirect System 800xA Toolbar

4. The resulting report is shown in Figure 3.5.

Figure 3.5: Process Value Report

5. Save the report file as C:\Data\Reports\Counter1ProcessValues.xls.

3BUF001091-610 A 90
3 Report and Scheduling for Operations
3.3 Creating an Alarm and Event Report using DataDirect System 800xA Toolbar

3.3 Creating an Alarm and Event Report using

DataDirect System 800xA Toolbar
1. Select a cell in a new workbook which will be the starting point for inserting the event
data.

3BUF001091-610 A 91
3 Report and Scheduling for Operations
3.3 Creating an Alarm and Event Report using DataDirect System 800xA Toolbar

2. Click the Alarm and Events button, or choose DataDirect System 800xa > Industrial
IT Alarm and Events from the menu bar and use the defaults to configure the dialog
for the Event List Aspect on the Counter1 object.
a. Use the Output radio buttons to insert a reusable formula.
b. Specify the Maximum Rows to return to be 100.
c. Select the Alarm and Event List Aspect whose values you want to see, in this
case select the Event List Aspect on the Counter1 object, Figure 3.6.

Figure 3.6: DataDirect Alarm and Event Dialog

d. Click OK to retrieve the data.

3BUF001091-610 A 92
3 Report and Scheduling for Operations
3.4 DataDirect Report Templates for Scheduler

3. The resulting report is shown in Figure 3.7.

Figure 3.7: DataDirect XL Report of Counter 1 Alarm and Event Values

4. Save the report file as C:\Data\Reports\Counter1AE.xls.

3.4 DataDirect Report Templates for Scheduler

The steps given in the previous sections can be used to create templates or the user
can combine the multiple reports in the same excel sheet as a template.

3BUF001091-610 A 93
3 Report and Scheduling for Operations
3.5 Adding Report Parameters for User-defined Template

3.5 Adding Report Parameters for User-defined

Template
Users can create references (named cells) in a report template which can be used as
input parameters in Scheduler.
The following example shows how to add a parameter in History Reports that is created
in the section Creating a History Report using DataDirect System 800xA Toolbar on
page 86.
1. Open the file: C:\Data\Reports\Counter1History52Wk.xls
2. Select the cell which has an object name as shown in Figure 3.8.

Figure 3.8: History Reports

3. Click the Formula tab in the Excel menu.

3BUF001091-610 A 94
3 Report and Scheduling for Operations
3.6 Attaching Report Templates to File Viewer Aspects

4. Click Define Name. The New Name dialog is displayed, Figure 3.9

Figure 3.9: New Name Dialog

5. Enter the Name that can be used as a parameter.

6. Select Workbook from the Scope drop-down list.
7. Click OK.
8. Save the Excel report.
To pass data into the newly created reference, refer to Report Parameters in the
Creating Reports section of System 800xA Information Management Data Access
and Reports (3BUF001094*).

3.6 Attaching Report Templates to File Viewer Aspects

The files created for reports may be saved in the Windows file system or attached to File
Viewer aspects in the 800xA system aspect directory. This is used to browse for report
files via the Plant Explorer, and also is used to apply version control and electronic
signatures to report files. Create File Viewer aspects for the reports that can be scheduled
as follows:
1. In the Plant Explorer, browse to the location where the File Viewer aspect will be
added, for example, the Reports branch in the Scheduling Structure or with the
object in the Control Structure. In this example, go to the Scheduling
Structure/Reports branch.
2. Choose New Object from the Reports context menu.
3. In the New Object dialog, select the Generic type object, assign the object a
meaningful name such as: GettingStartedReports then click Create.

3BUF001091-610 A 95
3 Report and Scheduling for Operations
3.7 Scheduling a Report

4. Within the GettingStartedReports object create another generic object called

Counter1History52Wk. This will be used for defining the Excel Report.
5. Select the new object and choose New Aspect from the context menu.
6. Select the File Viewer aspect in New Aspect dialog then click Create. This adds
the File Viewer aspect to the selected object.
7. Open the Configuration view of the File Viewer aspect. To do this, either select the
aspect and choose Config View from the context menu, or use the corresponding
icon on the tool bar.
8. Attach the report file as a Work Document. To do this, in the Work Document section
of the Configuration view, click the Attach button.
9. Use the File Browser dialog to select the report file in the Windows file system
(C:\Data\Reports\Counter1History52Wk.xls in this example), then click Open.
10. The user can attach other reports in the same way as described in Step 4. through
Step 9..

3.7 Scheduling a Report

This example shows how to schedule a report by creating a Job Description object with
an Action Aspect and then setting up a Periodic Schedule in the Scheduling Definition
aspect. The different type of Job Descriptions could be organized into Job Folders
(DataDirect Reports, Excel Reports, Crystal Reports for example).

The Scheduler Service is automatically created during installation of Information

Management. Otherwise, the Scheduler Service will have to be created.

1. In the Plant Explorer, select the Scheduling Structure.

2. Select Job Descriptions and choose New Object from the context menu, Figure
3.10.

Figure 3.10: Adding a New Job Object

3BUF001091-610 A 96
3 Report and Scheduling for Operations
3.7 Scheduling a Report

3. Add the Job object as a Job Description object, Figure 3.11. Assign the object a
logical name (Counter1History52Wk for the Excel Report).

Figure 3.11: New Object Dialog, History Report

4. Click Create. This creates the new job under the Job Descriptions group, and adds
the Schedule Definition aspect to the object’s aspect list.
5. Select the Job Description object, Figure 3.12, and choose New Aspect from the
context menu.

Figure 3.12: Adding a New Aspect, History Report

3BUF001091-610 A 97
3 Report and Scheduling for Operations
3.7 Scheduling a Report

6. In the New Aspect dialog, select the Action Aspect, Figure 3.13. Use the default
aspect name, or specify a new name.

Figure 3.13: New Action Aspect Dialog

7. Click Create to add the Action aspect to the job.

8. Select the Action Aspect from the object’s aspect list, Figure 3.14 and select the
Report Action from the Action pull-down list.

Figure 3.14: Set Action Aspect as Report Action

3BUF001091-610 A 98
3 Report and Scheduling for Operations
3.7 Scheduling a Report

9. Configure the Action Aspect, Figure 3.15.

Figure 3.15: Set Output Options in Action Aspect Dialog

3BUF001091-610 A 99
3 Report and Scheduling for Operations
3.7 Scheduling a Report

10. Use the Report Template Path to enter or select the report to be executed by this
action. Here are the three primary examples:
• Enter a Windows file directly: C:\Data\Reports\Counter1History52Wk.xls
• Browse for a Windows file: click the Report Template Path ... button then choose
Windows Files from the context menu. Select
C:\Data\Reports\Counter1History52Wk.xls and click Open.
• Browse for a File Viewer aspect: click the Report Template Path ... button then
choose File Viewer aspects from the context menu. Navigate to Reports /
GettingStartedReports / Counter1History52Wk, select the File Viewer aspect
and click OK.
The path will be: Counter1History52Wk:File Viewer.
– Optionally, select System Messages and choose Log Both Start and
Done.
– In the Output Options section, check Export Paths.
The Export Paths option is used to export the report output to one or more
files of a specified type (Excel, HTML, PDF, etc....). The completed report
files may be attached to Completed Report objects in the Report branch
of the Scheduling Structure, be stored as Windows files, or both.
The format defaults to the format of the selected report template. In the
following examples, add <TimeStamp> to get the time attached to the report
and make the changes noted.
• For HistoryReport and the Counter1History, use the Add File Path button for
Windows output.
For the HistoryReport, select a Format such as HTML. Browse to the file path
and add the time stamp, for example:
C:\Data\Reports\Output\Counter1History52Wk_<TimeStamp>.html. Click OK.
• For Counter1History52Wk, use the Add Object Path button for File Viewer
aspect output to a Completed Report object. In the dialog, the Format defaults
to Excel (the format of the report). Edit the Object Path to be:
Counter1History52Wk/Counter1History52Wk_<TimeStamp> and enter the file
Name: Counter1History52Wk.xls. Click OK.
The object path defaults to an object which is named after the selected report
template with the word Folder and a time stamp appended. This object will be
created in the Reports branch of the Scheduling Structure if it does not already
exist. The file name defaults to the name of the selected report template. These
defaults may be used instead of the suggested edits.

3BUF001091-610 A 100
3 Report and Scheduling for Operations
3.7 Scheduling a Report

– Where report parameters are needed, check Report Parameters and click
the Edit Parameter List button. For example,in the case of the History
Report template that is created in Adding Report Parameters for
User-defined Template on page 94, set the tagname = Counter1
Count:Value, History52Wk. OK that and Close.
– Click Apply to the Action Aspect.
– As an option, use the context menu and select Test Action to see if the
Report Action works.
a. Select the Scheduling Definition aspect and set up a Periodic
Schedule, Figure 3.16. Disable the Schedule (Enabled unchecked).
The Run Now button will be used to test the report output. If there is
more than one Service Group, then be sure to set that field also.

Figure 3.16: Set Periodic Schedule in Scheduling Definition Aspect

b. Set the Run every period field as desired.

c. Click Apply.
d. Click Run Now.
If the Schedule is Enabled, the default behavior is to run the first
instance of the job immediately after clicking Apply and to continue
running at the specified interval indefinitely. For example, if the interval

3BUF001091-610 A 101
3 Report and Scheduling for Operations
3.7 Scheduling a Report

is run every 1 Day, the job will start running at the time the schedule
is submitted, and continue to run once-a-day at that time.

3BUF001091-610 A 102
4 Reports and Scheduling

4 Reports and Scheduling

Reports are created using DataDirect or a third party application such as Excel or Crystal
Reports. A report is scheduled to run using the Application Scheduler and the Report
action plug-in. The examples provided in this section are:
• DataDirect report templates for Scheduler.(Creating a User-defined Report Template
using DataDirect System 800xA on page 104).
• Report parameters for user-defined template. (Adding Parameters to User-defined
Report Templates using DataDirect System 800xA on page 109)
• History reports (Adding Parameters to User-defined Report Templates using
DataDirect System 800xA on page 109).
• History reports using ODBC and ODA (Creating a Simple History Report using
ODBC and ODA on page 110).
• Report parameters (Adding Parameters to the History Report on page 116).
• Real-time reports (Creating a Real-Time Report with Excel on page 124).
• Crystal reports (Creating a History Report with Crystal Reports on page 130).
• File Viewer aspects (Attaching Report Templates to File Viewer Aspects on page
133).
• Scheduling reports (Scheduling a Report on page 134).
• Historizing reports (Historizing a Report on page 141).
• Alternative report configuration (Alternative Tag Query on page 142).
DataDirect provides re-executable functions and interactive dialogs for data access when
creating a report in Excel.
Excel (without DataDirect add-in) and Crystal Reports use the Open Data Access (ODA)
server which supports client applications that use an ODBC data source (Excel requires
Microsoft Query). The client application may connect to one ODA database.

3BUF001091-610 A 103
4 Reports and Scheduling
4.1 Use of Log Template

The default connection is to an ODA database named ABBODA. Without requiring any
configuration, this database supports read access to all properties for all real-time objects
via the generic_da table, read/write access to history data via the numericlog table and
800xA OPC HDA server, and one custom real-time table (if added in the ODA Database
Definition aspect in the Library Structure, refer to Creating a Database Object in the
Open Data Access section of System 800xA Information Management Configuration
(3BUF001092*).

4.1 Use of Log Template

The property logs used to create the following reports were created in the previous
section and based upon a History Log Template with a one week direct trend log and a
52 week hierarchical Information Management log under the direct trend log (see Creating
a Log Template on page 52). Another typical example is a log template with average
hourly and daily values (try creating your own History Log Template in the Library
Structure). To save you from doing complex and heavy queries later, it is important to
take advantage of creating templates that include your reporting requirements in advance.

4.2 Creating a User-defined Report Template using

DataDirect System 800xA
This example shows how to quickly create a history report using DataDirect functionality
which is included in the base functionality of the 800xA System.
1. Launch DataDirect from Excel.
2. Select a cell in the spreadsheet which will be the starting point for inserting the
history data.

3BUF001091-610 A 104
4 Reports and Scheduling
4.2 Creating a User-defined Report Template using DataDirect System 800xA

3. Click the History Values button, or choose DataDirect System 800xa > Industrial
IT History Values from the menu bar and do the following to configure the
dialog,Figure 4.1 :

Figure 4.1: History Values Dialog

a. Use the Output radio buttons to insert a reusable formula.

b. Specify raw data. The default is no calculation with this selection.
c. Specify the Number of Values to return to be 100.
d. Use the default time span of one hour from the current time (Dynamic Time).
e. Select the property log whose values you want to see, in this case select the
Counter 1 Count history log, History52Wk.
f. Click either Apply or OK to retrieve the data.
4. The resulting report is shown in Figure 4.2.

3BUF001091-610 A 105
4 Reports and Scheduling
4.2 Creating a User-defined Report Template using DataDirect System 800xA

5. Save the report file as C:\Data\Reports\Counter1History52Wk.xls.

Figure 4.2: DataDirect XL Report of Counter 1 History Values

6. Select a cell in a new workbook which will be the starting point for inserting the event
data.

3BUF001091-610 A 106
4 Reports and Scheduling
4.2 Creating a User-defined Report Template using DataDirect System 800xA

7. Click the Alarm and Events button, or choose DataDirect System 800xa> Industrial
IT Alarm and Events from the menu bar and use the defaults to configure the dialog
for the Counter 1 Event List:
a. Use the Output radio buttons to insert a reusable formula.
b. Specify the Maximum Rows to return to be 100.
c. Select the Alarm and Events List Aspect whose values you want to see, in this
case, select the Event List on the Counter 1 Count object, Figure 4.3.

Figure 4.3: DataDirect Alarm and Event Dialog

d. Click OK to retrieve the data.

3BUF001091-610 A 107
4 Reports and Scheduling
4.2 Creating a User-defined Report Template using DataDirect System 800xA

8. The resulting report is shown in Figure 4.4.

9. Save the report file as C:\Data\Reports\Counter1AE.xls.

Figure 4.4: DataDirect XL Report of Counter 1 Alarm and Event Values

3BUF001091-610 A 108
4 Reports and Scheduling
4.3 Adding Parameters to User-defined Report Templates using DataDirect System 800xA

4.3 Adding Parameters to User-defined Report

Templates using DataDirect System 800xA
Users can create references (named cells) in a report template that can be used as input
parameters in Scheduler.
The following example shows how to add a parameter in History Reports that is created
in the section Creating a User-defined Report Template using DataDirect System 800xA
on page 104.
1. Open the file: C:\Data\Reports\Counter1History52Wk.xls
2. Select the cell which has an object name as shown in, Figure 4.5.

Figure 4.5: History Reports

3. Click the Formula tab in the Excel menu.

3BUF001091-610 A 109
4 Reports and Scheduling
4.4 Creating a Simple History Report using ODBC and ODA

4. Click Define Name. The New Name dialog is displayed, Figure 4.6.

Figure 4.6: New Name Dialog

5. Enter the Name that can be used as a parameter.

6. Select Workbook from the Scope drop-down list.
7. Click OK.
8. Save the Excel report.
To pass data into the newly created reference, refer to Report Parameters in the Creating
Reports section of System 800xA Information Management Data Access and Reports
(3BUF001094*).

4.4 Creating a Simple History Report using ODBC and

ODA
This example shows how to create a simple report using Open DataBase Connectivity
(ODBC) and Open Data Access (ODA) with Excel functionality. ODA supports real-time
and historical data access for third party applications including Crystal Reports, Microsoft
Excel (when used without DataDirect add-ins), and Visual Studio 2008 applications. ODA
is a general term that refers to basic data access options - ODBC access.
The following activities are covered.
• Querying the database.
• Adding filtered data to the report.

3BUF001091-610 A 110
4 Reports and Scheduling
4.4 Creating a Simple History Report using ODBC and ODA

• Using Information Management Browser to browse for log names.

3BUF001091-610 A 111
4 Reports and Scheduling
4.4 Creating a Simple History Report using ODBC and ODA

• 1. Launch Data Direct from Excel.

2. Select Data > From Other Sources > From Microsoft Query…, Figure 4.7.

Figure 4.7: New Database Query

3. Choose the ABBODA* data source, Figure 4.8, and click OK.

3BUF001091-610 A 112
4 Reports and Scheduling
4.4 Creating a Simple History Report using ODBC and ODA

Figure 4.8: Choose Data Source

4. Choose the LOGNAME, TIMESTAMP and DATAVALUE columns in the Query

Wizard from the NUMERICLOG table, Figure , and click Next>.

Figure 4.9: Choose Columns

5. Set the filter data to equals for LOGNAME and make it equal to Counter1
Count:Value,History52Wk, Figure 4.10. Another way to get this value is by
copying and pasting as follows:
a. Select ABB Start Menu > ABB System 800xA > Information
Management > Utilities > IM Structure Browser.
b. In the Browse Object dialog, select the Control Structure context menu
item Get Entire List.
c. Select the Counter1 Count:Value,History52Wk context menu item Copy
Item(s).
d. Return to the Query Wizard - Filter Data dialog and Paste the item into
fill-in box.

3BUF001091-610 A 113
4 Reports and Scheduling
4.4 Creating a Simple History Report using ODBC and ODA

6. Click Next> after setting the Query Wizard - Filter Data.

Figure 4.10: Filter Columns

7. Click Next>.
8. Click Finish.
9. Select OK on the Import Data dialog (set the option of 'Existing worksheet:' to
refer existing worksheet with cell as A7, like =$A$7).

3BUF001091-610 A 114
4 Reports and Scheduling
4.4 Creating a Simple History Report using ODBC and ODA

10. The completed report is shown in the Excel worksheet, Figure 4.11.

Figure 4.11: Completed Simple Report

11. Save the report as C:\Data\Reports\SimpleReport_History52Wk.xls.

3BUF001091-610 A 115
4 Reports and Scheduling
4.5 Adding Parameters to the History Report

4.5 Adding Parameters to the History Report

This example uses the completed simple report as the basis for a report of multiple logs
and for a time specified on the spreadsheet. This is accomplished using parameters to
specify the log names and the timestamp.
1. Open the SimpleReport_History52Wk.xls.
2. Type in the desired time range to the spreadsheet, Figure 4.12.
3. Add the log name 'Counter1 Count:Value,History52Wk' to cell A3 on the spreadsheet.
It will be used when defining parameters later.
4. From Logname, use the context menu to select Table > Edit Query, Figure 4.13.
5. In the Query Wizard, click Next > three times and then select: View data or edit
query in Microsoft Query at the Finish dialog.

3BUF001091-610 A 116
4 Reports and Scheduling
4.5 Adding Parameters to the History Report

6. Click Finish to open the Microsoft query from ABBODA.

Figure 4.12: Time Range Added to Simple History Report

3BUF001091-610 A 117
4 Reports and Scheduling
4.5 Adding Parameters to the History Report

Figure 4.13: Edit Query of Simple History Report

3BUF001091-610 A 118
4 Reports and Scheduling
4.5 Adding Parameters to the History Report

7. Instead of using a fixed log name, replace the Value: 'Counter1

Count:Value,History52Wk' with a parameter called [Input_Logname], Figure 4.14.

Figure 4.14: Using Parameter for Log Name

8. Copy and paste the 'Counter1 Count:Value,History52Wk' from cell A3 on the

spreadsheet into the Enter Parameter Value dialog and click OK.
9. Add Timestamp as a parameter, Figure 4.15, in the Criteria Field.

Figure 4.15: Adding Timestamp Parameter

3BUF001091-610 A 119
4 Reports and Scheduling
4.5 Adding Parameters to the History Report

10. Set up the Value field to use 'Between [Input_From] AND [Input_To]' as the
parameters.The Enter Parameter Value for the Input_From parameter is copied
from the Date&Time From column of the spreadsheet, Figure 4.16, and the Input_To
parameter is similarly copied from the To column.

Figure 4.16: Copying Time Range Added to [Input_From] Parameter

3BUF001091-610 A 120
4 Reports and Scheduling
4.5 Adding Parameters to the History Report

11. To link the parameters to the cells, close the Microsoft Query wizard and select the
LOGNAME header on the spreadsheet and use the context menu to select
Parameters, Figure 4.17.

Figure 4.17: Selecting Parameters

3BUF001091-610 A 121
4 Reports and Scheduling
4.5 Adding Parameters to the History Report

12. Link the Input_Logname parameter as shown in Figure 4.18.

Figure 4.18: Linking the Input_Logname Parameter

13. Do the same to link the Input_From and Input_To parameters to their Date&Time
fields.
14. As a test, change the Counter1 Count:Value,History52Wk from cell A3 to Counter2
Count:Value,History52Wk and the report will show those data values. Change it
back when done.
15. Since we do not need to show the LOGNAME column, use Edit Query again, Figure
4.13, to remove the column.
16. Format the cells for Timestamp to show hours only.

3BUF001091-610 A 122
4 Reports and Scheduling
4.5 Adding Parameters to the History Report

17. To add multiple logs, copy the Counter1 Count:Value,History52Wk from cell A3 to
another cell and name it Counter6 Count:Value,History52Wk. The TIMESTAMP
column is not needed for the additional logs so it can be removed like LOGNAME
column was done earlier. Refer to Figure 4.19.

Figure 4.19: Additional Parameters

18. Save the report as C:\Data\Reports\SimpleReport_History52Wk.xls

3BUF001091-610 A 123
4 Reports and Scheduling
4.6 Creating a Real-Time Report with Excel

4.6 Creating a Real-Time Report with Excel

This example shows how to create a real-time report by importing ODA NUMERICLOG
data into Excel. The following activities are covered.
1. Browse for lognames.
2. Specify a time range in the report.
3. Add parameters to the Excel report to make them general.
4. Add multiple logs and parameters.
Launch DataDirect (Excel Data Access) and open the Workplace Explorer to the
Control Structure.
5. Select the Counter 1 Count softpoint object, Figure 4.20, and then select the Log
Configuration aspect.

Figure 4.20: Selecting an Integer PCA Value

6. Select the Value property in the Log Configuration aspect configuration view.

3BUF001091-610 A 124
4 Reports and Scheduling
4.6 Creating a Real-Time Report with Excel

7. Place the Counter1 Count Integer PCA:Value property into Excel, Figure 4.21.

Figure 4.21: Place Value Property into Excel

3BUF001091-610 A 125
4 Reports and Scheduling
4.6 Creating a Real-Time Report with Excel

8. Add labels for these values, Figure 4.22.

Figure 4.22: Add Labels to the Value Property

3BUF001091-610 A 126
4 Reports and Scheduling
4.6 Creating a Real-Time Report with Excel

9. Select Data > From Other Sources > From Microsoft Query, Figure 4.23.

Figure 4.23: New Database Query

10. Choose the ABBODA* data source and click OK.

11. Choose the Name, Property and Value_Flt Columns in the Query Wizard from the
GENERIC_DA table and click Next>.

3BUF001091-610 A 127
4 Reports and Scheduling
4.6 Creating a Real-Time Report with Excel

12. Set the filter data to equals for Name and Property and make it equal to the cell
values (use copy and paste), Figure 4.24 and click Next>.

Figure 4.24: Filter Data Columns

13. Select View data or edit query in Microsoft Query and click Finish, Figure 4.25.

Figure 4.25: View Data Options

3BUF001091-610 A 128
4 Reports and Scheduling
4.6 Creating a Real-Time Report with Excel

14. Use parameters as input to make the report re-usable, Figure 4.26. Enter parameter
values for Name [Parameter1] and Property [Parameter2].

Figure 4.26: Enter Parameter Values

15. Remove the Name and Property columns so they do not get exported to the report
(only the value will be exported).
16. Select File > Return Data to Microsoft Office Excel.
17. Import the query data, Figure 4.27, into a cell and click OK.

Figure 4.27: Place query Data into Cell

3BUF001091-610 A 129
4 Reports and Scheduling
4.7 Creating a History Report with Crystal Reports

18. From the Parameters dialog, Figure 4.28, set both parameters to Get the value
from the following cell and to Refresh automatically when cell value changes
and click OK.

Figure 4.28: Refresh Query Data Parameters

19. Repeat Step 7. through Step 18. for Counter2 Count and all tags needed in the
report.

4.7 Creating a History Report with Crystal Reports

This example shows how to create a Crystal report using the localhost ODBC link to
access the Oracle IM Numeric log.
1. Start Crystal Reports.
2. On the Start Page, click Report Wizard to launch the Standard Report Creation
Wizard dialog and start a new report.

3BUF001091-610 A 130
4 Reports and Scheduling
4.7 Creating a History Report with Crystal Reports

3. Expand Create a New Connection in the Standard Report Creation Wizard dialog.
a. Select ODBC (RDO) as the data source.
b. Select ABBODA as the ODBC (RDO) data source and click Finish.
c. Expand ODBC (RDO) > ABBODA > SCHEMA > OAUSER and select
NUMERICLOG from the Available Data Sources, add it to the Selected Tables
list and click NEXT >.
4. Add the following fields to display:
Select the fields to include in the report.
• LOGNAME
• DATAVALUE
• TIMESTAMP
and click NEXT >.
a. Add NUMERICLOG.LOGNAME to Group By and click NEXT >.
b. Click NEXT > at the Summaries option. The default
NUMERICLOG.DATAVALUE is used.
c. Click NEXT > at the Group Sorting option (None = no sort specified).
d. At the Line Chart option, select a Line Chart and click Finish (no filters or
layout templates will be used). The report opens to the Preview tab.
e. Change to the Design tab.
f. Select View > Field Explorer if it does not already show.

3BUF001091-610 A 131
4 Reports and Scheduling
4.7 Creating a History Report with Crystal Reports

5. To dynamically change the LOGNAME field for each report instance, it must be
passed as a parameter. From the Field Explorer:
a. Select the Parameter Fields branch.
b. Select New from the context menu.
c. In the Create New Parameter dialog enter the parameter name as Log Name
and set the Value type to String. This will create the {?Log Name} parameter.
d. Set the Allow Multiple values options to true under the Value Options section.
e. Select the Default Values... row and enter the value: Counter1
Count:Value,History52Wk as one of the default property log values in the
report. Do the same for other counter logs (Counter2
Count:Value,History52Wk) and click OK.
f. Click OK to close the Create New Parameter dialog.
6. Configure the query to get data as follows.
a. The LOGNAME only needs to be in the header of the report so it can be Cut
from the body (Group Details area only prints TIMESTAMP and DATAVALUE)
and Pasted back into the Page Header.
b. Select the LOGNAME field from the Page Header area, and select Select
Expert Record from the context menu.
c. Set NUMERICLOG.LOGNAME so that it “is equal to” {?Log Name}. The formula
is: {NUMERICLOG.LOGNAME} = {?Log Name}.
d. Click OK.
7. Preview the report.
a. Click the Preview tab.
b. For the Log Name parameter, select Discrete Value: Counter1
Count:Value,History52Wk.
c. Click OK.
d. Press F5 to Refresh Report Data, select Prompt for new parameter values and
click OK.
e. Remove parameter Counter1 Count:Value,History52Wk and Add parameter
Counter2 Count:Value,History52Wk to see the same report with the new
parameter.
8. Save the report as C:\Data\Reports\Counter1History.rpt and close it.

3BUF001091-610 A 132
4 Reports and Scheduling
4.8 Attaching Report Templates to File Viewer Aspects

4.8 Attaching Report Templates to File Viewer Aspects

The files created for reports may be saved in the Windows file system or attached to File
Viewer aspects in the 800xA system aspect directory. This is used to browse for report
files via the Plant Explorer, and also is used to apply version control and electronic
signatures to report files. Create File Viewer aspects for the reports that can be scheduled
as follows:
1. In the Plant Explorer, browse to the location where the File Viewer aspect will be
added, for example, the Reports branch in the Scheduling Structure or with the
object in the Control Structure. In this example, go to the Scheduling Structure /
Reports branch.
2. Choose New Object from the Reports context menu.
3. In the New Object dialog, select the Generic type object, assign the object a
meaningful name such as: GettingStartedReports then click Create.
4. Within the GettingStartedReports object create another generic object called
Counter1History. This will be used for defining the Crystal Report.
5. Select the new object and choose New Aspect from the context menu.
6. Select the File Viewer aspect in New Aspect dialog then click Create. This adds
the File Viewer aspect to the selected object.
7. Open the Configuration view of the File Viewer aspect. To do this, either select the
aspect and choose Config View from the context menu, or use the corresponding
icon on the tool bar.
8. Attach the report file as a Work Document. To do this, in the Work Document section
of the Configuration view, click the Attach button.
9. Use the File Browser dialog to select the report file in the Windows file system
(C:\Data\Reports\Counter1History.rpt in this example), then click Open.
10. Create a new generic object with a File Viewer aspect for each report type and place
it in GettingStartedReports as described in steps 4 through 9. Select from the
following reports created using this tutorial:
• Counter1History52Wk.xls
• Counter1AE.xls
• SimpleReport_History52Wk.xls
• HistoryReport.xls
• Counter1History.rpt

3BUF001091-610 A 133
4 Reports and Scheduling
4.9 Scheduling a Report

4.9 Scheduling a Report

This example shows how to schedule a report by creating a Job Description object with
an Action Aspect and then setting up a Periodic Schedule in the Scheduling Definition
aspect. The different type of Job Descriptions could be organized into Job Folders
(DataDirect Reports, Excel Reports, Crystal Reports for example).

The Scheduler Service is automatically created during installation of Information

Management. Otherwise, the Scheduler Service will have to be created.

1. In the Plant Explorer, select the Scheduling Structure.

2. Select Job Descriptions and choose New Object from the context menu, Figure
4.29.

Figure 4.29: Adding a New Job Object

3BUF001091-610 A 134
4 Reports and Scheduling
4.9 Scheduling a Report

3. Add the Job object as a Job Description object, Figure 4.30. Assign the object a
logical name (Counter1History for the Crystal Report).

Figure 4.30: New Object Dialog, History Report

4. Click Create. This creates the new job under the Job Descriptions group, and adds
the Schedule Definition aspect to the object’s aspect list.
5. Select the Job Description object, Figure 4.31, and choose New Aspect from the
context menu.

Figure 4.31: Adding a New Aspect, History Report

3BUF001091-610 A 135
4 Reports and Scheduling
4.9 Scheduling a Report

6. In the New Aspect dialog, select the Action Aspect, Figure 4.32. Use the default
aspect name, or specify a new name.

Figure 4.32: New Action Aspect Dialog

7. Click Create to add the Action aspect to the job.

3BUF001091-610 A 136
4 Reports and Scheduling
4.9 Scheduling a Report

8. Select the Action Aspect from the object’s aspect list, Figure 4.33 and select the
Report Action from the Action pull-down list.

Figure 4.33: Set Action Aspect as Report Action

3BUF001091-610 A 137
4 Reports and Scheduling
4.9 Scheduling a Report

9. Configure the Action Aspect, Figure 4.34.

Figure 4.34: Set Output Options in Action Aspect Dialog

• Use the Report Template Path to enter or select the report to be executed by
this action. Here are the three primary examples:
– Enter a Windows file directly: C:\Data\Reports\HistoryReport.xls.
– Browse for a Windows file: click the Report Template Path ... button then
choose Windows Files from the context menu. Select
C:\Data\Reports\Counter1History.rpt and click Open.
– Browse for a File Viewer aspect: click the Report Template Path ... button
then choose File Viewer aspects from the context menu. Navigate to
Reports / GettingStartedReports / Counter1History52Wk, select the File
Viewer aspect and click OK.
The path will be: Counter1History52Wk:File Viewer
• Optionally, select System Messages and choose Log Both Start and Done.
• In the Output Options section, check Export Paths.
• The Export Paths option is used to export the report output to one or more files
of a specified type (Excel, Crystal Report, HTML, PDF, etc....). The completed
report files may be attached to Completed Report objects in the Report branch
of the Scheduling Structure, be stored as Windows files, or both.

3BUF001091-610 A 138
4 Reports and Scheduling
4.9 Scheduling a Report

• The format defaults to the format of the selected report template. In the following
examples, add <TimeStamp> to get the time attached to the report and make
the changes noted.
• For HistoryReport and the Counter1History, use the Add File Path button for
Windows output.
For the HistoryReport, select a Format such as HTML. Browse to the file path
and add the time stamp, for example:
C:\Data\Reports\Output\HistoryReport_<TimeStamp>.html. Click OK. For the
Crystal Report, select a Format such as PDF. Browse to the file path and add
the time stamp, for example:
C:\Data\Reports\Output\Counter1History_<TimeStamp>.pdf. Click OK.
• For Counter1History52Wk, use the Add Object Path button for File Viewer
aspect output to a Completed Report object. In the dialog, the Format defaults
to Excel (the format of the report). Edit the Object Path to be:
Counter1History52Wk/Counter1History52Wk_<TimeStamp> and enter the file
Name: Counter1History52Wk.xls. Click OK.
• The object path defaults to an object which is named after the selected report
template with the word Folder and a time stamp appended. This object will be
created in the Reports branch of the Scheduling Structure if it does not already
exist. The file name defaults to the name of the selected report template. These
defaults may be used instead of the suggested edits.
• Where report parameters are needed, check Report Parameters and click the
Edit Parameter List button. In the case of the Crystal Report, set the Log Name
= Counter1 Count:Value,History52Wk. OK that and Close.
• Click Apply to the Action Aspect.
• As an option, use the context menu and select Test Action to see if the Report
Action works.
10. Select the Scheduling Definition aspect and set up a Periodic Schedule, Figure
4.35. Disable the Schedule (Enabled unchecked). The Run Now button will be used
to test the report output. If there is more than one Service Group, then be sure to
set that field also.
11. Set the Run every period as desired.
12. Click Apply.

3BUF001091-610 A 139
4 Reports and Scheduling
4.9 Scheduling a Report

13. Click Run Now.

If the Schedule is Enabled, the default behavior is to run the first instance of the job
immediately after clicking Apply and to continue running at the specified interval
indefinitely. For example, if the interval is run every 1 Day, the job will start running
at the time the schedule is submitted, and continue to run once-a-day at that time.

Figure 4.35: Set Periodic Schedule in Scheduling Definition Aspect

14. View the report output:

• Open the C:\Data\Reports\Output\HistoryReport_<TimeStamp>.html file to see
the first instance of the job.
• Open the C:\Data\Reports\Output\Counter1History_<TimeStamp>.pdf file to
see the first instance of the job.
• Open the Reports / GettingStartedReports / Counter1History52Wk objects and
select the File Viewer aspect of the Completed Report object,
Counter1History52Wk_<TimeStamp>. Choose to Open the read only file.

3BUF001091-610 A 140
4 Reports and Scheduling
4.10 Historizing a Report

4.10 Historizing a Report

Report logs hold the finished output from executed reports. Completed reports may also
be stored as completed report objects in the Scheduling Structure. In either case the
Report action must be configured to send the report to a report log, or a completed report
object.
This example shows how to historize a report.
1. In the Plant Explorer, select the Node Administration Structure.
2. Navigate to and expand the object tree for the node where the report log will be
added.
3. In the object tree for the selected node, navigate to IM_Inform IT
History_nodeName, Service Provider > Inform IT History Object.
Under the InformIT History Object there will be containers for each of the Inform IT
History object types. The History objects (in this case, a report log) must be
instantiated under the corresponding Report Log Container.
4. Select the Report Logs group and choose New Object from the context menu.
This displays the New Object dialog with the Inform IT Report Log object type
selected.
5. Enter a name for the object in the Name field, for example: ReportLog1, then click
Create. This adds the object under the Report Logs group, and creates a
corresponding Inform IT history Report Log aspect.
6. Specify the following for the Report Log then click Apply.
• Capacity = 10 (If a log is full, new entries replace the oldest entries).
• Access Name = ReportLog1 (64 characters maximum, do not use spaces).
7. Click Mode button and activate the Report Log from the aspect view of Inform IT
History Report Log aspect.

3BUF001091-610 A 141
4 Reports and Scheduling
4.11 Alternative Tag Query

8. Return to the Action Aspect for a report and do the following:

a. Check Save To History.
b. Click Set.
c. Navigate to and select the ReportLog1 object just created and click OK.
d. Click Apply.
e. In the Scheduling Definition aspect, click Run Now.
9. View the report log from the Inform IT History View Report Logs aspect of the Report
Logs, Report Log Container back in the Node Administration Structure.
a. Click the Retrieve tab.
b. Enter the retrieval criteria, then click Retrieve.
c. In the upper pane, select the log which contains the report to be viewed
($HSReportLog1-1-o).
d. In the lower pane, select the report.
e. Click View Selected Report button and open the file for read only viewing.

4.11 Alternative Tag Query

The following procedure describes a simple way to query the 800xA database for numeric
logs and tags using the Information Management Bulk Import functions and their filtering
mechanisms available in Microsoft Excel. The query results can be used in various Inform
IT and System 800xA Excel reports. The procedure consists of the following parts:
• Create Workbook (Spreadsheet) on page 143.
• Configure Bulk Import Filter on page 143.
• Fill Workbook on page 144.
• Customize Report (Sheet) on page 144.

Perform this procedure on an 800xA workplace in order to utilize the Bulk Import
functions.

After the query is complete and the data has been transferred to the workbook sheet,
the resulting tag set can be used by local System 800xA or remote Inform IT functions

3BUF001091-610 A 142
4 Reports and Scheduling
4.11 Alternative Tag Query

4.11.1 Create Workbook (Spreadsheet)

To start the report creation process:
1. Launch Microsoft Excel and create a new workbook.
2. Select Bulk Import > Initialize Sheet.
3. Click Set System to connect the workbook to the system.

4.11.2 Configure Bulk Import Filter

The second step in the process is to configure the Bulk Import filter so that only the
desired information is retrieved:
1. Enter the data type in the Data Type cell of the Import Filter row manually or
a. Right click in the Data Type cell and select Data Type List.
b. Select the data type in the Data Type List window and click OK.
c. Click outside the cell to register the information.
A filter can be specified based on object name, aspect, and property as shown in Figure
4.36. This filter limits the list of returned properties to Value properties for all Integer
PCA aspects in all Objects whose name pattern fits *Count.
Object = *Count (* is a wild card character string)
Aspect = Integer PCA
Property = NAME:Value

Figure 4.36: Specifying an Import Filter

3BUF001091-610 A 143
4 Reports and Scheduling
4.11 Alternative Tag Query

4.11.3 Fill Workbook

The third step in the process is to retrieve the information and place it on the first sheet
of the workbook:
1. Select Bulk Import > Load Sheet from System.
2. Select an object within the Aspect Directory to limit/direct the search (and options
if necessary) and click Add.

4.11.4 Customize Report (Sheet)

The fourth and final step of the process is to configure another sheet to display the
desired information by using DataDirect and Excel commands and functions. The
commands and functions can reference the tags and logs found on the sheet generated
by the query.

3BUF001091-610 A 144
5 Configuring Additional Functionality
5.1 Configuring a Message Log

5 Configuring Additional Functionality

The lessons in this section describe:

• Configuring a Message Log for extending online storage and offline archival. This
includes:
– Check the data access connection for reading the message log.
– Using DataDirect to retrieve alarm/event data from the log.
• Configuring Historical Data Archiving for process (numeric) and alarm/event data.
• Accessing Archive Data to publish an archive volume and read archived data.
• Inform IT Authentication describes how to configure authentication for an Inform IT
Calculation Aspect.
These lessons are not covered in the same detail as the one in Section 2 Configuring
Basic Functionality. It is expected that you have worked through the lessons in that
section before using the lessons here.

5.1 Configuring a Message Log

All alarm and event messages for the 800xA system, including Process, Operator, and
Audit Trail messages, are collected and stored by the 800xA Event Storage Service.
This provides a short-term storage facility of 10,000 events of each type. The messages
can be organized into filtered lists for viewing.
If the system has an Information Management History Server installed, the messages
stored by 800xA Event Storage Service may be forwarded to an Information Management
message log for extended online storage, Figure 5.1.

3BUF001091-610 A 145
5 Configuring Additional Functionality
5.1 Configuring a Message Log

Figure 5.1: Alarm/Event Message Logging Overview

For this tutorial, an OPC message log is being configured to record alarms generated
by the Count SoftPoint signals that cross their configured limiter trip points (Configuring
Alarm Trip Points on page 31).

5.1.1 Message Log Configuration Procedure

Message logs are added as objects under the applicable Information Management server
in the Node Administration Structure. To do this (reference Figure 5.2):
1. In the Plant Explorer, select the Node Administration Structure.
2. Navigate to and expand the object tree for the node where the message log will be
added (for example, ENG64 in Figure 5.2).

3BUF001091-610 A 146
5 Configuring Additional Functionality
5.1 Configuring a Message Log

3. In the object tree for the selected node, navigate to IM_Inform IT History_YourNode,
Service Provider > Inform IT History Object.
Under the Inform IT History Object, there will be containers for each of the Inform
IT History object types. The History objects (in this case, a message log) must be
instantiated under the corresponding container.

Figure 5.2: Adding a Message Log Object

4. Select the Message Logs, Message Log Container and choose New Object from
the context menu. This displays the New Object dialog with the Inform IT Message
Log object type selected.
5. Enter IMMSGLOG for the object in the Name field. This name must be used to
automatically generate the actual message log name plus the node’s IP address in
the Message Log Configuration dialog.
6. Click Create. This creates a new message log object.

3BUF001091-610 A 147
5 Configuring Additional Functionality
5.1 Configuring a Message Log

5.1.2 Specify Message Log Operating Parameters

Select the Inform IT History Message Log aspect to configure the message log.
1. Select OPC_MESSAGE for the Message Log Type. Do not change the default
access name IMMSGLOG plus the node’s IP address.
2. Specify the log capacity (maximum number of messages the log can hold). Use
defaults for all other log attributes.
The capacity used for the message log should match the selection made when the
Oracle database was created. If the message log capacity exceeds the value specified
during the IM history database creation, the IM message log may run out of space
and other performance problems will eventually occur.
3. Click Apply when done.

5.1.3 Reading the Message Log

This section describes how to read the message log using DataDirect.

Verifying the Data Provider Connection

The ADO data provider for Oracle access must be started in order to access the
Information Management message log. This set-up should already have been done as
part of post-installation. To quickly verify this, launch the ADSS tool from the Windows
Control Panel, Figure 5.3 (Control Panel is in Classic View), and verify that the ADO
data provider is started and the StartupMode is set to AUTOMATIC, Figure 5.4.

Figure 5.3: Launching the ADSS Config Tool From the Windows Control Panel

3BUF001091-610 A 148
5 Configuring Additional Functionality
5.1 Configuring a Message Log

Figure 5.4: Verifying ADO Data Provider Started

If the data provider is started and the log cannot be accessed, check the Oracle Local
Net Service name and Oracle Data Source configurations as described in the
post-installation instructions for Information Management.

Starting DataDirect
Launch DataDirect from Excel. Log in and connect to the data server.

Enabling the Menu/Tool Bar Options for the Message Log Dialog using DataDirect
Inform IT
By default, the menu and tool bar options for the message log dialog are not displayed.
They must be enabled via the View tab on the options dialog. To do this click the options
button on the tool bar (1), then select the View tab (2) and check the Message Log check
boxes in the Inform IT section (3), Figure 5.5. Click OK (4).

3BUF001091-610 A 149
5 Configuring Additional Functionality
5.1 Configuring a Message Log

Figure 5.5: Enabling the Message Log Tool Bar and Menu Options

Retrieving Messages using DataDirect Inform IT Toolbar

1. Specify starting cell where the query result will be displayed. Then click the Message
Log button, Figure 5.6.

Figure 5.6: Message Log Button

2. Select the OPC/Audit Trail tab, Figure 5.7.

3. Select the log name from the pull-down list, then specify the time range, and other
criteria to retrieve the required data.
4. Select the OPC attributes to retrieve, for example, LOCALTIME, SOURCE,
MESSAGE, CONDITION, and SUB_COND.

3BUF001091-610 A 150
5 Configuring Additional Functionality
5.1 Configuring a Message Log

5. Click OK.

Figure 5.7: Message Log - OPC/Audit Trail Tab

The query result is output to the active worksheet, Figure 5.8. The presentation is
formatted according to formatting options which are available directly on the
corresponding tab.

3BUF001091-610 A 151
5 Configuring Additional Functionality
5.2 Configuring Historical Data Archiving

Figure 5.8: Message Retrieval Result

6. Optionally, save the file as C:\Data\Reports\Output\IMMSGLOG.xls.

5.2 Configuring Historical Data Archiving

The archive function supports permanent offline storage for:
• Numeric process data stored in history logs,
• Finished reports stored in report logs or stored as FileViewer aspects,
• Production data from batch control applications and stored in Production Data Logs
(PDLs),
• Alarm messages,

3BUF001091-610 A 152
5 Configuring Additional Functionality
5.2 Configuring Historical Data Archiving

• Event messages (including audit trail events), and

• System messages generated by 800xA system applications and stored in message
logs.
This tutorial shows how to archive numeric historical data (steps 1-4). Archival for other
data types is similar. The tutorial in steps 5-7 describes how to access your archive data.
1. Adding an Archive Device on page 153.
2. Adding the Archive Group Object on page 157.
3. Adding Archive Groups on page 158.
4. Setting Up the Archive Schedule for an Archive Group on page 160.
5. Publishing an Archive Volume on page 165.
6. Accessing Published Logs on page 166.
7. Viewing Published Archive Data with DataDirect on page 170.

5.2.1 Adding an Archive Device

Archiving is managed by one or more archive device objects which are configured in the
Node Administration Structure. An archive device is a logical entity that defines where
and how archive data is written. Every storage device used for archiving must have at
least one archive device aspect configured for it.
To add an Archive Device object (reference Figure 5.9 for steps 1-4):
1. In the Plant Explorer, select the Node Administration Structure.
2. Expand the object tree for the node where the archive device will be added (for
example, ROC90 in Figure 5.9).
3. In the object tree for the selected node, expand the IM_Industrial IT
Archive_NodeName, Service Provider and select the Industrial IT Archive object.

3BUF001091-610 A 153
5 Configuring Additional Functionality
5.2 Configuring Historical Data Archiving

4. Select the Archive Service Aspect from this object’s aspect list.

Figure 5.9: Adding an Archive Device in the Node Administration Structure

5. Click Archive Device in the Create New Archive Object section. This displays the
New Archive Device dialog, Figure 5.10.

Figure 5.10: New Archive Device Object Dialog

3BUF001091-610 A 154
5 Configuring Additional Functionality
5.2 Configuring Historical Data Archiving

6. Enter a name for the object in the Name field, for example: ArchDev1, then click
OK.
This adds the Archive Device object under the Industrial IT Archive object and
creates and opens an Archive Device aspect for the new object. Use this aspect to
configure the device. The Archive Device aspect Config view is shown in Figure
5.11.

Figure 5.11: Archive Device Aspect Configuration View

3BUF001091-610 A 155
5 Configuring Additional Functionality
5.2 Configuring Historical Data Archiving

7. Table 5.1 describes the parameters which MUST be configured for archive. There
are several parameters related to features which are useful and highly recommended,
but which are not covered here. For example, it is strongly recommended that the
archive backup feature be used. These features are fully covered in the section on
Archiving in System 800xA Information Management Configuration Instruction
(3BUF001092*).

Table 5.1: Archive Device Configuration Parameters

Field Value Explanation
Archive Path c:\Archive1 This is the location where archive data will be written on
the hard disk. A directory MUST be included in the path
when using a hard disk media.
Device Type Disk Drive
Device Behavior Wrap When Full
Volumes 3 Number of volumes on the media that this archive device
can access. Creates specified number of Archive Volume
object under the Archive Device object,
Volume Quota 650 Size of each volume in megabytes (100M min). Size
volumes on hard disk to match size of ROM media to which
the archive data will be copied, for example 650 MB for CD
ROM, or 4000 MB for DVD.
Volume Name 1 Number is incremented and appended to the Volume ID
Counter each time the volume is initialized. This makes unique
volume ID. Use the default.
OverWrite Timeout 1 hour The time since the last write to an archive volume before
it will be overwritten.

8. Click Apply to the Archive Device dialog.

Activate the Archive Device

The device must be active in order to archive data to, or restore data from the device. If
the device was not activated during configuration, go to the main view of the Archive
Device aspect and choose Activate or Deactivate from the Actions button.

3BUF001091-610 A 156
5 Configuring Additional Functionality
5.2 Configuring Historical Data Archiving

Each new archive volume must be initialized prior to archiving data on it. For scheduled
archives, volumes are automatically initialized if the device behavior is set to Advance
When Full or Wrap When Full. For manual archives, the volume must be manually
initialized. Select the archive volume and choose the Initialize command from the Action
button or context menu.

5.2.2 Adding the Archive Group Object

Archive groups support scheduled or manual archiving for a group of logs as a single
unit. This is done through an archive group object. One or more archive groups may be
added to this object. Each group specifies a set of items (logs and/or aspect objects) to
be archived as a unit.
Typically, this object is added under the Industrial IT Archive object in the Node
Administration Structure. To do this:
1. In the Plant Explorer, select the Node Administration Structure.
2. Navigate to and expand the object tree for the node where the archive group is to
be added.
3. In the object tree for the selected node, expand the IM_Industrial IT
Archive_NodeName, Service Provider and select the Industrial IT Archive object.
4. Select the Archive Service Aspect from this object’s aspect list.
5. Click the Archive Group button. This displays the New Archive Group dialog, Figure
5.12.

Figure 5.12: New Archive Group Object Dialog

6. Enter a name for the object in the Name field, then click OK.
This adds the Archive Group object under the Industrial IT Archive object and creates
an Archive Group aspect for the new object.

3BUF001091-610 A 157
5 Configuring Additional Functionality
5.2 Configuring Historical Data Archiving

5.2.3 Adding Archive Groups

Use this aspect to configure one or more archive groups:
1. Use the context menu inside the archive groups window (or click Actions) and
choose New Group, Figure 5.13. This displays the Add Archive Group dialog.

Figure 5.13: Adding an Archive Group

2. Use this dialog to specify the Group name, description (optional), and the Industrial
IT Archive Service Group whose service provider will manage this archive group,
Figure 5.14. Click OK when finished.

Figure 5.14: Add Archive Group Dialog

3. Repeat this to add as many groups as required.

4. Click Apply in Archive Group aspect view.

3BUF001091-610 A 158
5 Configuring Additional Functionality
5.2 Configuring Historical Data Archiving

Adding Entries to Archive Groups

This procedure specifies the logs (and/or objects) to be archived as part of this archive
group. Different entry types can be mixed in the same group. To add entries:
1. Select the archive group from the list of archive groups and choose New Entry from
the context menu, Figure 5.15.

Figure 5.15: Adding a New Entry

This displays the Add Group Entry dialog.

2. Use this dialog to select an entry type. In this case use the default (Numeric), Figure
5.16, then click OK. The other options are described in the section on configuring
archive in the Information Management Configuration book.

Figure 5.16: Add Archive Group Dialog, Entry Type

Selecting this option displays the Add Archive Group Numeric Log Entry dialog,
Figure 5.17.
3. Use this dialog to browse the aspect directory for the object whose property log(s)
will be included in the archive group. In this case, select the SoftPoints object (or
the Generic Control Network object).
4. Check the Include Child Objects check box to include logs for all child objects of
the selected object (all instantiated SoftPoint objects in the Generic Control network).

3BUF001091-610 A 159
5 Configuring Additional Functionality
5.2 Configuring Historical Data Archiving

5. Set the Collector Link Filter to use the IM History Log.

6. Click OK.
7. Click Apply and close the dialog.

Figure 5.17: Add Archive Group Numeric Log Entry, IM Objects Entry

To set up a schedule for an archive group, see Setting Up the Archive Schedule for an
Archive Group on page 160.

5.2.4 Setting Up the Archive Schedule for an Archive Group

Scheduling instructions for an archive group are specified by adding a job in the
Scheduling Structure, and configuring the job’s scheduling definition aspect. The schedule
may be cyclic, periodic, weekly, monthly, a list of dates and times, or conditional. In
addition to periodic or event-driven scheduling, manual archive operations may be
executed on demand. The schedule is associated with a specific archive group via the
Archive action aspect which must be added to the job object.
This section quickly demonstrates how to add a job and use the scheduling definition
aspect to set up a periodic schedule. It also describes how to add and use the Archive
action aspect. For further information on jobs and scheduling options, refer to the section
on scheduling in the System 800xA Information Management Data Access and Reports
instruction (3BUF001094*).

3BUF001091-610 A 160
5 Configuring Additional Functionality
5.2 Configuring Historical Data Archiving

Adding a Job and Specifying the Schedule

Jobs are created in the Scheduling Structure. To create a job:
1. In the Plant Explorer, select the Scheduling Structure.
2. Select Job Descriptions and choose New Object from the context menu, Figure
5.18.

Figure 5.18: Adding a New Job Object for Archive Schedule

3. Add the Job object as a Job Description object, Figure 5.19. Assign the object a
logical name.

Figure 5.19: New Object Dialog

3BUF001091-610 A 161
5 Configuring Additional Functionality
5.2 Configuring Historical Data Archiving

4. Click Create. This creates the new job under the Job Descriptions group, and adds
the Scheduling Definition aspect to the object's aspect list.
5. Click on the Scheduling Definition aspect to display the configuration view, Figure
5.20. This figure shows the scheduling definition aspect configured as a periodic
schedule. A new archive will be created every three days, starting June 5, 2010 at
7:30 PM, and continue indefinitely.

Figure 5.20: Scheduling Definition Configuration View

Adding and Configuring the Archive Action

Actions are implemented as aspects on an object which is on or under a job description
in the Scheduling Structure.

3BUF001091-610 A 162
5 Configuring Additional Functionality
5.2 Configuring Historical Data Archiving

To add an action:
1. Select the Job object (for example ROC90Archive in Figure 5.21) and choose New
Aspect from the context menu.

Figure 5.21: Adding an Action Aspect

2. In the New Aspect dialog, select Action Aspect from a list presentation. Use either
the default aspect name, or specify a new name.
3. Click Create to add the Action aspect to the job.
4. Click on the Action aspect to display the configuration view.

Figure 5.22: Action Aspect Configuration View

3BUF001091-610 A 163
5 Configuring Additional Functionality
5.3 Accessing Archive Data

5. Select Archive Action from the Action menu.

6. Select the archive group to be scheduled by this action (in this case
ArchiveGroup1:ROC90Numeric).
7. Select the Service Group (IM_ROC90).
8. Select the Archive Device (ArchDev1).
9. Click Apply. The defaults may be used for all other settings.

Performing a Manual Archive

To have archive data to view in Viewing Published Archive Data with DataDirect, do the
following.
1. Go to the Node Administration Structure.
2. Select the Archive Group object for the Industrial IT Archive of the selected node.
3. Select the Archive Group aspect.
4. Select the Archive group and use the context menu to select Manual Archive...
5. Click OK in Manual Archive dialog with Device as ArchDev1 and Volume as 1.

Archive Volume 1 must be initialized manually prior to manual archive.

5.3 Accessing Archive Data

In order for client applications such as DataDirect to access archived historical data,
either restore the archived data restored from the archive media to the restored History
database, or publish the archive volume. The method used depends on the type of entry.
For property logs and profile logs, the only method is to publish an archive volume to
make the archived data available directly from the archive media. Publishing is simpler
and more efficient than restoring the archived data. The contents of a complete volume,
or even multiple volumes can be published in relatively few steps. Also, this method does
not require the archive data to be written to Oracle tables in the restored database. Since
Oracle tablespace is limited, the publishing method is used to expose a larger amount
of archive data for client applications at any one time.

3BUF001091-610 A 164
5 Configuring Additional Functionality
5.3 Accessing Archive Data

5.3.1 Publishing an Archive Volume

Archive volumes support viewing of archive data (through the corresponding archive
volume aspect). The hard disk media can be partitioned into any number of archive
volumes.
Publishing may be is performed via either an archive device aspect, or an archive volume
aspect. This lesson shows how to use the archive device aspect, Figure 5.23. Select the
volume to be published and choose Publish from the context menu.

Figure 5.23: Publishing a Volume

3BUF001091-610 A 165
5 Configuring Additional Functionality
5.3 Accessing Archive Data

5.3.2 Accessing Published Logs

Published logs can be accessed by external applications such as DataDirect as easily
as runtime logs. A quick check may also be performed using the Log Configuration
aspect. To do this:
1. Open the Archive Volume aspect from the Archive Device aspect. To do this, select
the volume and choose Open from the context menu, Figure 5.24.

Figure 5.24: Opening an Archive Volume Aspect from the Archive Device Apsect

Reference Figure 5.25 for steps 2 and 3.

2. Select an entry from the list of archive entries (upper pane).
3. In the selected entry’s log list (lower pane), select one or more logs whose published
data is to be viewed.

3BUF001091-610 A 166
5 Configuring Additional Functionality
5.3 Accessing Archive Data

4. Select the log list (lower pane) and choose Platform Info from the context menu.
This displays the Platform Info dialog, Figure 5.26.

Figure 5.25: Selecting Logs Whose Published Data You Want to View

3BUF001091-610 A 167
5 Configuring Additional Functionality
5.3 Accessing Archive Data

5. Select a log from the log list, then double-click the Log Configuration icon in the
selected log’s aspect list (lower pane), Figure 5.26.

Figure 5.26: Platform Info Dialog

This displays the Log Configuration aspect, Figure 5.27. When an archive volume
is published, the Log Configuration aspect will have restored logs (indicated by Rst)
in addition to the runtime logs. For the restored logs, use the Archive tab to view
archive information including status and last archive time.

3BUF001091-610 A 168
5 Configuring Additional Functionality
5.3 Accessing Archive Data

6. To view the published archive data, select a log with the _Rst suffix, select the
Status tab, then click Read, Figure 5.28.

Figure 5.27: Log Configuration Aspect - Archive Tab

Figure 5.28: Viewing Published Archive Data

3BUF001091-610 A 169
5 Configuring Additional Functionality
5.3 Accessing Archive Data

5.3.3 Viewing Published Archive Data with DataDirect

Figure 5.29 shows how to view published archive data using the History Values dialog
in DataDirect.

Figure 5.29: Viewing Published Archive Data With DataDirect

5.3.4 Unpublishing a Volume

The media database files are pre-allocated to a certain size. When there is not enough
room in the files to publish another volume, the files will increase in size. Unpublishing
a volume makes the file space used by that volume available for other volumes to be
published in the future. Therefore, a volume should be unpublished when it is not needed.

3BUF001091-610 A 170
5 Configuring Additional Functionality
5.4 Inform IT Authentication

To do this:
1. Select the volume.
2. Choose Unpublish Volume from the context menu.

Figure 5.30: Unpublishing a Volume

5.4 Inform IT Authentication

Authentication can be configured for certain operations related to Information Management
to help meet FDA 21CFR part 11 requirements. Authentication determines whether or
not approval will be required before a user will be allowed to perform a certain function,
for example: enabling, executing or modifying a calculation.

5.4.1 Configuring Access Control

Inform IT Authentication may be set to one of these levels:
• None (no authentication required).
• Single Authentication (one digitally signed user is approved by entering user name
and password).
• Double Authentication (two digitally signed users are approved by entering user
names and passwords).

3BUF001091-610 A 171
5 Configuring Additional Functionality
5.4 Inform IT Authentication

To configure authentication for a calculation aspect category follow the steps below:
1. Open the Aspect System Structure in the Plant Explorer.
2. Expand the Aspect System Structure and also the Inform IT Calculation Aspect.
3. Select the Calculation, Aspect Category object.
4. Select the Inform IT Authentication aspect in the aspect list.
5. To set Authentication for an Operation:
a. Select the operation. Click Select All for example.
b. Mark the Authentication required. Single Authentication for example.
c. Click Apply.

5.4.2 Checking Access Control

To check authentication:
1. Open the Object Type Structure in the Plant Explorer.
2. Expand the Object Types and also the SoftPoint, SoftPoint Object Types.
3. Select the Counter, SoftPoint, SoftPoint Object Type.
4. Select the Calculation aspect.
5. Click the Save icon. A Save dialog requiring your User ID and Password will display.
6. Enter your administrative user id and password to authorize the save.
As an administrator you have all permissions because the security is turned off. By
default, a user does not have all roles. The First Signature and Second Signature
permissions can be set up for users in the Aspect Category Definition aspect or at the
object level using the Property Override aspect.

3BUF001091-610 A 172
6 Batch Integration

6 Batch Integration

The purpose of this section is to create a working 800xA application using Batch
Management and follow the flow of information from Batch Management into the
Information Manager, out to reports, and off line storage of the Batch Production Data
in an archive.
The lessons in this section show you how to:
• Configure Information Management for Batch.
– Add Batch Specific Message Log.
– Set Up the Batch Report Job.
– Set Up Batch Archive and aging of the online data.
• Configure Batch for Information Management. This covers
– What is required in a batch recipe to populate the Production Data Log.
– Passing parameters from the Batch Recipe to the Schedule argument structure
and finally as parameters into the report itself.
• Viewing the Executed Batch Report.
• Additional Lessons.
– Creating Reports using Typical Queries and Views.
– Batch Archiving.
It is expected that you have worked through the lessons in the previous sections before
using the lessons here.

3BUF001091-610 A 173
6 Batch Integration
6.1 PDL for Batch Management Overview

6.1 PDL for Batch Management Overview

The Production Data Log (PDL) and OPC message Log applications support data storage
and retrieval for Batch Management. PDL software is an option for the Information
Management History Server function. PDLs are History logs that store production data
such as batch start/end times, batch variables, and recipe data. PDL supports collection,
storage, and retrieval of this production data for presentation in batch reports.
The current architecture of the Batch Management interface to Information
Management does not support the recording of the Batch Recipes (PFCs) to more
than one Information Management PDL. The PFC is guaranteed to be on one of the
Information Management Server nodes. If trying to view a PFC from a PDL on one
Information Management Server node results in one not being found, look for the
PFC on another Information Management Server node.

The PDL Extractor can only be used for recipes from PDL that have not been restored.

Batch Management can:

• Send batch information to the PDL. Batch automatically sends BatchID and start/end
times for different task types: Campaign, batch, unit procedure, operation and phase.
• Send history associations to create time markers for specified numeric and event
logs.
• Send variable/tag data to be stored with the batch.
• Send batch procedures to the PDL.
To get other data into a report, it must be planned for in the recipe. The following must
be manually added to the Batch Recipe in order for it to show up in PDL.
• Trend associations.
• Batch Variables.
• Phase Variables.
A Series of database tables and views provide easy access to the information using
Batch name as the primary key.

3BUF001091-610 A 174
6 Batch Integration
6.2 Configure Information Management for Batch

6.2 Configure Information Management for Batch

Batch data can be sent to and stored in a production data log (PDL) and a batch specific
message log on the Information Management server. Information Management can be
used for batch to batch analysis, batch reports and batch trending. It does this by providing
a hierarchical history of batch data and events and custom organization, storage, archival,
and retrieval of batch data and events.

6.2.1 Add Batch Specific Message Log

The PDLMSGLOG log type is a special implementation of the OPC_MESSAGE log type
for storing batch events related to Batch Management.
1. Open the Node Administration Structure / node name / IM_Inform IT History_node
name, Service Provider / Inform IT History Object / Message Logs.
2. Create a new Inform IT Message Log object and Name it PDLMSGLOG. When this
access name is entered, the IP address for the local History server is automatically
appended to the access name.
3. Set the Message Log Type to OPC_MESSAGE.
4. Set the Capacity to 1000.
5. Click Apply. When changes are applied, the IP address of the local History server
is automatically appended to the PDLMSGLOG object name.
6. Click Mode and set it Active.

6.2.2 Set Up the Batch Report Job

1. Open the Scheduling Structure.
2. Expand Schedules and Jobs and select Batch Report Crystal, Job Description.
3. Select the Action Aspect and click the Edit Parameter List button.
4. Select PlantName, click Modify and change the Value from Plant Name to Getting
Started Plant and click OK.
The <BatchID> argument is automatically passed to Crystal Reports and included
in the Report Parameters list.
The left-hand side of the assignment represents the report parameter (Excel cell
name for example) as it was defined by the author of the report and the right-hand
side represents the value of the corresponding job argument.
5. Close the Report Parameters dialog.

3BUF001091-610 A 175
6 Batch Integration
6.2 Configure Information Management for Batch

6. To add a time stamp, edit the object patch as follows:

Completed Reports/Crystal/BatchReport_<BatchID>_<TimeStamp>
and click Apply to the aspect view of Action Aspect.
7. Select the Scheduling Definition aspect.
8. Set the Schedule as Periodic Schedule, leave it disabled, and set the Service Group.
9. Click Apply.

6.2.3 Set Up Batch Archive

To allow batch archiving, do the following.
1. Open the Node Administration Structure / node name / IM_Inform IT History_node
name, Service Provider / Inform IT History Object / Production Data Logs.
2. Open the Inform IT PDL Auto Archive aspect.
3. Set the Archive Device to ArchDev1 which was created when Adding an Archive
Device on page 153.
4. Set the Archive Mode to: On Batch End.
5. Set the Archive Delay to: 5 Minutes
6. Set the aging of the online data by setting the following:
• Archive Mode to On Batch End
• Delete Mode to After Archive
• Archive Delay to 15 Minutes
• Delete Delay to 30 Days.
7. Click Apply.

3BUF001091-610 A 176
6 Batch Integration
6.3 Configure Batch for Information Management

6.3 Configure Batch for Information Management

This section describes how to create a batch application and populate the Production
Data Log as a result of using the following.
• BMA Compute blocks write task variables into PDL.
• BMA Data Collection blocks set start & stop batch trend collection association time
values.
• BMA Schedule Job block automatically generates reports and passes parameters
to the Scheduler. Execute the report At End of Batch. The BMA Schedule Job block
can run multiple Jobs.
To continue the example, add the equipment and recipe procedure as described in the
following and then run the batch.

6.3.1 Adding Equipment and Variables

Add Batch Equipment aspect to a Generic Object as follows:
1. Open the Functional Structure.
2. Create a New Object (Generic Type) in the Root, Domain and Name it
BatchGenericUnit.
3. Create a Batch Equipment aspect in the BatchGenericUnit object (listed under Batch
Management Equipment).
4. In the Main View, General Tab set the Controller Type to None (Pseudo).
5. On the Equipment Attributes tab, click the Append new unit attribute button thrice
to create three rows.
6. Enter the following into rows 1, 2 and 3:

Table 6.1: Details on Equipment Attributes tab

Row Name Description Type Default Low High

1 Temp Unit Temperature Float 5.5 0.0 212.0
2 Level Unit Level Integer 76 0 100
3 ExtSignal SoftPoint OPC Signal*
Datapoint

* Signal = Root/SoftPtNetwork/SoftPoints/Counter1/Counter1 Count:Value

3BUF001091-610 A 177
6 Batch Integration
6.3 Configure Batch for Information Management

Click the Save button. The completed aspect is shown in Figure 6.1.

Figure 6.1: Batch Equipment Aspect Added

6.3.2 Adding Recipe Procedure

Add a Recipe Procedure, Figure 6.2, as follows:
1. Open the Procedure Structure.
2. Create a New Object (Procedures) and Name it Batch History Reports.
3. In Batch History Reports, create a New Object (Recipe Procedure) and Name it
BatchHistReport.
4. Select the Development Procedure aspect and select Edit Procedure from the
toolbar menu selections. This will open the Procedure Configuration tool.

3BUF001091-610 A 178
6 Batch Integration
6.3 Configure Batch for Information Management

5. Select Tools > Procedure parameters and enter the following:

Parameter 1: Equipment
Type: Equipment List
Default Value: BatchGenericUnit(Root)
Constraint: BatchGenericUnit (from the Configure Equipment List)
Parameter 2: Yield
Type: Float
Description: red dye
Default Value: 30.0
Low Range: 0.0
High Range: 30000.0
Eng. Units: Gallons
6. Create and connect the following objects, Figure 6.2, as described below. Delete
the default connection between Start and End.

Figure 6.2: Batch History Report Recipe Procedure

Create and Connect Acquire Unit (Acquire Equipment)

1. Place a BMA object below Start.
2. Select Edit > Block Properties (or select the BMA object using the middle mouse
button).
3. Select Acquire Equipment and click Next.

3BUF001091-610 A 179
6 Batch Integration
6.3 Configure Batch for Information Management

4. Enter the Block Label as Acquire Unit.

5. Select Equipment parameter and add it (>) to the Selected Equipment list.
6. Click OK.
7. Connect Start to Acquire Unit.

Create and Connect Start History (Batch Data Collection)

1. Place a BMA object below Acquire Unit.
2. Select Edit > Block Properties (or select the BMA object using the middle mouse
button).
3. Select Data Collection and click Next.
4. Enter the Block Label as Start History.
5. Select the Append data collection icon to add a row.
6. Enter the Logical Name as: “Tag1”
7. Select a unique OPC Item (...) and browse in the Control Structure to SoftPoints,
Counter1 Count and select Value as the OPC Point.
8. Click OK.
9. Leave the Data Collection Rate as: Start.
Start will flag the time the block was executed as the start time of the History
Association.
10. Click OK.
11. Connect Acquire Unit to Start History.

Create and Connect Restart Time (Compute)

1. Place a BMA object below Start History.
2. Select Edit > Block Properties (or select the BMA object using the middle mouse
button).
3. Select Compute and click Next.
4. Enter Restart Time as the Block Label.
5. Select the Append expression icon twice to add two rows.

3BUF001091-610 A 180
6 Batch Integration
6.3 Configure Batch for Information Management

6. Enter these expressions:

Row 1: bdbput("restartTime",time()+60)
Row 2: bdbput("timeCheck.in",time())
7. Click OK.
8. Connect Start History to Restart Time.

Create and Connect Delay (Transition)

1. Place a Transition object below Restart Time.
2. Select Edit > Block Properties (or select the BMA object using the middle mouse
button).
3. Select Transition and click Next.
4. Enter the Block Label as Delay.
5. Enter this Transition:
time()>=bdbget("restartTime")

6. Click OK.
7. Connect Restart Time to Delay.

Create and Connect Release Unit (Release Equipment)

1. Place a BMA object below delay.
2. Select Edit > Block Properties (or select the BMA object using the middle mouse
button).
3. Select Release Equipment and click Next.
4. Enter the Block Label as Release Unit.
5. Select Equipment parameter and add it (>) to the Selected Equipment list.
6. Click OK.
7. Connect Delay to Release Unit.

Create and Connect Batch Report (Schedule Job)

1. Place a BMA object below Release Unit.
2. Select Edit > Block Properties (or select the BMA object using the middle mouse
button).

3BUF001091-610 A 181
6 Batch Integration
6.3 Configure Batch for Information Management

3. Select Schedule Job and click Next.

4. Enter the Block Label as Batch Report.
5. Expand Schedules and Jobs, select Batch Report Crystal and add (>) it to the
Scheduled Jobs list.
6. Change the Scheduled At to: At batch end.
7. Click OK.
8. Connect Release Unit to Batch Report.

Create and Connect End Time (Compute Block)

1. Place a BMA object below Batch Report.
2. Select Edit > Block Properties (or select the BMA object using the middle mouse
button).
3. Select Compute Block and click Next.
4. Enter the Block Label as End Time.
5. Select the Append data collection icon to add a row.
6. Enter the expression:
Row 1: bdbput("timeCheck.out",time())
7. Click OK.
8. Connect Batch Report to End Time.
9. Connect End Time to End.
a. Select File > Save and the File > Exit.
b. Select Development Procedure, and then select Approve Procedure from the
context menu. Select a reason (Approve) and click OK.
This sets up the basic Batch Recipe Procedure.

6.3.3 Run the Batch From the Batch Overview

Running the batch automatically passes all necessary values that need to be mapped
into the standard Batch Crystal Report.
1. Open the Library Structure.
2. Open Batch Management > Batch Management, Batch AE and select the Batch
Overview aspect.

3BUF001091-610 A 182
6 Batch Integration
6.4 Viewing the Executed Batch Report

3. Click Add.
4. Use Procedure to drill down and select BatchHistReport.
5. Set Batch ID to Auto.
6. Set Scheduled Status to Scheduled.
7. Click Apply.

6.3.4 Verify Output using PDL Browser

The PDL Browser can be used to verify what data was output as follows.
1. Open the PDL Browser.
2. Select the Task Type of Batch.
3. Click the Search button.
4. From the Search Results, select the Batch that just ran.
5. Select the tabs (Variables, Resources, Messages, etc.) to view the output).

6.4 Viewing the Executed Batch Report

After running the Batch Recipe Procedure, view the report as follows.
1. Open the Scheduling Structure.
2. Expand Reports and then the Completed Reports folder.
3. In Crystal, select the executed report.
4. Select the File Viewer aspect to view the report.
As an alternative, to run a report manually:
1. In the Scheduling Definition aspect for the report, use the Arguments tab and enter
the batchID to the name of the Batch that just ran or an earlier one.
2. On the Schedule tab, click Run Now. The job will show in the Running Jobs list and
then will be put into Reports / Completed Reports / Crystal.
3. Select the File Viewer aspect for the Completed Report.

3BUF001091-610 A 183
6 Batch Integration
6.5 Additional Lessons

6.5 Additional Lessons

To help you understand the relationships between Batch, Information Management and
Reporting refer to the following topics:
• Views for Batch Management on page 184
• Creating Reports using Typical Queries and Views. on page 184
• Batch Archiving on page 185

6.5.1 Views for Batch Management

There are 12 views designed specifically for Batch Management applications:
• Batch_Header.
• Batch_Equipment.
• Batch_Vars_MatchedPair.
• Batch_Variables.
• Batch_Procedures.
• Batch_ProcessEvents.
• Batch_AuditEvents.
• Batch_CommentEvents.
• Batch_Events.
• Batch_BatchMgrEvents.
• Batch_SystemEvents.
• Batch_Trend.

6.5.2 Creating Reports using Typical Queries and Views.

Refer to System 800xA Information Management Data Access and Reports
(3BUF001094*) for detailed information on Creating a Report with Crystal Reports in
Section 5, Creating Reports. The tutorial shows how to build a report for historical process
data related to a batch. The Batch ID is dynamically updated for each report. The 800xA
Batch Management application writes the batch ID into an argument value which is then
passed into the report as a parameter. Refer to the reports provided within the 800xA
system for additional information. For Crystal reports, examine the Master_Batch report.
This report contains subreports for each of the database views including charting of
numeric data.

3BUF001091-610 A 184
6 Batch Integration
6.5 Additional Lessons

Reports can be started automatically upon batch completion using the scheduler.
Parameter values are passed from Batch Management to the scheduler. The report
parameters are passed into the report. The Batch Identifier parameter (one of the key
parameters for the views referenced in the previous paragraphs) is one of the parameters
passed into the report.

6.5.3 Batch Archiving

Archiving batch data has no effect on the uniqueness of the batch ID. Even after data
associated with a batch ID has been removed from the system, a record of the batch ID
will be retained on the system. The batch ID can never be reused.
Automatic archiving of batch data is established as an overall archive policy in the 800xA
Node Structure for the archive service. The archive policy provides the ability to archive
data based on batches and retain the data online for a period of time after the data has
been archived to safe offline storage. It is important to establish an archive policy to
ensure that data is managed and preserved to offline storage as well as ensure proper
performance of the system.

Verify that Batch Archive Completed

Open the Archive Volume aspect. The information provided on this aspect is organized
in three parts. The top section provides information for the selected volume. The middle
section lists the entries currently stored on this volume. When an entry is selected in the
middle section, the logs that were archived for the selected entry are shown in the bottom
section.

Manual Archiving
Manual archival is performed via the View Production Data Logs aspect.
1. Select the Node Administration structure in the Plant Explorer.
2. Select the History service provider for the node where the logs to be archived are
located (IM_InformIT History_YourNode, Service Provider).
3. From the History service provider, navigate to and select the Production Data Logs
group under InformIT History Object
4. Then select the Inform IT History View PDL aspect from the aspect list.
5. The log class for manual archival is Run Time. Use the Log Type pull-down list on
the Retrieve tab to select the Run Time option.
6. Click Apply. This will display all PDLs for the selected log type.

3BUF001091-610 A 185
6 Batch Integration
6.5 Additional Lessons

7. Select one PDL from the list to retrieve its corresponding tasks.
The tasks are displayed in the lower pane beneath the log list. The Filter Tasks tab
is used to apply a filter to reduce the retrieved Task list.
8. To archive the entire PDL, click the Archive PDLs tab.
9. Specify the Archive Device (name of the archive device where the logs will be
copied) and Surface (surfaces corresponding to the selected archive device).
Optionally, enter a description.
10. Click Archive when finished.
To archive selected tasks, click the Archive Tasks tab. This tab is identical to the Archive
PDLs tab, except that the Archive button is not active until tasks have been selected
from the Task list. Select the tasks from the Task list, fill in the information, then click
Archive.

6.5.4 Looping Recipe Limitations

Information Manager does not support looping recipes that loop more than 999 times.
If a looping recipe is created that is approaching or exceeds 999 iterations the
Operator/User will be notified as detailed below. An example of a looping recipe is shown
in Figure 6.3.

3BUF001091-610 A 186
6 Batch Integration
6.5 Additional Lessons

Figure 6.3: An example of a Looping Recipe

3BUF001091-610 A 187
6 Batch Integration
6.5 Additional Lessons

6.5.5 User Message Formats

1. Once the recipe reaches 900 iterations the following message is displayed in the
event list on every 10th additional iteration. (Here x can be 910, 920, ..., 990)
"<Batch Campaign/Job name> with loop config for <Batch Procedure/phases> will
have PDL Overwritten for 999th Occurrence; It has reached <x> iterations against
999 being max. Please Reconfigure Batch."

Here x can be (910/920/..990)

2. Once the recipe exceeds 999 iterations the PDL data will still be saved as part of
999th iteration even though the occurrence number is incorrect. Data will continue
to be stored until the the batch exceeds 1500 iterations. The following message is
displayed in the event list when this situation occurs.
"PDL is Overwritten at 999th Occurrence for <Batch Campaign/Job name> with loop
config in <Batch Procedure/phases>. <x> being Occurrence; PDL will be lost after
1500 iterations. Please Reconfigure Batch."
3. For recipes that exceed 1500 iterations the following message will be displayed in
the Event List.
"PDL Data is lost for <Batch Campaign/Job name> with loop config in <Batch
Procedure/phases>. Current Iteration is <x> against 1500 being max for 'Overwrite'.
Please Reconfigure Batch.

3BUF001091-610 A 188
Revision History
Revision History

Revision History

This section provides information on the revision history of this User Manual.

The revision index of this User Manual is not related to the 800xA 6.1 System Revision.

Revision History
The following table lists the revision history of this User Manual.

Revision
Description Date
Index
A Published for 800xA 6.1 September 2018

3BUF001091-610 A 189
3BUF001091-610 A 190
Index

Index
A
archive, 152 H
group, 157, 160 hysteresis, 33
archived logs access, 164
Authentication, 171 L
limiters, 31
B log
bring on line, 46 numeric, 49

C O
calculation aspect ODA server, 110
view, 36
cyclic schedule, 38 R
report log, 141
D restored log access, 164
data
archive, 153 S
softpoint object
E instantiate, 41
export report output, 100, 138

3BUF001091-610 A 191
3BUF001091-610 A 192
www.abb.com/800xA 800xA is a registered or pending trademark We reserve all rights to this document
of ABB. All rights to other trademarks reside and the items and images it contains.
www.abb.com/controlsystems with their respective owners. The reproduction, disclosure to third parties
or the use of the content of this document
We reserve the right to make technical – including parts thereof – are prohibited
changes to the products or modify the without ABB’s prior written permission.
3BUF001091-610 A

contents of this document without prior

notice. With regard to purchase orders, Copyright © 2019 ABB.
the agreed particulars shall prevail. All rights reserved.
ABB does not assume any responsibility
for any errors or incomplete information in
this document.