Professional Documents
Culture Documents
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.
Table of Contents
3BUF001094-610 A 5
Table of Contents
3BUF001094-610 A 6
Table of Contents
3BUF001094-610 A 7
Table of Contents
4 DataDirect Inform IT
4.1 User Access to DataDirect Inform IT Add-in Tools ............................................ 131
4.2 Populating Pick Lists for Data Retrieval/Entry Dialogs ..................................... 131
4.3 Data Access Methods ....................................................................................... 131
4.4 Licensing ........................................................................................................... 134
4.5 Login ................................................................................................................. 135
4.5.1 Perpetual Login ....................................................................................135
4.5.2 Login As Needed for Ad-hoc Data Requests ....................................... 135
4.5.3 Using the Login Dialog .........................................................................136
4.5.4 User ..................................................................................................... 136
4.5.5 Password ............................................................................................. 136
4.5.6 Host ......................................................................................................137
4.5.7 Save Settings .......................................................................................137
4.6 Reading and Writing Process Values For Inform IT .......................................... 137
4.7 Using the Inform IT Process Values Dialog .......................................................138
4.7.1 Reading Process Values ...................................................................... 140
4.7.2 Selecting Objects to Query .................................................................. 140
4.7.3 Selecting OPC Tags .............................................................................140
4.7.4 Selecting ABB OCS Tags ....................................................................141
4.7.5 Writing Process Values ........................................................................ 144
4.8 Reading/Writing History Data ............................................................................ 162
4.9 Using the Inform IT History Values Dialog ........................................................ 162
4.9.1 Retrieving History Data ........................................................................ 164
4.9.2 Selecting the Data Provider ................................................................. 165
4.9.3 Retrieval Type ...................................................................................... 166
4.9.4 Selecting History Objects .....................................................................167
4.9.5 Log Calculation Algorithm .................................................................... 169
4.9.6 Number of Values ................................................................................ 172
3BUF001094-610 A 8
Table of Contents
3BUF001094-610 A 9
Table of Contents
3BUF001094-610 A 10
Table of Contents
3BUF001094-610 A 11
Table of Contents
3BUF001094-610 A 12
Table of Contents
6 Creating Reports
6.1 Report Building Applications ............................................................................. 409
6.2 Implementing Reports ....................................................................................... 410
6.2.1 Example Reports ................................................................................. 411
6.3 Setting Up the Report Action and Scheduling Definition ................................... 418
6.3.1 Creating Objects and Aspects in the Scheduling Structure ................. 418
6.3.2 Defining the Report Action ................................................................... 419
6.3.3 Selecting the Report Action ................................................................. 420
6.3.4 Selecting the Report Template .............................................................421
6.3.5 Output Options .....................................................................................421
6.3.6 Report Parameters ...............................................................................423
6.3.7 Export File ............................................................................................437
6.3.8 Printer .................................................................................................. 444
6.3.9 Email .................................................................................................... 444
3BUF001094-610 A 13
Table of Contents
7 Scheduling
7.1 Using Scheduling .............................................................................................. 473
7.2 Adding a Job Description Object ....................................................................... 474
7.2.1 Scheduling Definition View .................................................................. 475
7.2.2 Defining the Schedule ..........................................................................476
7.2.3 Cyclic Scheduling .................................................................................477
7.2.4 Periodic Scheduling ............................................................................. 477
7.2.5 Weekly Scheduling .............................................................................. 478
7.2.6 Monthly Scheduling ..............................................................................480
3BUF001094-610 A 14
Table of Contents
8 Tag Management
8.1 User Tag Management (UTM) ...........................................................................503
8.1.1 Starting UTM ........................................................................................503
8.1.2 Displaying User Tags, Hierarchical View ............................................. 505
8.1.3 Displaying User Tags, Search View ..................................................... 506
8.1.4 Displaying User Tags, HDA Browser ................................................... 508
8.1.5 Managing User Groups ........................................................................509
8.1.6 Managing User Tags Using Tag Workspace ........................................ 511
8.2 Using UTM from Desktop Tools ........................................................................ 512
8.3 User Tag Management Status ...........................................................................513
8.4 Information Management Browser .................................................................... 514
8.4.1 Navigation Methods ............................................................................. 516
3BUF001094-610 A 15
Table of Contents
3BUF001094-610 A 16
Table of Contents
3BUF001094-610 A 17
Table of Contents
3BUF001094-610 A 18
Table of Contents
3BUF001094-610 A 19
3BUF001094-610 A 20
About This User Manual
User Manual Conventions
Any security measures described in this User Manual, for example, for user access,
password security, network security, firewalls, virus protection, etc., 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 800xA System.
This User Manual provides instructions for using Information Management DataDirect
and Desktop Trends for data access in the 800xA System. It provides guidelines for
using DataDirect or third party applications to build, schedule, and manage reports for
800xA System applications. The User Manual is intended for anyone that uses the Display
and Client Services and/or third-party applications to access data in the 800xA System.
This User Manual is not the sole source of instruction for this functionality. It is
recommended that you attend the applicable training courses offered by ABB.
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.
3BUF001094-610 A 21
About This User Manual
Terminology
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 System Guide
Functional Description (3BSE038018*). The listing includes terms and definitions that
apply to the 800xA System where the usage is different from commonly accepted industry
standard definitions and definitions given in standard dictionaries such as Webster’s
Dictionary of Computer Terms. Terms that uniquely apply to this User Manual are listed
in the following table.
3BUF001094-610 A 22
About This User Manual
Released User Manuals and Release Notes
A product bulletin is published each time System 800xA Released User Documents
(3BUA000263*) is updated and published to myABB/My Control System.
3BUF001094-610 A 23
3BUF001094-610 A 24
1 Data Access Tools
1.1 Desktop Applications
This section provides a brief introduction to the data access tools provided by the
Information Management Desktop Applications.
3BUF001094-610 A 25
1 Data Access Tools
1.2 Excel Data Access - DataDirect
All desktop applications access data via data providers. Some configuration and set-up
may be required, depending on the application. A brief overview of the data providers is
provided in Data Providers on page 44. Detailed instructions for configuring and managing
data providers are provided in System 800xA Information Management Configuration
(3BUF001092*).
Desktop Applications may be may be installed on nodes that are not loaded with
800xA. Use the following steps to load the software.
1. Mount the System 800xA media on the PC.
2. Navigate to <media>\Applications\Information Management\
3. Right-click the file Install_DesktopToolsForNon-800xA.bat and select Run as
administrator.
3BUF001094-610 A 26
1 Data Access Tools
1.3 DeskTop Trends
3BUF001094-610 A 27
1 Data Access Tools
1.4 Display Services
• The PDL Browser is used to access production data from Production Data Logs
for 800xA Batch Management applications, Batch 300, TCL Batches, and Profile
Historian.
• The Batch to Batch Display combines the functionality of the Trend Display with
the PDL Browser. It is used to easily navigate the PDL structure to find and display
historical trends for different batches.
• The Event Browser is used to retrieve messages from OPC message logs
configured with Information Management - History Server function.
• The SQL Browser is used to run ad-hoc SQL queries. Use it to save a query once
it is run, and then reopen the query for viewing at some time in the future. Also, use
it to delete saved queries.
3BUF001094-610 A 28
1 Data Access Tools
1.5 Reports
1.5 Reports
Reporting functions in the 800xA System are supported by the Display and Client
Services, Application Scheduler with the Report Action plug-in, and the History Server
function.
The Display and Client Services provide tools and data access services that is used to
integrate data into a chosen report building application. The Application Scheduler is
used to set up schedules (periodic, conditional, etc...) for executing the reports. The
Report Action plug-in lets specifies report options such as output destination (Windows
file, Completed Report object, printer, e-mail, history, and so on). The History Server
function provides the means to store finished reports in history, archive the reports to
an offline storage media, and retrieve the reports either from online or offline storage.
The report building applications supported are: DataDirect, Crystal Reports, Microsoft
Excel, and Generic Executable. Crystal reports and Microsoft Excel (without DataDirect
add-ins) require the Open Data Access option to access process and historical data.
The report builder package must be installed on the node with the scheduling server.
Use remote report builder clients to build the report files; however, the files must be
stored locally, and the report builder must also reside locally to support scheduling and
execution via the Scheduler.
3BUF001094-610 A 29
1 Data Access Tools
1.6 Selecting Which Tool to Use
3BUF001094-610 A 30
1 Data Access Tools
1.6 Selecting Which Tool to Use
3BUF001094-610 A 31
1 Data Access Tools
1.6 Selecting Which Tool to Use
To find the tool which best fits the historical data access application, refer to Table 1.1.
Other topics related to historical data access which are covered in this section are:
• Property Log Naming Conventions on page 32.
• Criteria for Selection for Seamless Retrieval on page 34.
• Interpolation on page 37.
• Daylight Savings on page 38.
• Writing to History Logs on page 41.
TC100:MEASURE,Log1
[OPTIONAL FULL OR PARTIAL PATH/]
Object Name
Property Name
Log Name
(as defined when adding the log to a log template)
Figure 1.1: Log Reference for 800xA OPC HDA Server
3BUF001094-610 A 32
1 Data Access Tools
1.6 Selecting Which Tool to Use
$HSTC100,MEASURE-1-o
Use the access name to reference a log when the data source is known but the log name
is not known. When using the access name, History uses the seamless retrieval criteria
(described later in this section) to select the most appropriate log in the data source’s
log hierarchy. Generally, unless other criteria are specified, seamless retrieval selects
the log that has INSTANTANEOUS or AVERAGE as the calculation algorithm, and has
a log period that provides the best coverage of the requested time period.
Use the log name when the seamless retrieval criteria to select the log is unreliable and
the log name of the log that stores the required data is known. For instance, use the log
name to get the log that uses the STANDARD DEVIATION algorithm, and it is known
that this data is stored in $HSTC100,MEASURE-3-o (or $HSTC100,VALUE-3-o).
3BUF001094-610 A 33
1 Data Access Tools
1.6 Selecting Which Tool to Use
Seamless retrieval is only applicable for history logs. This does not apply to trend
logs.
3BUF001094-610 A 34
1 Data Access Tools
1.6 Selecting Which Tool to Use
1. Sort logs by percentage of the time period of the request that the log covers, and
choose the set of logs that are closest in coverage.
For instance, for a request for 24 hours, logs may be sorted as follows in descending
order of preference: 24-hour logs and 168_hour logs, 8-hour logs, and 1-hour logs.
Since the 24-hour logs and 168-hour logs cover 100% of the requested time period,
they are chosen.
2. Search the set chosen in step 1, and find all logs that use the specified calculation
algorithm. Logs that do not use the specified algorithm are dropped from
consideration.
If the algorithm is WILDCARD (no algorithm specified), then the algorithms have
the following order of preference:
a. AVERAGE or INSTANTANEOUS
These algorithms have equal preference. The first one found in the search is
selected, and logs with any other calculation are dropped from consideration.
b. MAX
c. MIN
d. SUM
e. SUM OF SQUARES
f. STANDARD DEVIATION
g. NUM_OF_VALUES
At this point the set of logs still under consideration have the same log period
(closest to percent of coverage of requested time period), and calculation
algorithm.
3BUF001094-610 A 35
1 Data Access Tools
1.6 Selecting Which Tool to Use
3. This set is now sorted, depending on the specified retrieval type. One log is selected
according to retrieval type as follows:
a. If the retrieval type is RAW, one log is selected in the following order of
preference:
1) Pick the log whose storage interval is equal to the time between points in
request.
2) Pick the log whose storage interval is greater than and closest to the time
between points (so request can be completed in one response).
3) Pick the log whose storage interval is less than and closest to the time
between points (more points exist than buffer can hold, MORE_DATA status
is returned).
b. If the retrieval type is INTERPOLATE, one log is selected in the following order
of preference:
1) Pick the log whose storage interval is less than and closest to the time
between points (so interpolation is more accurate).
2) Pick the log whose storage interval is equal to the time between points in
request.
3) Pick the log whose storage interval is greater than and closest to the time
between points.
c. If retrieval type is DISPLAY, one log is selected according to retrieval type as
follows:
1) Pick the log whose storage interval is equal to the time between points in
request. The request is changed to RAW unless the log uses Deadband
compaction, in which case the request is changed to INTERPOLATE/AVE.
2) Pick the log whose storage interval is greater than and closest to the time
between points. The request is changed to INTERPOLATE/AVE.
3) Pick the log whose storage interval is less than and closest to the time
between points. The request is changed to INTERPOLATE/AVE.
3BUF001094-610 A 36
1 Data Access Tools
1.6 Selecting Which Tool to Use
In addition to the seamless algorithm applied for retrieval requests, the following criteria
have been added to better handle selection of a log for a request by access name, when
logs are in a dual configuration:
• Uptime of node where log exists.
• local is chosen over remote (local should always be faster than remote).
• sequence number of log. (with all other conditions equal, the lowest sequence
numbered log is used. Sequence number is the ‘-1-o’ or ‘-2-o’ attached to the
generated log name.
1.6.5 Interpolation
History usually samples the property values at set intervals. When data is requested at
the interval it was stored, the software returns raw data. If data is requested at a different
interval, the software returns an interpolated value. Figure 1.3 shows an example where
data is saved every 10 seconds.
y = 29
2
oy=?
y = 22
1
60 t1 = 70 76 t 2 = 80 90
If the value is requested at second 70, the stored value 22 is returned. If the value is
requested at second 80, the stored value 29 is returned. If the value is requested at
second 76 (in between intervals where the value is stored), the stored values for seconds
70 and 80 are used to perform a mathematical interpolation. In this case, the value 26.2
is returned.
3BUF001094-610 A 37
1 Data Access Tools
1.6 Selecting Which Tool to Use
3BUF001094-610 A 38
1 Data Access Tools
1.6 Selecting Which Tool to Use
Daylight
Saving
Time
Standard
Time
Standard Time
only from this
Point On
Figure 1.4: DataDirect Query Result with Duplicated Time Stamps between 1:00 AM &
1:59 AM
3BUF001094-610 A 39
1 Data Access Tools
1.6 Selecting Which Tool to Use
3BUF001094-610 A 40
1 Data Access Tools
1.6 Selecting Which Tool to Use
Standard
Time
Daylight
Saving
Time
Daylight Saving
Time from this
Point On
Figure 1.6: Example, Transition to Daylight Saving Time using DataDirect
Figure 1.7: Example, Transition to Daylight Saving Time using Desktop Trends
3BUF001094-610 A 41
1 Data Access Tools
1.7 Alarm/Event Messages
3BUF001094-610 A 42
1 Data Access Tools
1.8 Production Data
DataDirect provides tools for querying alarm/event messages by filtered lists which are
configured via Operator Workplace. This requires DataDirect to be installed on a node
with 800xA base system software. For all other desktop tools, or to access messages
that extend beyond the storage limit of the 800xA System software message server,
query the OPC message log. Refer to Table 1.1 for details.
For further guidelines on reading alarm/event messages from the message log, refer to
Section 10 Reading Message Logs.
3BUF001094-610 A 43
1 Data Access Tools
1.9 SQL Access
3BUF001094-610 A 44
1 Data Access Tools
1.10 Data Providers
If not using more than one data provider of a given type, the data access applications
are not required to reference a specific data provider. Data requests will be routed via
the correct data provider based on the type of data being requested. When multiple data
providers of the same type are connected, if a specific data provider is not referenced,
the data request will default to the data provider with channel 0. If a different data provider
needs to be used, it must be explicitly referenced. Each of the client applications use a
different method for referencing data providers.
DataDirect
In DataDirect use the Setup tab on the Options dialog to specify the default data providers
for all dialogs and functions (refer to Data Provider Connections on page 247). Optionally,
choose whether to use channel number or -name. The default setup is to use -name.
When using -name, the default data provider for each data provider type must also be
selected.
DataDirect functions can specify data providers by -name argument when referencing
a data provider other than the default specified in the Options dialog.
Desktop Trends
In Desktop Trends, the Trend and Ticker tools specify the data provider for each trace
on a Trend display (refer to Data Provider Connections on page 247) and tag on a Ticker
(refer to Data Provider on page 345). Data providers are always referenced by -name.
Display Services
In Display Services, data provider references are made in user-configured scripts that
specify the operation of the display elements. All scripting functions EXCEPT data
statements use channel number. The default channel is zero (0). When using the data
statement in a script, and a data provider reference is required, reference the data
provider using its -name argument. For further information regarding display scripts,
display elements, and display building in general, refer to System 800xA Information
Management Configuration for Display Services (3BUF001093*).
3BUF001094-610 A 45
1 Data Access Tools
1.11 Open Data Access
3BUF001094-610 A 46
1 Data Access Tools
1.12 Set-up for SQL*Plus
3BUF001094-610 A 47
1 Data Access Tools
1.12 Set-up for SQL*Plus
1.12.1 ORACLE_SID
Setting this environment variable gives access to a specified Oracle database on the
local server (where SQL*Plus is run). For Information Management applications, set
ORACLE_SID = ADVA. This is the Oracle database installed with Information
Management.
1.12.2 tnsname
Use the Net Configuration Assistant to configure additional net service names to support
SQL*Plus access to remote Information Management servers.
3BUF001094-610 A 48
2 General Information for DataDirect
2.1 User Access to DataDirect Add-in Tools
DataDirect (Excel Data Access) is a desktop tool for integrating information from various
data sources into a Microsoft® Excel spreadsheet. It is implemented as an add-in for
Microsoft Excel that is used to work with industry-standard tools, using familiar techniques
common to other Microsoft Office products. Interactive dialogs and functions are
supported.
Two add-ins are available for DataDirect.
• ABB 800xA DataDirect.msi and
• ABB InformIT DataDirect.msi
This section describes the general information pertaining to both ABB 800xA DataDirect
and ABB InformIT DataDirect.
3BUF001094-610 A 49
2 General Information for DataDirect
2.3 Add-in Tool Capabilities
3BUF001094-610 A 50
2 General Information for DataDirect
2.4 Application Set-up
Figure 2.1: Example - Using DataDirect Add-in Tool for Historical Data Access
3BUF001094-610 A 51
2 General Information for DataDirect
2.4 Application Set-up
3BUF001094-610 A 52
2 General Information for DataDirect
2.4 Application Set-up
3BUF001094-610 A 53
2 General Information for DataDirect
2.4 Application Set-up
7. Make sure the DataDirect check box is checked, then click OK.
3BUF001094-610 A 54
2 General Information for DataDirect
2.4 Application Set-up
3BUF001094-610 A 55
2 General Information for DataDirect
2.4 Application Set-up
3. Click InformIT DataDirect tab and choose Options. Select Setup tab under Options
to find Update Reference button.
4. Click Update References. The Update Function Reference popup displays. Click
Continue updates all worksheets in the selected workbook.
3BUF001094-610 A 56
2 General Information for DataDirect
2.4 Application Set-up
5. After getting the update function references completed message, click OK.
6. After updating the function references, execute each function once, before using
the F9 key to calculate the entire workbook.
Any time functions are disabled and then re-enabled, all functions in the spreadsheet
must be executed individually before the F9 key can be used to calculate the entire
workbook.
• For each function that returns multiple values (for example, ABBGetHistory):
a. Select the cell where the function is defined.
b. Starting with that cell, select a range of cells where the data will be entered.
c. Put the cursor in the formula bar, and then Press CTRL+SHIFT+ENTER.
• For each function that returns one value (for example, ABBGetObj):
a. Select the cell where the function is defined.
b. Put the cursor in the formula bar.
c. Press ENTER.
3BUF001094-610 A 57
2 General Information for DataDirect
2.5 Starting DataDirect
2.6.1 Logging In
DataDirect requires being logged in to a data server. There are two log-in modes.
Perpetual log-in lasts until a log off occurs. Ad-hoc log-in lasts until the current dialog is
closed. Refer to Using DataDirect Dialogs on page 60 for details.
3BUF001094-610 A 58
2 General Information for DataDirect
2.6 Quick Tips for Using DataDirect
3BUF001094-610 A 59
2 General Information for DataDirect
2.7 Using DataDirect Dialogs
Selected Cell - B2
Figure 2.6: Selecting the Starting Cell
3BUF001094-610 A 60
2 General Information for DataDirect
2.7 Using DataDirect Dialogs
If required options are not available in the menu and tool bars, use the View tab on
the Options dialog to make these options available.
If not logged in, the prompt to log in now is displayed. Refer to Login on page 135 for
details. After log in, the chosen dialog is displayed.
3BUF001094-610 A 61
2 General Information for DataDirect
2.7 Using DataDirect Dialogs
For one-time data requests, select Data Only. For reusable formulas, select Formula.
This requires functions to be enabled on the Setup tab of the Options dialog (functions
are enabled by default). Refer to Disable Functions on page 250.
When using Formula output, selecting any cell that has output in the spreadsheet will
display the formula in the formula bar, Figure 2.9.
To use the Formula output option, refer to Storing, Updating, and Scheduling Reports
on page 74 for further guidelines for creating a report with DataDirect.
Figure 2.10: Selecting the Method for Specifying Start and End Times
3BUF001094-610 A 62
2 General Information for DataDirect
2.7 Using DataDirect Dialogs
Then refer to the sections referenced below for details on how to use the selected method:
• Date and Time on page 63.
• Cell Reference on page 63.
• Dynamic Time on page 64.
Entering an end time that precedes or equals the start time causes an error message
to be displayed when the query is executed. Click OK to clear the message, then
enter a valid start (or end) time.
Do not use either of the following options for short date style in the Regional Settings
dialog (Windows Control Panel function): yy-dd-mm or yyyy-dd-mm. This causes the
month and date values to be reversed in the DT Picker.
Cell Reference
This option is used to reference a cell in the spreadsheet where the start or end time is
specified, Figure 2.12.
3BUF001094-610 A 63
2 General Information for DataDirect
2.7 Using DataDirect Dialogs
Dynamic Time
This option is used to specify the start and end time as Now (current date and time) plus
or minus a time interval specified in number of seconds, minutes, hours, days, weeks,
months, or years. For example in Figure 2.13, the start time is specified as now minus
one day, and the end time is specified as now.
Dynamic time can be used in combination with date and time. For example, in Figure
2.14, the start time is specified as end time minus four days, and the end time is specified
as 9/18/2004 11:30:00.
Now refers to the current date and time, Figure 2.14. Each time a report is generated,
every instance of Now is re-evaluated. To record the current date and time for
future references, use the now() function in any of the cell.
3BUF001094-610 A 64
2 General Information for DataDirect
2.7 Using DataDirect Dialogs
3BUF001094-610 A 65
2 General Information for DataDirect
2.7 Using DataDirect Dialogs
The content in the Name field in Figure 2.16 are the names to be given to the cells in
Excel, and the Value field indicates the value to be put into the cell.
2.7.7 Formatting
The presentation format is set through the Data Format tab in the Options dialog. When
Horizontal List is selected, attributes are listed horizontally and objects are listed vertically,
Figure 2.17. When Vertical List is selected, attributes are listed vertically and objects are
listed horizontally.
To change any of the data format or orientation options, click the Options button to display
the Options dialog. Refer to Configuring Options on page 235 for details.
Figure 2.17: Process Value Query Result - Example Horizontal List Format
3BUF001094-610 A 66
2 General Information for DataDirect
2.8 Using DataDirect Functions
Connected
Disconnected
3BUF001094-610 A 67
2 General Information for DataDirect
2.8 Using DataDirect Functions
3BUF001094-610 A 68
2 General Information for DataDirect
2.8 Using DataDirect Functions
While the cursor is in the formula bar, pressing F9 after inserting or changing a function
will cause Excel to hang.
To insert a function call, the workbook must be in manual mode. DataDirect sets the
workbook to manual mode by default. Confirm this setting as described in Putting the
Workbook in Manual Mode on page 70. Use either the Excel Function wizard or insert
function calls manually.
• To use the Excel Function Wizard, refer to Inserting DataDirect Functions with the
Function Wizard on page 70.
• To insert functions manually, refer to Inserting DataDirect Functions Manually on
page 73.
The Excel Chart Wizard can be used to add charts in a DataDirect report. Refer to
Adding Charts to DataDirect Reports on page 277.
3BUF001094-610 A 69
2 General Information for DataDirect
2.8 Using DataDirect Functions
3BUF001094-610 A 70
2 General Information for DataDirect
2.8 Using DataDirect Functions
5. Select User Defined from the Function category list on the left. This displays the
DataDirect functions in the Function name list on the right, Figure 2.20.
3BUF001094-610 A 71
2 General Information for DataDirect
2.8 Using DataDirect Functions
6. Select the function to be inserted. This displays a dialog for specifying the selected
function’s parameters. For example, if ABBGetOPCHDA is selected, the dialog
shown in Figure 2.21 is displayed.
7. Enter a specification for each parameter. Be sure to embed text strings (for example,
object names) in double quotes. Refer to the applicable function description for
details. Refer to Table 2.2.
8. Click OK when finished with the Parameters dialog.
9. Repeat steps 3-8 for as many functions as needed.
3BUF001094-610 A 72
2 General Information for DataDirect
2.8 Using DataDirect Functions
10. Go back to the DataDirect Options dialog, and un-select Disable Functions. Refer
to Setup on page 246.
11. Each function must be executed once before the F9 key can be used to calculate
the entire workbook.
Any time functions are disabled and then re-enabled, all functions in the spreadsheet
must be executed individually before the F9 key can be used to calculate the entire
workbook.
The Excel spreadsheet must maintain focus while the report is running (retrieving
data).
• For each function that returns multiple values (for example, ABBGetOPCHDA):
a. Select the cell where the function is defined.
b. Starting with that cell, select a range of cells to hold the data.
c. Put the cursor in the formula bar, and then Press CTRL+SHIFT+ENTER.
• For each function that returns one value (for example, ABBGetOPCDA):
a. Select the cell where the function is defined.
b. Put the cursor in the formula bar.
c. Press ENTER.
3BUF001094-610 A 73
2 General Information for DataDirect
2.8 Using DataDirect Functions
3. Enter the function according to the function syntax. Refer to Table 2.2. Each
parameter must be separated by a comma. Strings must be in double-quotes (").
4. Press ENTER to run the function.
3BUF001094-610 A 74
2 General Information for DataDirect
2.8 Using DataDirect Functions
3BUF001094-610 A 75
3BUF001094-610 A 76
3 DataDirect System 800xA
3.1 Introduction
3.1 Introduction
System 800xA dialogs and functions can only be used on nodes where the base 800xA
System software is installed.
The System 800xA Process Values dialog, Figure 3.2, is used to query aspect objects
in the 800xA System for real-time process data (including softpoints).
3BUF001094-610 A 77
3 DataDirect System 800xA
3.2 Using the System 800xA Process Values Dialog
With the proper authority process values can also be updated. The Update Process
Values tab is not enabled unless the Allow Process Updates option is selected through
the Setup tab on the Options dialog (refer to Setup on page 246). Also, user authority
must be configured in the aspect system to allow updates of certain object properties.
• This dialog requires 800xA base system software to be installed on the computer
running DataDirect.
• This dialog does not support querying objects on servers outside the 800xA
System. For this, use the Inform IT version of this dialog. Refer to Using the
Inform IT Process Values Dialog on page 138.
3BUF001094-610 A 78
3 DataDirect System 800xA
3.2 Using the System 800xA Process Values Dialog
Follow these steps to display the process values dialog for data retrieval or updates:
1. Select the cell in the spreadsheet which will be the starting point for inserting data.
2. Use the menu or tool bar to open the System 800xA Industrial IT Process Values
dialog.
Either click the Process Value button in the tool bar, or choose
DataDirect System 800xA> Industrial IT Process Values from the menu bar,
Figure 3.3.
3BUF001094-610 A 79
3 DataDirect System 800xA
3.2 Using the System 800xA Process Values Dialog
For further details on these steps and other optional procedures refer to:
• Specifying One-time Data Access or Reusable Formulas on page 61.
• Selecting Objects to Query on page 80.
• Changing the Start Cell on page 61.
• Inserting or Overwriting Rows on page 61.
• Formatting on page 66.
• Some information columns in the properties list (right pane) are hidden by default.
these columns can be expanded to show the information as described in Expanding
the Items Columns on page 83.
3BUF001094-610 A 80
3 DataDirect System 800xA
3.2 Using the System 800xA Process Values Dialog
3BUF001094-610 A 81
3 DataDirect System 800xA
3.2 Using the System 800xA Process Values Dialog
The type filters are used to select one or more object or data types from the respective
lists. Use one, both, or neither of the type filters. Making no selection is equivalent to
selecting all types.
If object types have been added to or deleted from the Object Type structure, the
Object Type list will be updated the next time the Process values dialog is opened.
This causes any current selections to be cleared from the list.
The pattern filters are used to specify one or more patterns for each criteria. When
specifying multiple patterns, separate them with the pipe (|) delimiter character. Use the
following wildcard characters:
* - any character string
? - any single alphabetic character
# - any single numeric character
3BUF001094-610 A 82
3 DataDirect System 800xA
3.2 Using the System 800xA Process Values Dialog
Example pattern filters can be displayed by hovering the cursor over the corresponding
field. Matching is not case sensitive. Not specifying a pattern is equivalent to (and is
replaced by) the wildcard asterisk (*) character.
For each type or pattern filter, any objects that match any one (or more) of the specified
types or patterns will satisfy the component filter. However, only objects that satisfy all
component filters will pass the filter and be included in the list of returned properties.
Clicking OK saves the current filter settings. These settings will then be used for all future
process value queries until the current settings are changed again. Clicking Cancel will
discard any changes made in this dialog and revert back to the last saved filter. The
Reset button returns all settings to their default state.
The filter is applied any time a new selection is made in the browser (left pane). To apply
the filter to the currently selected object in the left pane, click Apply Filter.
3BUF001094-610 A 83
3 DataDirect System 800xA
3.2 Using the System 800xA Process Values Dialog
User Authority
The Update Process Values tab is not enabled unless the Allow Process Updates option
is selected through the Setup tab on the Options dialog (refer to Setup on page 246).
Also, user authority must be configured in the aspect system to allow updates to certain
object properties.
3BUF001094-610 A 84
3 DataDirect System 800xA
3.2 Using the System 800xA Process Values Dialog
The method of operation for this tab is similar to reading process values as described
in Apply, OK, & Cancel Buttons on page 67. Either of two methods can be used:
• The basic method is to use the object browser (left pane) in combination with an
edit filter. Refer to Using the Object Browser below.
• As an alternative, make a list of object properties and values in the spreadsheet,
and then import this data from the spreadsheet. Refer to Use Spreadsheet for Input
on page 88.
Do not select the Use Spreadsheet for Input check box. This disables the object
browser.
2. Select one or more items from the properties list in the right pane, then click Add
to List. This places the selected items in the update list (lower pane).
Remove selected items from the list if necessary. To do this, select the item in the
list, and then click Remove From List. Clear the entire list by clicking Clear List.
3BUF001094-610 A 85
3 DataDirect System 800xA
3.2 Using the System 800xA Process Values Dialog
3. Click in the Value column and edit the value for a selected property. The Updated
column will indicate Changed when the value has been changed. Other columns
may be updated as required.
To update only selected items in the Update list, check Update Selected Items
only; otherwise all items in this list will be updated.
Checking the Automatically apply filter check box will reapply the existing filter to
the properties list (upper right pane) when the changes are applied.
3BUF001094-610 A 86
3 DataDirect System 800xA
3.2 Using the System 800xA Process Values Dialog
4. Click Apply when finished. The Updated column in the Update list (lower pane) will
indicate whether or not the update was successful, Figure 3.11.
3BUF001094-610 A 87
3 DataDirect System 800xA
3.2 Using the System 800xA Process Values Dialog
Click
Here
Click here to collapse the dialog
Figure 3.12: Use Spreadsheet for Input
2. Enter the range of cells that contain the object names in the Objects Range field.
Enter the range directly, or click the button to collapse the dialog and then select
the range of cells in the spreadsheet.
Select the range of cells, then click the red button on the bottom right corner of the
collapsed dialog to restore it. An example is shown in Figure 3.13.
Objects
Range
Selected
Click Here
to Restore
All cells must contain data, and the range CANNOT contain spaces. This will generate
an error message and the cell range must be reselected.
3. As an option, repeat step 2 to import values from the spreadsheet (using the Values
Range field). When this is done, the number of rows selected for the values must
match the number of rows selected for the object names.
3BUF001094-610 A 88
3 DataDirect System 800xA
3.2 Using the System 800xA Process Values Dialog
4. After finishing with the object and value ranges, click Add to List. This creates the
update list, Figure 3.14.
Remove selected items from the list if necessary. To do this, select the item in the
list, and then click Remove From List. Clear the entire list by clicking Clear List.
5. Click in the Value column and edit the value for a selected property. The Updated
column will indicate Changed when the value has been changed.
6. To update only selected items in the Update list, check Update Selected Items
only; otherwise all items in this list will be updated.
7. Checking the Automatically apply filter check box will reapply the existing filter to
the properties list (upper right pane) when the changes are applied.
8. Click Apply when finished. The Updated column in the Update list (lower pane) will
indicate whether or not the update was successful, Figure 3.15.
3BUF001094-610 A 89
3 DataDirect System 800xA
3.3 Using the System 800xA History Values Dialog
Refer to the section below for instructions on using the appropriate dialog:
The System 800xA History Values dialog, Figure 3.17, is used to query aspect objects
in the 800xA System for historical process data. The results are displayed according to
the selections made on the Data Format tab on the Options dialog. Modify these selections
through the Output Options tab on the History Values dialog.
With the proper authority, new log entries can be inserted, or existing entries replaced.
The Insert/Replace tab is not enabled unless the Allow History Updates option is selected
through the Setup tab on the Options dialog (refer to Setup on page 246). Also, user
authority must be configured in the aspect system to allow certain object properties to
be updated.
3BUF001094-610 A 90
3 DataDirect System 800xA
3.3 Using the System 800xA History Values Dialog
Follow these basic steps to retrieve or update history values with this dialog:
1. Select the cell in the spreadsheet which will be the starting point for inserting data.
2. Use the menu or tool bar to open the System 800xAHistory Values dialog.
Either click the History Values button, or choose DataDirect System 800xA>
Industrial IT History Values from the menu bar.
3. To read history values, refer to Reading History Data on page 91.
To update history values, refer to Writing History Data on page 97.
3BUF001094-610 A 91
3 DataDirect System 800xA
3.3 Using the System 800xA History Values Dialog
Interpolated Data
This returns values at regular intervals. Always specify the time range and number of
values to return. This divides the time range into discrete intervals for which data values
are returned. For example, if the time range is 24 hours and the number of values to
return is 1440, a value will be provided for each one-minute interval. The values are not
actual samples, but rather values interpolated from the actual samples.
Raw Data
This returns values for actual samples collected and stored by History. Always specify
a time range. Values are only returned for times when samples were collected and stored.
The query will return all values up to the quantity specified in the Number of Values field
(3200 maximum). For example, if the time range is 24 hours and the number of values
to return is 300 or greater, for a log with a five-minute storage rate, 288 values will be
returned.
3BUF001094-610 A 92
3 DataDirect System 800xA
3.3 Using the System 800xA History Values Dialog
The selected calculation is performed on the data stored in the log with data being
retrieved. The requested time range for which data will be retrieved is divided into
resample intervals. For example, if the requested time range is 24 hours and the
requested number of values to return is 1440, the resample interval is one minute (24
hours = 1440 minutes, 1440 minutes/1440 values = 1 value per minute). In this case,
the calculation will be performed on the values stored in the log for each one-minute
interval. All time stamps returned are those of the beginning of the resample interval
except for those calculations which explicitly state otherwise.
3BUF001094-610 A 93
3 DataDirect System 800xA
3.3 Using the System 800xA History Values Dialog
3BUF001094-610 A 94
3 DataDirect System 800xA
3.3 Using the System 800xA History Values Dialog
A filter may also be applied to include or exclude certain objects, aspects, and properties
(Applying a Filter to the List of Returned Logs on page 95).
Also, the retrieval process may be aborted if there are too many logs for the selected
object(s). While the dialog is building the log list, the Apply Filter button changes to
Abort, Figure 3.4. This button indicates the number of objects whose logs have been
returned at the current time, and the total number of selected objects. Clicking this button
will abort the retrieval process when the current object is finished, so that no additional
objects will be searched for logs.
To put history data onto the spreadsheet, select one or more items in the log list, then
click OK. The selected logs can also be copied to the clipboard to use (paste) in another
application.
3BUF001094-610 A 95
3 DataDirect System 800xA
3.3 Using the System 800xA History Values Dialog
The type filters are used to select one or more object types, property log templates, or
data types from the respective lists. Any combination of the type filters may be used.
Making no selection is equivalent to selecting all types.
If object types or log templates have been added to or deleted from the Object Type
structure or Library structure respectively, the corresponding list will be updated the
next time the History Values dialog is opened. This will cause any current selections
to be cleared from the lists.
The pattern filters are used to specify one or more patterns for each criteria. When specify
multiple patterns, separate them with the pipe (|) delimiter character. The following
wildcard characters may be used:
* - any character string
? - any single alphabetic character
# - any single numeric character
Display example pattern filters by hovering the cursor over the corresponding field.
Matching is not case sensitive. Not specifying a pattern is equivalent to (and is replaced
by) the wildcard asterisk (*) character.
For each type and pattern filter, any objects that match any one (or more) of the specified
types or patterns will satisfy the component filter. However, only objects that satisfy all
component filters will be included in the list of returned logs.
3BUF001094-610 A 96
3 DataDirect System 800xA
3.3 Using the System 800xA History Values Dialog
Clicking OK will save the current filter settings. These settings will then be used for all
future History Value queries until the current settings are changed again. Clicking Cancel
will discard any changes made in this dialog and revert back to the last saved filter. The
Reset button returns all settings to their default state.
3BUF001094-610 A 97
3 DataDirect System 800xA
3.3 Using the System 800xA History Values Dialog
User Authority
The Insert/Replace tab is not enabled unless the Allow History Updates option is selected
through the Setup tab on the Options dialog (refer to Setup on page 246). Also, user
authority must be configured in the aspect system to allow updates to log objects.
The method of operation for this tab is similar to reading history values as described in
Apply, OK, & Cancel Buttons on page 67. Use either of two methods:
• The basic method is to use the object browser (left pane) in combination with an
edit filter. Refer to Using the Object Browser below.
• As an alternative, make a list of data retrieval parameters in the spreadsheet, and
then import this data from the spreadsheet. Refer to Use Spreadsheet for Input on
page 101.
3BUF001094-610 A 98
3 DataDirect System 800xA
3.3 Using the System 800xA History Values Dialog
DO NOT check the Use Spreadsheet for Input check box. This disables the object
browser.
2. Select one or more items from the log list in the right pane, then click Add to List.
This places the selected items in the update list (lower pane).
Selected items from the list can be removed if necessary. To do this, select the item
in the list, and then click Remove From List. The entire list may be cleared by
clicking Clear List.
3. Click in the Value column and edit the value for a selected log. The Updated column
will indicate Changed when the value has been changed. Other columns may be
updated as required.
To update only selected items in the Update list, check Update Selected Items
ONLY; otherwise all items in this list will be updated.
Checking the Automatically Apply Filter check box will reapply the existing filter
to the log list (upper right pane) when the changes are applied.
3BUF001094-610 A 99
3 DataDirect System 800xA
3.3 Using the System 800xA History Values Dialog
3BUF001094-610 A 100
3 DataDirect System 800xA
3.3 Using the System 800xA History Values Dialog
Click
Here
Click here to collapse the dialog
Figure 3.26: Use Spreadsheet for Input
2. Enter the range of cells that contain the object names in the Objects Range field.
Enter the range directly, or click the button to collapse the dialog and then select
the range of cells in the spreadsheet, then click the red button on the bottom right
corner of the collapsed dialog to restore it. An example is shown in Figure 3.27.
Click Here
to Restore
Objects
Range
Selected
All cells must contain data, and the range CANNOT contain spaces. This will generate
an error message, in which case the cell range must be reselected.
3BUF001094-610 A 101
3 DataDirect System 800xA
3.3 Using the System 800xA History Values Dialog
4. When finished, Figure 3.28, click Add to List. This creates the update list, Figure
3.29.
To remove selected items from the list, select the item in the list and then click
Remove From List. The entire list may be cleared by clicking Clear.
5. Click in the Value column and edit the value for a selected property. The Updated
column will indicate Changed when the value has been changed.
To update only selected items in the Update list, check Update Selected Items
Only; otherwise all items in this list will be updated.
Checking the Automatically Apply Filter check box will reapply the existing filter
to the log list (upper right pane) when the changes are applied.
3BUF001094-610 A 102
3 DataDirect System 800xA
3.4 Using the System 800xA Alarm/Events Dialog
3BUF001094-610 A 103
3 DataDirect System 800xA
3.4 Using the System 800xA Alarm/Events Dialog
Refer to the section below for instructions on using the appropriate dialog:
The Industrial IT Alarms and Events dialog, Figure 3.32, is used to retrieve alarm and
event messages for a selected alarm/event list. These lists are user-configurable as part
of the operator workplace configuration. This dialog requires 800xA base system software
to be installed on the computer where DataDirect is running.
3BUF001094-610 A 104
3 DataDirect System 800xA
3.4 Using the System 800xA Alarm/Events Dialog
To retrieve messages that are beyond the scope of the 800xA System message services
(50,000 messages maximum), use the Inform IT Message Log dialog.
3BUF001094-610 A 105
3 DataDirect System 800xA
3.4 Using the System 800xA Alarm/Events Dialog
To begin:
1. Select the cell which will be the starting point for inserting data.
2. Open the Industrial IT Alarms and Events dialog. Either click the Alarm/Events button
in the tool bar, or choose DataDirect System 800xA> Industrial IT Alarm and
Events from the menu bar, Figure 3.33.
3. Use the Alarm and Events dialog to select the alarm or event list and specify a time
range. Refer to Using the Alarms and Events Dialog on page 106.
3BUF001094-610 A 106
3 DataDirect System 800xA
3.4 Using the System 800xA Alarm/Events Dialog
3BUF001094-610 A 107
3 DataDirect System 800xA
3.5 System 800xA Configuring Options
3BUF001094-610 A 108
3 DataDirect System 800xA
3.5 System 800xA Configuring Options
3BUF001094-610 A 109
3 DataDirect System 800xA
3.5 System 800xA Configuring Options
3BUF001094-610 A 110
3 DataDirect System 800xA
3.5 System 800xA Configuring Options
3BUF001094-610 A 111
3 DataDirect System 800xA
3.5 System 800xA Configuring Options
Horizontal Orientation
Vertical Orientation
3BUF001094-610 A 112
3 DataDirect System 800xA
3.5 System 800xA Configuring Options
3.5.2 View
The View tab, Figure 3.40, is used to select which add-in tools to show or hide on the
DataDirect tool bar and menu bar. Add-in tools are grouped under Industrial IT for use
in the 800xA System.
3BUF001094-610 A 113
3 DataDirect System 800xA
3.5 System 800xA Configuring Options
Each add-in tool has a separate check box for showing/hiding the add-in tool in the
DataDirect menu and/or the corresponding tool bar. Restore the default settings at any
time by clicking Restore Defaults. Figure 3.40 shows the default settings when DataDirect
is initially installed on an 800xA System node.
3.5.3 Setup
This tab, Figure 3.41, is used to configure the following settings:
• Enable/Disable Write Access to History and Process Values
• Timeout
• Write Debug File
• Disable Functions
•
Figure 3.41: Options Dialog, Setup Tab
3BUF001094-610 A 114
3 DataDirect System 800xA
3.6 Functions for Reading/Writing Process Values
Timeout
This is the maximum time that DataDirect will wait for the selected object to respond to
the query before timing out. Increase the timeout interval if the application uses complex
SQL queries.
Disable Functions
When this check box is selected, all DataDirect functions in the Excel spreadsheet are
disabled. Functions must be disabled when inserting functions as described in System
800xA Configuring Options on page 108. The functions must be enabled to execute a
specific function, or calculate the entire workbook.
Any time functions are disabled and then re-enabled, then all functions in the
spreadsheet must be executed individually before the F9 key can be used to calculate
the entire workbook.
3BUF001094-610 A 115
3 DataDirect System 800xA
3.6 Functions for Reading/Writing Process Values
3.6.1 ABBGetOPCDASimple
The ABBGetOPCDASimple function will return real-time object data for one OPCDA
item.
This function requires 800xA base system software to be installed on the computer
where DataDirect is running. To query objects on a server that is not part of the 800xA
System, use ABBGetObj on page 262.
The syntax for this function is described below:
=ABBGetOPCDASimple(ObjectName [,Server])
where:
ObjectName is the object name. Use the Information Management Browser to find
objects in the aspect directory. The browser is used to copy and paste
the object names to ensure the name is specified correctly. Refer to
Information Management Browser on page 514.
[Server] specifies the OPCDA server ProgID. This defaults to the 800xA OPCDA
server when the parameter is left undefined.
Enter all parameters as text strings with double quotes.
Example:
=ABBGetOPCDASimple(“H0000X000K-000000:MEASURE”, "ABB.AfwOPCDASurrogate")
This function returns an array of data (two columns, one row). To manually execute
the function, select a 2 x 1 range of cells, then place the cursor in the formula bar
and press Ctrl-Shift-Enter.
For instructions on inserting functions, refer to Inserting Functions in the Spreadsheet
on page 69.
3BUF001094-610 A 116
3 DataDirect System 800xA
3.6 Functions for Reading/Writing Process Values
3.6.2 ABBGetOPCDA
This function returns real-time object data for specified OPCDA items. It will search for
all cells containing this function and formulate one OPC call to retrieve the specified data
for all and cause all cells to be populated with the correct data. The Industrial IT Process
Values dialog may also be used in the Formula mode to insert this function (Using the
Inform IT Process Values Dialog on page 138).
This function requires 800xA base system software to be installed on the computer
where DataDirect is running. To query objects on a server that is not part of the 800xA
System, use ABBGetObj on page 262.
The syntax for this function is described below:
=ABBGetOPCDA(ObjectName[,bTS] [,Server])
where:
ObjectName is object name. Use the Information Management Browser to find objects
in the aspect directory. This is used to copy and paste to ensure the
name is specified correctly. Refer to Information Management Browser
on page 514.
If the property desired is not unique to one aspect, the aspect name can be appended
to the object path. For example:
Object:Property[:AspectName]
[bTS] specifies whether or not to return the time stamp with each value. Enter
bTS as a boolean value:
TRUE = return time stamps
FALSE = do not return time stamps
[Server] specifies the OPCDA server ProgID. This defaults to the 800xA OPCDA
server when the parameter is left undefined. If this parameter is used,
all cells using this function must specify the same progID.
Enter all parameters (except bTS) as text strings with double quotes. bTS is a boolean.
Example:
=ABBGetOPCDA(“H0000X000K-000000:MEASURE”, TRUE "ABB.AfwOPCDASurrogate")
For instructions on inserting functions, refer to Inserting Functions in the Spreadsheet
on page 69.
3BUF001094-610 A 117
3 DataDirect System 800xA
3.7 Functions for Reading/Writing History Values
3.6.3 ABBWriteOPCDA
The ABBWriteOPCDA function is used to update process values.
This function requires 800xA base system software to be installed on the computer
where DataDirect is running. To query objects on a server that is not part of the 800xA
System, use ABBUpdateObj on page 262.
The syntax is as follows:
=ABBWriteOPCDA (objname, value, [,Server])
where:
ObjName is the object name. Use the Information Management Browser to find
objects in the aspect directory. The browser is used to copy and paste
the object names to ensure the name is specified correctly. Refer to
Information Management Browser on page 514.
Value is the new value to be applied to the specified attribute.
[Server] specifies the OPCDA server ProgID. This defaults to the 800xA OPCDA
server when the parameter is left undefined.
Enter all parameters as text strings with double-quotes, with the exception of the value
which may be entered as another data type as applicable, for example: integer.
Example:
=ABBWriteOPCDA(“H0000X000K-000000:MEASURE”, 100 "ABB.AfwOPCDASurrogate")
For instructions on inserting functions, refer to Inserting Functions in the Spreadsheet
on page 69.
3BUF001094-610 A 118
3 DataDirect System 800xA
3.7 Functions for Reading/Writing History Values
3.7.1 ABBGetOPCHDA
The ABBGetOPCHDA function returns a specified number of values for the specified
history log object. By default this function retrieves the columns of data selected on the
Data Format tab on the Options dialog. Refer to Data Format on page 236. The default
is to display Time Stamp, History Data Quality Indication, and Value. Change the settings
on the Data Format tab, or use the output parameter in this function to change the output
specification.
Generate a query for this function using the Industrial IT History Values dialog in the
Formula mode as described in Reading/Writing History Data on page 162, or enter the
function manually.
This function requires 800xA base system software to be installed on the computer
where DataDirect is running. To query objects on a server that is not part of the 800xA
System, use ABBGetHistory on page 265.
The syntax is:
=ABBGetOPCHDA(Logname, Interpolation, Start Time, End Time, MaxCount [,Format
Date] [,Server][,output],[mSec])
where:
Logname is the name of the log whose data is to be retrieved. Use the Information
Management Browser to find logs in the aspect directory. This is used
to copy and paste log names to ensure the name is specified correctly.
Refer to Information Management Browser on page 514.
Interpolation is the type of calculation. The available options depend on the OPC
server. The ABBGetOPCHDAAggregates function may be used to get
the list of available aggregates.
Start/End specify the time range for which data will be retrieved.
Time
3BUF001094-610 A 119
3 DataDirect System 800xA
3.7 Functions for Reading/Writing History Values
MaxCount specifies the number of values to return. This in combination with the
Time Span for Retrieval divides the time range into discrete intervals for
which data values are returned.
[Format is an optional parameter that is used to specify whether to use standard
Date] Excel formatting (n) or DataDirect formatting (y). Refer to Formatting the
Date on page 121.
[Server] specifies the OPCHDA server ProgID. This defaults to the 800xA OPCDA
server when the parameter is left undefined.
[output] specifies the information to display as a result of the historical data query.
If this option is not specified, the information selected in the Data Format
tab of the Options dialog will be displayed (Data Format on page 236).
This option may be used to specify any combination of the following
columns be displayed:
header = 1
object name = 2
calculation = 4
time stamp = 8
attribute name = 16
data quality = 32
To use this option, enter the parameter as an integer which is equal to
the sum of the integer values for the columns to be displayed. For
example, to specify the time stamp and object name, enter 10 (8 for
timestamp plus 2 for object name).
The history value is always displayed. Specify that only the history value
be displayed by entering 0.
[mSec] specifies whether or not to show the time stamp with millisecond resolution
(true = show milliseconds, false = do not show milliseconds).
Enter all parameters (except MaxCount and output) as text strings with double quotes.
For start time and end time, separate the date and time with a space. MaxCount and
output are entered as integer values.
Example:
3BUF001094-610 A 120
3 DataDirect System 800xA
3.7 Functions for Reading/Writing History Values
3BUF001094-610 A 121
3 DataDirect System 800xA
3.7 Functions for Reading/Writing History Values
If a Format Date parameter is not provided, then the DataDirect date and time formats,
as specified in the Data Format tab of the Options dialog, are applied to the timestamp
returned by the ABBGetOPCHDA function. This is the same as specifying formatDate
as y or Y.
3.7.2 ABBGetOPCHDAAggregates
The ABBGetOPCHDAAggregates function returns a list of aggregates supported by the
connected OPCHDA server. This may be used when manually entering the
ABBGetOPCHDA function rather than using the Industrial IT History Values dialog.
This function requires 800xA base system software to be installed on the computer
where DataDirect is running.
3.7.3 ABBWriteNOPCHDA
The ABBWriteNOPCHDA function is used to add multiple entries to a history log, or
modify existing log entries. This is the same functionality provided by the Insert/Replace
tab on the History Values dialog as described in Writing History Data on page 97. To
add a single entry, use ABBWriteOPCHDA on page 124.
This function requires 800xA base system software to be installed on the computer
where DataDirect is running. To write to an object on a server that is not part of the
800xA System, use ABBEditNLogs on page 269.
3BUF001094-610 A 122
3 DataDirect System 800xA
3.7 Functions for Reading/Writing History Values
Syntax
Enter all parameters (except the optional fractional seconds) as text strings with
double-quotes. The syntax is as follows:
=ABBWriteNOPCHDA (cmd, logName, theRange [,varType] [,server])
where:
cmd indicates whether to insert a new value or replace an existing value. Enter
“I” or “A” to insert a new value. Enter “R” or “M” to replace an existing
value. The complete word may also be used (Insert, Add, Replace, or
Modify)
logName is the name of the log whose data is to be written. Use the Information
Management Browser to find logs in the aspect directory. The browser
is used to copy and paste the log names to ensure the name is specified
correctly. Refer to Information Management Browser on page 514.
theRangeis the range of rows and columns in the spreadsheet where the pre-formatted
log entry specification is located.
3BUF001094-610 A 123
3 DataDirect System 800xA
3.7 Functions for Reading/Writing History Values
3.7.4 ABBWriteOPCHDA
The ABBWriteOPCHDA function is used to add a single entry to a lab data history log,
or modify an existing log entry. This is the same functionality provided by the
Insert/Replace tab on the History Values dialog as described in Writing History Data on
page 97. To add multiple entries in one function call, use ABBWriteNOPCHDA on page
122.
This function requires 800xA base system software to be installed on the computer
where DataDirect is running. To write to an object on a server that is not part of the
800xA System, use ABBEditLog on page 267.
Guidelines for Writing History Data
User authority must be configured in the aspect system to allow log objects to be updated.
There are certain restrictions and important considerations that should be understood
prior to writing history data. Refer to Writing to History Logs on page 41.
Syntax
Enter all parameters (except the optional fractional seconds) as text strings with
double-quotes. The syntax is as follows:
=ABBWriteOPCHDA (cmd, logName, logValue, timeStamp, objectStatus [,fractSec]
[,opcQuality] [,varType] [,server])
3BUF001094-610 A 124
3 DataDirect System 800xA
3.7 Functions for Reading/Writing History Values
where:
cmd indicates whether to insert a new value or replace an existing value. Enter
“I” or “A” to insert a new value. Enter “R” or “M” to replace an existing
value. The complete word may also be used (Insert, Add, Replace, or
Modify)
logName is the name of the log whose data is to be written. Use the Information
Management Browser to find logs in the aspect directory. The browser
is used to copy and paste the log names to ensure the name is specified
correctly. Refer to Information Management Browser on page 514.
logValue is the new value for the log entry.
timeStamp is the time stamp for the entry. When modifying an existing entry the time
stamp must be accurate within one second. To get the precise time stamp,
retrieve the raw data for the log entry as described in Reading History
Data on page 91.
[fractSec] Optional fractional seconds specification (floating point).
objectStatus is an option used to enter an integer value to associate with this log entry.
For example, ObjectStatus may be used to identify the user that
added/modified the entry. This value defaults to 0 (zero). The value does
not have to be changed if the functionality is not used.
[varType] variant type to which the value is converted. This parameter is NOT used
in this version of DataDirect, and is present for compatibility with earlier
versions of DataDirect.
[Server] specifies the OPCHDA server ProgID. This defaults to the 800xA OPCDA
server when the parameter is left undefined.
Examples:
=ABBWriteOPCHDA ("INSERT", "H000X000K-000000,MEASURE", "150.25", "9/16/2003
13:22:00", "0")
=ABBWriteOPCHDA ("REPLACE", "H000X000K-000000:MEASURE,Log1", "150.25",
"9/16/2003 13:22:00", "0")
3.7.5 ABBGetOPCHDAAttributes
The ABBGetOPCHDAAttributes function returns a list of available attributes for the
connected OPCHDA server.
This function requires 800xA base system software to be installed on the computer
where DataDirect is running. To write to an object on a server that is not part of the
800xA System, use ABBGetAttributes on page 271.
3BUF001094-610 A 125
3 DataDirect System 800xA
3.7 Functions for Reading/Writing History Values
3.7.6 ABBGetOPCHDAAttributeValue
This function returns values for a specified attribute of a specified history log object. By
default this function retrieves the columns of data selected on the Data Format tab on
the Options dialog. Refer to Data Format on page 236. The default setting on this tab is
to display Time Stamp, History Data Quality Indication, and Value. Change the settings
on the Data Format tab, or use the output parameter in this function to change the output
specification.
Generate a query for this function using the Industrial IT History Values dialog in the
Formula mode as described in Reading History Data on page 91, or enter the function
manually.
This function requires 800xA base system software to be installed on the computer
where DataDirect is running. To write to an object on a server that is not part of the
800xA System, use ABBGetAttributeValue on page 271.
The syntax is:
=ABBGetOPCHDAttributeValue(Logname, AttributeID, Start Time, End Time, MaxCount
[,Format Date] [,Server][,output])
where:
Logname is the name of the log whose attribute value is to be retrieved. Use the
Information Management Browser to find logs in the aspect directory.
The browser is used to copy and paste the log names to ensure the name
is specified correctly.
3BUF001094-610 A 126
3 DataDirect System 800xA
3.7 Functions for Reading/Writing History Values
AttributeID is the name of the attribute whose value is to be retrieved. The available
attributes depend on the connected OPC server. The
ABBWriteNOPCHDA function may be used to get the list of available
attributes.
Start/End specify the time range for which data will be retrieved. Specify that only
Time the current value be returned by entering the Start Time as “NOW”.
MaxCount specifies the number of values to return. This in combination with the
Time Span for Retrieval divides the time range into discrete intervals for
which data values are returned.
[Format is an optional parameter that is used to specify whether to use standard
Date] Excel formatting (n) or DataDirect formatting (y). Refer to Formatting the
Date on page 128.
[Server] specifies the OPCHDA server ProgID. This defaults to the 800xA OPCDA
server when the parameter is left undefined.
[output] specifies the information to display as a result of the historical data query.
If this option is not specified, the information selected in the Data Format
tab of the Options dialog will be displayed (Data Format on page 236).
Use this option to specify that any combination of the following columns
be displayed:
header = 1
object name = 2
calculation = 4
time stamp = 8
attribute name = 16
data quality = 32
To use this option, enter the parameter as an integer which is equal to
the sum of the integer values for the columns being displayed. For
example, to specify the time stamp and object name, enter 10 (8 for
timestamp plus 2 for object name).
The history value is always displayed. Specify that only the history value
be displayed by entering 0.
Enter all parameters (except MaxCount and output) as text strings with double quotes.
For start time and end time, separate the date and time with a space. MaxCount and
output are entered as integer values. For example:
3BUF001094-610 A 127
3 DataDirect System 800xA
3.7 Functions for Reading/Writing History Values
=ABBGetOPCHDAAttributeValue(“H0000X000K-000000:MEASURE”, “attributeName”,
"11/3/00 14:30", “11/3/00 19:30”, 5, “n”, "ABB.AdvHtHistoryHdlr.1",10)
This function returns an array of data. The width (columns) is based on the log
attributes to be displayed. The number of rows depends on the time range and
MaxCount parameter. To manually execute the function, select a range of cells, then
place the cursor in the formula bar and press Ctrl-Shift-Enter.
3BUF001094-610 A 128
3 DataDirect System 800xA
3.8 Functions for Reading Messages
If a Format Date parameter is not provided, then the DataDirect date and time formats,
as specified in the Data Format tab of the Options dialog, are applied to the timestamp
returned by the ABBGetOPCHDAAttributeValue function. This is the same as specifying
formatDate as y or Y.
3.8.1 ABBAERetrieval
The ABBAERetrieval function retrieves runtime or archived event data for a specified
800xA System alarm and event list.
This function requires 800xA base system software to be installed on the computer
where DataDirect is running.
The Message Type combo box on the Filter tab of the Alarm and Event List Configuration
aspect determines whether messages come from archive or from local (runtime) storage.
If this field starts with ArchiveService.OPCEventServer the messages are retrieved
from the archive. The A/E Linked Server Configuration aspect, which must be attached
to the same object as the Alarm and Event List Configuration aspect, specifies the
parameters for the archive retrieval.
The Alarm and Event List Configuration aspect specified by the Alarm and Event List
Aspect is used to determine the following:
• List of categories.
• List of attributes.
• Order of attribute columns.
• Number of messages retrieved.
• Whether or not Column Headers are displayed.
• Process Sections filtering.
• Class filtering.
3BUF001094-610 A 129
3 DataDirect System 800xA
3.8 Functions for Reading Messages
The timeout for this function (maximum seconds to wait for response) defaults to the
timeout specified by the setting on the DataDirect Options dialog. Refer to Timeout on
page 250.
The format of the timestamp (if the time is a selected attribute to be output) is determined
by the time format setting on the DataDirect Options dialog. Refer to Date and Time
Formatting.
This function is an array function meaning that rows and columns must be allocated to
it in which the retrieved results are to be stored. Each message retrieved requires one
row. Each attribute retrieved requires one column.
Generate a query for this function using the Alarm and Event Retrieval dialog in the
Formula mode as described in Using the Inform IT Message Log Dialog, or enter the
function manually. The syntax is:
=ABBAERetrieval(startTime, endTime, AEListAspect[,MaxRows] [,Timeout])
where:
start and end time range for messages to be retrieved. Note: if endTime comes before
times startTime, the messages are ordered oldest first.
AEListAspect name of object containing an Alarm and Event List Aspect. The first one
is used to specify filter and attribute selections.
MaxRows Optional maximum number of rows to populate - overrides what is
specified on Alarm and Event List Configuration aspect.
Timeout Optional parameter is used to specify maximum seconds to wait for
response. This defaults to the Timeout specified on the Setup tab of the
Data Direct Options dialog. Refer to Setup on page 246.
For instructions on inserting functions, refer to Inserting Functions in the Spreadsheet
on page 69.
3BUF001094-610 A 130
4 DataDirect Inform IT
4.1 User Access to DataDirect Inform IT Add-in Tools
4 DataDirect Inform IT
The Inform IT dialogs and functions are used on remote computer clients that do not
have the base software installed.
3BUF001094-610 A 131
4 DataDirect Inform IT
4.3 Data Access Methods
InformIT Datadirect provides both interactive dialogs and programmable functions for
integrating data into an Excel spreadsheet. Some dialogs and functions also support
writing to process and history objects. User authority must be properly configured to
support write transactions.
The interactive dialogs, such as the one shown in Figure 4.1, help when generating and
executing data queries. They are generally intended for on-demand (one-time) data
access functions, although some dialogs are used to generate re-usable function calls.
DataDirect functions may be used to create re-executable reports with Microsoft Excel,
Figure 4.2. The functions provide the same data retrieval capabilities as the dialogs,
except that the functions can be re-executed by running the spreadsheet. The results
can be saved, archived, printed and then rerun. For further information refer to (give the
new link).
The DataDirect functions can be embedded in VBA macros, as an alternative to inserting
them directly in an Excel spreadsheet. By embedding the functions in the macros, they
are not automatically executed when the spreadsheet is opened. This allows reports to
be archived. In addition, these reports can be distributed to Excel users that do not have
DataDirect.
3BUF001094-610 A 132
4 DataDirect Inform IT
4.3 Data Access Methods
3BUF001094-610 A 133
4 DataDirect Inform IT
4.4 Licensing
4.4 Licensing
InformIT Datadirect is licensed on a concurrent-user basis. InformIT Datadirect can be
installed on many computers and the server will control the number of clients that may
connect to the server based on the number of client licenses purchased. For example,
if InformIT Datadirect is installed on ten computers, but only two licenses are purchased,
then only two client computers will be permitted to connect to the server at any one time.
For DataDirect, each open dialog occupies a client license, even if the dialogs are open
on the same computer. Thus one computer may occupy two or more client licenses
concurrently. Installing and managing licenses is a system installation activity.
3BUF001094-610 A 134
4 DataDirect Inform IT
4.5 Login
4.5 Login
To obtain a runtime license, log on to a data server. The login procedure connects the
Excel spreadsheet to a specified host data server for all dialogs.
One runtime license is taken up for each user that logs in to the data server. DataDirect
provides two methods for logging in to support license use.
• log in on an ad-hoc basis. Automatically disconnects when the current dialog is
closed to help minimize the time that a runtime license is occupied.
• log in on a perpetual basis. Stays logged in until you choose to log off regardless
of how many dialogs are opened and closed.
Add-in tools are embedded in Excel on a user basis. By default, the DataDirect add-in
tools are available for the user that installed DataDirect software. A different user will
be required to add the add-in tools for that user. Refer to Manually Adding the
DataDirect Add-in on page 53.
3BUF001094-610 A 135
4 DataDirect Inform IT
4.5 Login
The ad-hoc log-in method cannot be used for executing DataDirect function calls.
Attempting to run a DataDirect function call without login will display the login dialog. Be
sure to log in perpetually in this case.
After Connection
Before Connection
All data retrieval/entry dialogs have a plug icon located in the bottom right corner. This
icon is used to display the Login dialog without having to close the current data retrieval
dialog. Simply double-click the icon to display the Login dialog.
To log in, enter your User name, Password, and Host name. Check the Save Settings
option to save these login parameters and automatically have them entered on the next
log in. Click Connect when finished.
4.5.4 User
Enter the user name for the host data server as defined during the IM configurations.
User names are case-sensitive.
4.5.5 Password
Enter the password for the specified user as defined during the IM configurations.
3BUF001094-610 A 136
4 DataDirect Inform IT
4.6 Reading and Writing Process Values For Inform IT
4.5.6 Host
The Host specification is used in two different ways, depending on whether the Industrial
IT version of the Process and History Values dialogs (and equivalent functions), or any
other dialog (or their equivalent functions) are being used.
For the Industrial IT version of the Process and History Values dialogs (and equivalent
functions), the Host specification is used to obtain a runtime license from a specified
data server.
For all other dialogs (and their equivalent functions), in addition to obtaining the license,
the Host specification also connects the spreadsheet to the specified data server allowing
data access from that server and only that server.
To specify the host, enter the computer name for the computer where the display server
software is installed. Look up the computer name using the Network Identification
information on the System Properties dialog in the Control Panel. The host server IP
address can be used instead of the computer name.
3BUF001094-610 A 137
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
Refer to the section below for instructions on using the appropriate dialog:
3BUF001094-610 A 138
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
With proper authority, process values can be updated. The Update Process Values tab
is not shown unless the Allow Process Updates option is selected through the Setup
tab on the Options dialog (refer to Setup on page 246), and a user log in to DataDirect is
made with authority to update process values. Refer to User Authority on page 144. Also,
the tab may be visible, but not active unless the Use Channel Numbers option is
deactivated through the Setup tab on the Options dialog (refer to Setup on page 246).
When using this dialog, the F9 function can not be used to re-calculate the workbook
and retrieve new data. To create a workbook that can be re-calculated on-demand
for reporting purposes, use DataDirect functions as described in Configuring Options
on page 235.
Follow these basic steps to access process values with this dialog:
1. Select the spreadsheet cell which will be the starting point for inserting data.
2. Use the menu or tool bar to open the Inform IT Process Values dialog. Either click
the Process Value button in the tool bar, or choose
DataDirect Inform IT > Process Values from the menu bar, Figure 4.7.
If the menu option and/or tool bar icon for this dialog are not visible, use the View
tab on the Options dialog to make them visible. Refer to View on page 240.
3. To query process tags for data retrieval, refer to Reading Process Values on page
140 or refer to User Tag Management (UTM) on page 503. To update the process
values for tags, refer to Writing Process Values on page 144.
3BUF001094-610 A 139
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
3BUF001094-610 A 140
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
Use the left pane to browse the server directory structure to find the folder(s) where the
objects reside. Supported methods for browsing the directory structure are:
• Basic point and click to show the contents of a specific folder.
• Select a folder then choose Get Entire List from the context menu. This shows all
applicable objects in the selected folder as well as objects from all sub-folders within
the selected folder.
• Apply a filter to either show or exclude all objects whose name has a specified text
string.
Select one or more objects from the right pane. Click OK when finished. This executes
the query and puts the requested data in the spreadsheet. The selected object list can
also be copied to the clipboard to use (paste) in another application.
For further guidelines on using this tool, refer to Using the Information Management
Browser on page 235.
To change the contents of the Select Objects pick list, click the Browse button to change
the file specified in the Select Object File field. The object text file provides the object
names for the Select Object pick list.
3BUF001094-610 A 141
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
Several object files are provided with DataDirect as standard. Additional object files can
be created to customize object selection for the application. For details, refer to
Configuring Pick Lists for Advant OCS Objects on page 256. This text file may be
configured with or without object type specifications for the object names. If object types
are not specified in the text file, then the entire contents of the text file will be available
in the Select Object pick list. If object types are included in the specification, then select
the Object Type to make objects of that type available in the Select Object pick list. The
following instructions are only applicable for selecting ABB OCS tags. Ignore these
sections when selecting OPC tags:
Selecting the Object Type
Selecting Object Attributes
Adding New Items to the Object and Attribute Pick Lists
3BUF001094-610 A 142
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
This populates the Object and Attribute pick lists with the object and attribute names
corresponding to the selected object type. For example, Figure 4.10 shows the Select
Objects and Select Attributes pick lists populated according to the CCF_PID_LOOP
object type.
3BUF001094-610 A 143
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
Use the New Process Object and New Object Attribute fields to add new items to their
respective pick lists, Figure 4.11 and remove items from the pick lists. To add a new item
to one of these pick lists, enter the tag name for the new item, and then click the < (Add)
button. This adds the new item to the top of the list and automatically selects it. Previously
selected items will remain selected. To remove an item, select the item and click the >
(Remove) button.
These additions and deletions are only applicable as long as the dialog remains open.
Tags are neither added to, nor removed from the actual object text file.
User Authority
The proper user authority is required to update process values. This is controlled at three
levels - data server, DataDirect client, and user:
• At the DataDirect client level, the Allow Process Updates option must be checked
on the Setup tab of the Options dialog. Also, log on to the computer as an
Administrator-level user to change these settings. Refer to Enable/Disable Write
Access to History and Process Values on page 249.
• At the data server level, the applicable data provider must be configured to allow
write transactions. This is the default set-up. To verify this set-up, refer to configuring
data access for display and client services in Information Management configuration.
• On the user level, the user who logs onto the data server (DataDirect Log-in dialog)
must be authorized to write to process objects. This is configured in the user
preference file. By default, users are NOT granted this authority. Adjust this
preference for a user when managing Information Management users during
configuration.
This function does not recognize data providers by channel number, but rather by
the -name argument. Therefore the Use Channel Numbers option in the Options
dialog Setup tab must be DEACTIVATED (not selected). Refer to Setup on page 246.
3BUF001094-610 A 144
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
Basically, this procedure requires building process value update specifications for one
or more tags, add these specifications to a list, and then apply the list. Also, it is
recommended that results of the update operation be output to a spreadsheet. This gives
a permanent record of the update operation.
3BUF001094-610 A 145
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
This display supports four methods for building the tag update list - one for OPC tags
and three for ABB OCS tags (Enterprise Historian platform). Refer to the applicable
instructions below:
• Updating OPC Tags.
• Updating ABB OCS tags on an Enterprise Historian platform:
– Building an Ad-hoc List.
– Importing a Formatted Range of Cells from a Spreadsheet. This requires having
a properly formatted range of tag update specifications within the Excel
spreadsheet.
– Importing Non-formatted Ranges of Cells from a Spreadsheet.
For ABB OCS tags, it is recommended to start with Building an Ad-hoc List. This
describes the procedure in depth. Some of the steps from this procedure are used
in the other methods, but are not covered in the same detail.
3BUF001094-610 A 146
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
This displays a Browse button and two corresponding fields as shown in Figure
4.14.
3BUF001094-610 A 147
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
2. Click Browse to launch the Information Management Browser, then use the browser
to find and select the OPC tag, Figure 4.15.
a. Use the left pane to browse the server directory structure to find the folder(s)
where the objects reside. The following methods are supported for browsing
the directory structure:
• Point and click to show the contents of a specific folder.
• Select a folder then choose Get Entire List from the context menu. This
shows all applicable objects in the selected folder as well as objects from
all sub-folders within the selected folder.
• Apply a filter to either show or exclude all objects whose name has a
specified text string.
i. Select an object from the right pane. Click OK when finished. The full
path to the selected tag is displayed in the Selected Tag field.
Refer to Using the Information Management Browser on page 235 for
additional information.
3BUF001094-610 A 148
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
4. When satisfied with the tag specification, click the Add to List button. This adds
the specification to the Preview Selected Updates list, Figure 4.16.
Continue adding OPC tags to the list as required. To do this, repeat steps 2-4.
5. Make adjustments to the list if necessary. To edit a specification, select it from the
list, then click Edit. This removes the specification from the Selected Updates list
and puts it back in the Selected Tag and Value fields above. Edit the information as
required, and then click Add to List. The edited specification is placed at the bottom
of the list.
To remove a specification, select the specification in the list, and then click Remove
From List. If only one row is selected, the row will be deleted immediately. If more
than one row is selected, confirm whether or not to remove ALL selected rows. Click
Yes to confirm, or No to cancel the remove operation.
6. When ready to apply the updates to their respective tags, click Apply. This adds
two columns to the preview list: Updated and Error Message. These columns indicate
the status of each update, Figure 4.17.
3BUF001094-610 A 149
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
3. Select the object name and attribute name from their respective lists, Figure 4.19.
3BUF001094-610 A 150
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
5. When satisfied with the tag specification, click the Add to List button. This adds
the specification to the Preview Selected Updates list, Figure 4.21.
3BUF001094-610 A 151
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
8. When ready to apply the updates to their respective tags, click Apply. This adds
two columns to the preview list: Updated and Error Message. These columns indicate
the status of each update, Figure 4.22.
3BUF001094-610 A 152
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
This disables the fields for specifying ad-hoc tag updates. The Select Formatted
Range option is selected, and the Formatted Range field is enabled.
3BUF001094-610 A 153
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
2. Enter the range of cells to import in the Formatted Range field. Enter the range
directly, or click the button to collapse the Update Process Values dialog, Figure
4.24, and then select the range directly in the spreadsheet.
Do not select multiple single cells in the spreadsheet using the Ctrl key as it will cause
an error message to appear when the Add to List button is clicked in the Inform IT
Process Values dialog box.
All cells must contain data, and the range CANNOT contain spaces. This will generate
an error message, in which case the cell range must be reselected.
3BUF001094-610 A 154
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
3. With the selected range indicated in the Formatted Range field, Figure 4.26, click
the Add to List button.
This adds the update specifications to the Selected Updates list, Figure 4.27.
3BUF001094-610 A 155
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
6. When ready to apply the updates to History, click Apply. This adds two columns to
the preview list: Updated and Error Message. These columns indicate the status of
each update, Figure 4.28.
7. Make a permanent record of this update operation. To do this, click the Output
Results button and specify the starting cell where the tag updates will be inserted.
For details refer to Recording the Output Results on page 159.
3BUF001094-610 A 156
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
3BUF001094-610 A 157
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
3. Enter the range of cells for one or more of the four categories in their respective
fields. The operation of these fields is similar to the procedure for Importing a
Formatted Range of Cells from a Spreadsheet. The only difference is that each
range must be selected individually. An example is shown in Figure 4.31.
Do not select multiple single cells in the spreadsheet using the Ctrl key as it will cause
an error message to appear when the Add to List button is clicked in the Inform IT
Process Values dialog box.
4. With the selected range indicated in the Formatted Range field, click the Add to
List button. This adds the update specifications to the Selected Updates list, Figure
4.32.
5. Continue adding unformatted ranges to the list. To add another specification, repeat
steps 3 and 4.
3BUF001094-610 A 158
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
8. Make a permanent record of this update operation. To do this, click the Output
Results button and specify the starting cell where the tag updates will be inserted.
For details refer to Recording the Output Results on page 159.
3BUF001094-610 A 159
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
To do this:
1. Click the Output Results button. This displays a dialog for specifying the starting
cell where the tag update records will be inserted.
2. To specify the starting cell, either enter the column/row specification directly in the
dialog, or use the corresponding button to collapse the Select Start Cell dialog. This
returns focus to the spreadsheet in order to select a cell, Figure 4.34.
Selected Cell
After selecting the start cell, click the restore button (red dot) to restore the dialog,
Figure 4.35.
3BUF001094-610 A 160
4 DataDirect Inform IT
4.7 Using the Inform IT Process Values Dialog
The orientation of the data is set through the Data Format tab in the Options dialog.
Display the options dialog by clicking the Options button in the Starting Cell dialog.
For details on using the Options dialog, refer to Configuring Options on page 235.
The Insert check box is used to insert a new row or rows of data in the spreadsheet
without overwriting any existing data. When Insert is selected, existing rows are
moved down as required to make room for the new data. If this check box is not
selected, any existing cells may be overwritten by new data.
4. Click OK when finished. This inserts the tag update records in the spreadsheet,
Figure 4.37.
3BUF001094-610 A 161
4 DataDirect Inform IT
4.8 Reading/Writing History Data
Refer the section below for instructions on using the appropriate dialog:
3BUF001094-610 A 162
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
3BUF001094-610 A 163
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
Follow these basic steps to access history values with this dialog:
1. Select the range of cells in the spreadsheet which will be the starting point for
inserting data.
2. Use the menu or tool bar to open the Inform IT History Values dialog.
Either click the Process Value button in the tool bar, or choose
DataDirect Inform IT > History Values from the menu bar, Figure 4.40.
If the menu option and/or tool bar icon for this dialog are not visible, use the View
tab on the Options dialog to make them visible. Refer to View on page 240.
3. To retrieve historical data, refer to Retrieving History Data on page 164. Also, refer
to User Tag Management (UTM) on page 503 for selecting system as well as public
and private groupings of tags.
To add/modify lab data log entries, refer to Adding/Modifying Entries for a Lab Data
Log on page 173.
3BUF001094-610 A 164
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
3BUF001094-610 A 165
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
Trend Display
This displays the requested data on the Desktop Trend display. The Desktop Trends
option must be installed. Refer to Desktop Trends Operation for instructions on using
the Desktop Trend Display.
Interpolated Data
This returns values at regular intervals. Always specify the time range and number of
values to return. This divides the time range into discrete intervals for which data values
are returned. For example, if the time range is 24 hours and the number of values to
return is 1440, a value will be provided for each one-minute interval. The values are not
actual samples, but rather values interpolated from the actual samples.
Modified Data
Modified data can be selected when the history log type retains the original data when
modified data is written and when the IMHDA data provider is used.
3BUF001094-610 A 166
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
Raw Data
This returns values for actual samples collected and stored by History. Always specify
a time range. Values are only returned for times when samples were collected and stored.
The query will return all values up to the quantity specified in the Number of Values field
(3200 maximum). For example, if the time range is 24 hours and the number of values
to return is 300 or greater, for a log with a five-minute storage rate, 288 values will be
returned.
3BUF001094-610 A 167
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
or AIPHDA
These same browsing methods are supported whether the AIPHDA or IMHDA data
provider is used:
• Basic point and click to show the logs within a specific folder.
• Select a folder then choose Get Entire List from the context menu. This shows all
logs in the selected folder as well as logs from all sub-folders within the selected
folder.
• Apply a filter to either show or exclude all logs whose name has a specified text
string.
• With AIPHDA, the Seamless retrieval option can be used when it is uncertain which
component log within the property log will provide best coverage of the requested
time range.
Select one or more logs from the right pane. Click OK when finished. This executes the
query and puts the requested data in the spreadsheet. The selected object list can also
be copied to the clipboard to use (paste) in another application.
For further guidelines on using this tool, refer to Using the Information Management
Browser on page 235.
3BUF001094-610 A 168
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
Any number of objects can be selected from the list of available objects:
• To select one item at a time, click on the corresponding line.
• To select multiple contiguous items, click on the first item, hold down the SHIFT
key, and then click on the last item.
• To select multiple items that are not contiguous, hold down the CTRL key and click
on the items.
The New History Object field is used to add new History objects to the object list. Objects
can also be removed. To add a new object, enter the name of the new history object
and then click the < (Add) button. This adds the new object to the top of the list and
automatically selects it. Previously selected objects will remain selected. To remove an
object, select the object and click the > (Remove) button.
Add/remove operations neither add to, nor remove from the current History object
text file. However, the changes can be saved to a new text file by clicking the Save
File button.
3BUF001094-610 A 169
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
3BUF001094-610 A 170
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
Table 4.2: Calculation Options for Information Management OPC HDA Server
Calculation Retrieves
INTERPOLATIVE Linear interpolation (no calculation).
OPCHDA_TIMEAVERAGE Time weighted average for data over the resample interval.
OPCHDA_MINIMUM Minimum value in the resample interval.
OPCHDA_MAXIMUM Maximum value in the resample interval.
3BUF001094-610 A 171
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
3BUF001094-610 A 172
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
User Authority
The proper user authority is required to add and/or modify numeric logs. This is controlled
at three levels - data server, DataDirect client, and user:
• At the DataDirect client level, the Allow History Updates option must be checked
on the Setup tab of the Options dialog. Also, log in as an Administrator-level user
to change these settings. Refer to Enable/Disable Write Access to History and
Process Values on page 249.
• At the data server level, the applicable data provider must be configured to allow
write transactions. This is the default set-up. Verify this set-up when configuring
data access for data providers.
• On the user level, the user logged onto the data server (DataDirect Log-in dialog)
must be authorized to write to log objects. This is configured in the user preference
file. By default, users are NOT granted this authority. Adjust this preference for a
user when managing users during Information Management configuration.
3BUF001094-610 A 173
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
Other Considerations
• For add/modify operations, if a specific data provider needs to be referenced, use
the -name argument. Therefore the Use Channel Numbers option in the Options
dialog Setup tab must be DEACTIVATED (not selected).
• If the IMHDA OPC HDA server is being used and new log entries need to be added,
use the EH_NET option in the Information Management Browser (Using the
Information Management Browser on page 235). This option is used to modify existing
log entries, and add new entries. EH supports the ability to modify existing log entries,
but not to add new entries.
3BUF001094-610 A 174
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
3. Click the applicable option button to specify either Add a new entry to the log, or
Modify an existing entry.
The remainder of this procedure requires building log entry update specifications, adding
these specifications to a list, and then sending the list. Also, it is recommended that the
results of the update operation be output to the spreadsheet. This provides a permanent
record of the update operation.
3BUF001094-610 A 175
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
The dialog supports four methods for doing this - one for OPC tags and three for ABB
OCS tags as described in the applicable instructions below:
• Updating an OPC HDA Property Log.
• Updating ABB OCS (Enterprise Historian platform) logs:
– Building an Ad-hoc List.
– Importing a Formatted Range of Cells from a Spreadsheet.
– Importing Non-formatted Ranges of Cells from a Spreadsheet.
When updating ABB OCS logs on an Enterprise Historian platform, it is recommended
to start with Building an Ad-hoc List. This describes the procedure in depth. Some of
the steps from this procedure are also used in the other methods, but are not covered
in the same detail.
3BUF001094-610 A 176
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
3BUF001094-610 A 177
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
2. Use the browser to find and select the Property Log, Figure 4.48. Use the left pane
to browse the server directory structure to find the folder(s) where property log
objects reside, then select the object from the right pane.
The contents of the left pane varies depending on the connected data provider:
AIPHDA and IMHDA. These same browsing methods are supported whether the
AIPHDA or IMHDA data provider is being used:
• Basic point and click to show the logs within a specific folder.
• Select a folder then choose Get Entire List from the context menu. This shows
all logs in the selected folder as well as logs from all sub-folders within the
selected folder.
• Apply a filter to either show or exclude all logs whose name has a specified text
string.
• With AIPHDA, the Seamless retrieval option is used when it is uncertain which
component log within the property log will provide best coverage of the requested
time range.
• For IMHDA, if new log entries need to be added, use the EH_NET option in the
Information Management Browser. This option is used to modify existing log
entries, and add new entries. EH supports the ability to modify existing log
entries, but not to add new entries.
Information Management-based logs in the property log hierarchy that are created
after the IMHDA data provider has been started will not be available through
network-wide (EH_NET) access. In order to see these logs, either restart the IMHDA
data provider, or use local (EH) access.
For further details regarding the Information Management Browser, refer to
Using the Information Management Browser on page 235.
3BUF001094-610 A 178
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
3. Click OK when finished. This puts the full path to the property log in the History
Object field, Figure 4.49.
3BUF001094-610 A 179
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
6. As an option, use the Object Status field to enter an integer value to be associated
with this log entry. For example integer values may be used to identify the user that
added/modified the entry. This value defaults to 0 (zero). It is not necessary to
change this value if this functionality is not being used. A completed specification
is shown in Figure 4.50.
7. When satisfied with the log entry specification, click the Add to List button to add
it to the Preview Selected Updates list, Figure 4.51.
3BUF001094-610 A 180
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
10. When ready to apply the updates, click Apply. This adds two columns to the preview
list: Updated and Error Message. These columns indicate the status of each update,
Figure 4.56.
3. Specify the date and time for the entry. When modifying an existing entry, match
the time stamp to one-second resolution. It is recommended that the raw data be
retrieved for the log entry as described in Retrieving History Data on page 164 to get
the precise time stamp.
3BUF001094-610 A 181
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
5. As an option, use the Object Status field to enter an integer value that is to be
associated with this log entry. For example integer values may be used to identify
the user that added/modified the entry. This value defaults to 0 (zero). It is not
required to change this value if this functionality is not used.
6. When satisfied with the log specification, click the Add to List button. This adds the
specification to the Preview Selected Updates list, Figure 4.55.
3BUF001094-610 A 182
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
9. When ready to apply the updates, click Apply. This adds two columns to the preview
list: Updated and Error Message. These columns indicate the status of each update,
Figure 4.56.
3BUF001094-610 A 183
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
This disables fields for specifying ad-hoc log entry updates. The Select Formatted
Range option is selected by default, and the Formatted Range field is enabled.
2. Enter the range of cells to import in the Formatted Range field. Enter the range
directly, or click the button to collapse the Add/Modify History Values dialog, and
then select the range directly in the spreadsheet.
Do not select multiple single cells in the spreadsheet using the Ctrl key as a message
may appear indicating the need to select four columns when the Add To List
command button is clicked in the Inform IT History Values dialog box, even if four
columns are already selected.
All cells must contain data, and the range CANNOT contain spaces. This will generate
an error message, in which case the cell range must be reselected.
3BUF001094-610 A 184
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
3. With the selected range indicated in the Formatted Range field, Figure 4.58, click
the Add to List button, Figure 4.59. This adds the log entry update specifications
to the Preview Selected Updates list.
4. Continue adding specifications to the list as required. To do this, repeat steps 2 and
3. A specification can also be removed from the list by selecting it and clicking
Remove from List. These specifications cannot be edited.
5. When ready to send the updates to History, click Apply. This adds to columns to
the preview list: Updated and Error Message. These columns indicate the status of
each update, Figure 4.60.
3BUF001094-610 A 185
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
3BUF001094-610 A 186
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
3. Enter the range of cells for one or more of the four categories in their respective
fields. The operation of these fields is similar to the procedure for Importing a
Formatted Range of Cells from a Spreadsheet. The only difference is that each
range must be selected individually. Click the button to minimize the dialog, and
then select the full range of cells.
Other rules are:
• Use Current Time Stamp option may also be used.
• All range input fields must have values in them.
• Blank cells at the END of a range selection are removed.
• Blank cells WITHIN a range selection will give an error message, then allowing
the user to correct the selection.
• Select only ONE cell from the range input field, which will return a confirmation
message asking the user if he chooses to use the value contained within the
single cell with the rest of the data he has selected. However, at least one range
must contain more than one cell address.
• The number of cells in each of the range selections MUST be the same as the
other range selections UNLESS only one cell was selected for one of the range
input fields, in which case the previous message will be displayed.
• Selection of more than 1 column and row at one time will give an error message,
the range selection be corrected.
• When entries are added to the Preview Selected Updates list, all date values
are formatted according to options from date/time values.
• The timestamp value must be converted to UTC time in seconds since Jan 1,
1970 (unix compatible). The microseconds value will always be set to 0.
4. To make a permanent record of this update operation, refer to Recording Output
Results on page 188.
3BUF001094-610 A 187
4 DataDirect Inform IT
4.9 Using the Inform IT History Values Dialog
3BUF001094-610 A 188
4 DataDirect Inform IT
4.10 Retrieving Message Logs
Refer to the section below for instructions on using the appropriate dialog:
The Message Log dialog is used to retrieve data from message logs configured through
the Information Management History Server function.
When this dialog is used, the F9 function can not be used to re-calculate the workbook
and retrieve new data. DataDirect does not provide an equivalent function for this
dialog at this time.
3BUF001094-610 A 189
4 DataDirect Inform IT
4.10 Retrieving Message Logs
Follow these basic steps to access history values with this dialog:
1. Select the starting cell in the spreadsheet which will be the starting point for inserting
data.
2. Use the menu or tool bar to open the Inform IT History Values dialog.
Either click the Message Log button in the tool bar, or choose
DataDirect Inform IT > Message Log from the menu bar, Figure 4.64.
If the menu option and/or tool bar icon for this dialog are not visible, use the View
tab on the Options dialog to make them visible. Refer to View on page 240.
3BUF001094-610 A 190
4 DataDirect Inform IT
4.10 Retrieving Message Logs
3BUF001094-610 A 191
4 DataDirect Inform IT
4.10 Retrieving Message Logs
Follow these guidelines to retrieve alarm/event message using this tab. Refer to the
referenced sections for details.
1. Use the Output option buttons to specify whether to execute a one-time data query,
or insert a reusable formula.
When Data Only is selected, choose whether or not to generate the SQL query.
Refer to Generate SQL on page 196. When Formula is selected, change the default
name for the saved query if needed. Refer to Saving a Query on page 196.
2. Select a log name from the pull-down list. This list contains every OPC message
log configured in the system.
3. The start and end times are optional. Refer to Date and Time on page 62 for details.
3BUF001094-610 A 192
4 DataDirect Inform IT
4.10 Retrieving Message Logs
4. Select which OPC attributes and/or Vendor Attributes to be retrieved from their
respective lists.
The OPC attributes are described in Table 4.3. Rather than use the list, the OPC
attribute query function may be used. Refer to OPC Attribute Query on page 195.
The Vendor/Category list is unfiltered by default. A filter may be applied to limit the
scope of vendor attributes to retrieve. Refer to Using the Vendor/Categories List on
page 194 or use the vendor attribute query function as described in Vendor Attribute
Query on page 196
5. The Additional Output Options section is used to select additional information to
include in the output. Either show the SQL query with a data only output, or save
the query when the Formula option is used. Refer to:
• Generate SQL on page 196.
• Saving a Query on page 196.
• Additional Output Options on page 197.
OPC Attributes
Use this list to select one or more OPC attributes whose values are to be retrieved. These
attributes are described in Table 4.3.
3BUF001094-610 A 193
4 DataDirect Inform IT
4.10 Retrieving Message Logs
3BUF001094-610 A 194
4 DataDirect Inform IT
4.10 Retrieving Message Logs
The Filter Here check box for each list is used to apply a filter to the other lists. Filters
are applied from left to right by default. For example, if Filter Here for Vendors is checked,
the Categories list will show categories only for the selected vendors.
To reverse the filter order, use the Filter Order pull-down list. For example, when Filter
Here is checked for both Vendors and Categories, it is possible to specify whether
selected vendors will filter the categories list, or whether selected categories will filter
the vendors list.
The Select All buttons for each list is used to select all items in a list. The Reset button
restores the defaults.
Click OK when done.
3BUF001094-610 A 195
4 DataDirect Inform IT
4.10 Retrieving Message Logs
Generate SQL
Selecting this option is used to show the SQL statement used to run the query. The SQL
statement is inserted into the cell immediately following the query results. The Data Only
option must be selected to get the Generate SQL option.
Saving a Query
When the Formula option is used, the resulting SQL query is saved and may be used
either in the SQL Query dialog (Using the Production Data Log Dialog on page 215), or
the ABBSQL function (ABBSql on page 273).
3BUF001094-610 A 196
4 DataDirect Inform IT
4.10 Retrieving Message Logs
The query name defaults to MsgLog1. The next query will be MsgLog2, and so on.
Rename the queries as required. The saved queries will be available through the Open
Query function on the SQL Query dialog, Figure 4.69.
3BUF001094-610 A 197
4 DataDirect Inform IT
4.10 Retrieving Message Logs
Results are formatted according to the settings described in Alarm/Event Format Output
on page 200.
Log Name
This pull down list contains all message logs configured in the system.
Search Text
This field is used to search for a value within the actual message. This field is optional.
The wildcard characters * or % can be used. Since it is highly unlikely that an exact
message entry can be entered, DataDirect adds the wildcard to the beginning and end
of every value entered when generating the query.
Message Type
This pick list is used to specify the types of alarm/events to retrieve. This field is enabled
only when the Filter option in the Options/Messages dialog is set to
MOD 300 or Other.
The default selection is ALL. Multiple message types can be specified by checking on
the associated checkboxes. If ALL is selected, all other types are automatically unchecked.
3BUF001094-610 A 198
4 DataDirect Inform IT
4.10 Retrieving Message Logs
Database Fields
The database fields in the middle section of the dialog are used to specify message
attribute values as additional search criteria. The wildcard characters % or * can be used.
Enter either a new value, or select one from the corresponding list.
These lists are automatically populated with the contents of a file specified in the File
Setup tab of the Options dialog. Refer to File Setup on page 250. The Browse and
Auto-Create functions can be used to change the contents of a list.
The Tag name list is always enabled. The Batch, Unit, and Sequence Name lists are
enabled only when the Filter option in the Messages tab of the Options dialog is set to
MOD 300 or Other.
The Property Text, Event Text, Sections, Networks and Nodes lists are enabled only
when the Filter option in the Messages tab of the Options dialog is set to Master or Other
and the message log table that has been selected contains the applicable column.
The Property Text and Event Text fields are disabled when the version of History
software is earlier than History Services 2.4.
For Section, Network, and Node entries, if multiple entries are required, separate each
entry with a comma, for example: 2,6,7.
Browse
The Browse button is used to temporarily select a new file to change the list contents.
The button is activated for the list that currently has focus. Clicking Browse launches
the standard Windows dialog for directory navigation and file selection. Selecting a new
file does not change the file specification in the File Setup tab. The list contents will revert
back to the file specified in the File Setup tab the next time the Message Log dialog is
used.
Auto-Create
The Auto Create function is used to alter the contents of the database field in the Message
Log dialog that currently has focus. This is done by creating a new text file. The text file
is created by a query built and run through the Auto Create dialog, Figure 4.71. To open
this dialog click Auto Create.
3BUF001094-610 A 199
4 DataDirect Inform IT
4.10 Retrieving Message Logs
The Log Name and Database Field settings specify the log and database field for which
the file will be created. Log Name defaults to the log name specified in the Message Log
dialog, and Database Field defaults to the field that currently has focus in the Message
Log dialog. Change these settings if necessary.
The Filter edit box is used to limit the number of entries in the file by returning only those
database items that satisfy the filter. For example, if the Database Field is Tag_Name,
and the filter is TC* or TC%, the file will only be populated with tag names that have the
TC prefix.
The query result is written to a text file with a default name and location as indicated in
the Output File edit box. Change the file name and/or location as required. Auto Create
returns one instance of each unique entry in the specified Database field. For instance,
if the Database field is Tag_Name, and there are multiple instances of the tag TC101,
only one entry for that tag is returned.
The Browse button launches the standard Windows dialog for directory navigation and
file selection. The Edit button is used to open the specified file in a text editor such as
notepad.
Generate SQL
Selecting this option is used to show the SQL statement used to run the query. The SQL
statement is inserted into the cell immediately following the query results.
3BUF001094-610 A 200
4 DataDirect Inform IT
4.11 Retrieving Production Data
Output Selection
The Output Selection combobox contains a list of all the fields available for output from
the message log table. An SQL query automatically populates this combobox with the
column names from the selected table.
Sort Order
The Sort Order field indicates the sorting sequence for each selected output field. The
choices are: Ascending, Descending, Unordered.
Output Fields
The Output Fields listbox dictates the message log fields that will be output to the
worksheet as well as the sequence and sort order of the selected fields. Automatically
display Localtime and Message.
Buttons
Add concatenates the current values from the Output Selection and Sort Order fields
and place the combined value into the Output Fields listbox. Remove deletes the selected
row(s) from the Output Fields listbox. If only one row is selected, it is removed when this
button is pressed. If more than one row is selected, then confirm the remove operation.
Change Order cycles through the different sort order options (Ascending, Descending,
Unordered) for the selected items. The Up/Down arrow buttons move the selected row
in the Output Fields listbox up or down one row. Only one row can be selected and
moved at a time.
3BUF001094-610 A 201
4 DataDirect Inform IT
4.11 Retrieving Production Data
Refer to the section below for instructions on using the appropriate dialog:
• Functions on page 202.
• Using the Production Data Log Dialog on page 215.
Functions
The Function list, Figure 4.73, contains the names of the functions that retrieve data from
pre-configured views which are described in Table 4.4.
3BUF001094-610 A 202
4 DataDirect Inform IT
4.11 Retrieving Production Data
These names are configurable through the PDL/Batch tab on the Options dialog (Refer
to Options for the Batch Data Dialog on page 245). Selecting a function creates the
DataDirect function or SQL query as a starting point for the data retrieval application.
This function (or SQL query) is further specified as the other fields in this dialog are used.
When either DataDirect Formula or SQL Query is selected as the Output Type, then
click the Edit button to view and edit the function. Refer to Editing the Function or SQL
Query on page 214.
3BUF001094-610 A 203
4 DataDirect Inform IT
4.11 Retrieving Production Data
3BUF001094-610 A 204
4 DataDirect Inform IT
4.11 Retrieving Production Data
3BUF001094-610 A 205
4 DataDirect Inform IT
4.11 Retrieving Production Data
1. Use the Batch Data dialog, Figure 4.75, to specify the following:
a. The function that will retrieve data from the view that contains the batch
information required. This creates a basic query to access the view.
b. Data retrieval parameters such as the batch ID, and which batch attributes
(columns in the view) to include. Filters can also be specified for one or more
selected columns, and the sorting order of the selected columns can be adjusted.
c. Select output type for the data request. The options are: DataDirect formula,
SQL query, or one-time data request. As an option, specify the following:
Changing the Start Cell on page 61
Inserting or Overwriting Rows on page 61
Maximum Rows on page 214
Batch ID
This list contains the ID of the batches which have been executed during the time span
specified through the Time Span Start Time and End Time controls, and whose data is
stored in a PDL.
3BUF001094-610 A 206
4 DataDirect Inform IT
4.11 Retrieving Production Data
The default span is specified through the Search Time Span field on the PDL/Batch tab
of the Options dialog (refer to Search Time Span on page 244). Adjust the time span as
required, Figure 4.76. This control operates like a standard Microsoft date/time picker.
After adjusting the time span, click Get Batch IDs to update the list.
Once the time span is correct, use the pull-down list to select the batch whose data is
to be retrieved, Figure 4.77, or enter the batch ID directly.
3BUF001094-610 A 207
4 DataDirect Inform IT
4.11 Retrieving Production Data
• PDL Browser - Launch the PDL dialog by clicking the PDL Browser button. This
dialog is used to drill up and down in the task hierarchy to find the batch whose data
is to be retrieved. The PDL dialog may be used to simply find the applicable batch
ID for entry in this dialog, or for continuing with a data query in the PDL dialog. To
select a batch from the PDL Browser for use in the Batch Data dialog, navigate to
a batch, then click Select Batch. For further information regarding the PDL dialog,
refer to Using the Production Data Log Dialog on page 215.
Selecting Columns
The data retrieval function (or SQL query) is further specified by selecting columns, filters,
and sorting options for the selected view in the lower part of the dialog. The Columns
list contains a list of all columns for the selected view, Figure 4.79. Select one or more
columns to specify the batch information to retrieve. The single right arrow button (>)
puts the selected columns in the selected columns list (right pane). The double right
arrow button (>>) puts all columns in the selected columns list. Use the left arrow buttons
to remove selected columns from this list.
3BUF001094-610 A 208
4 DataDirect Inform IT
4.11 Retrieving Production Data
For detailed descriptions of the various columns refer to the tables in PDL Tables and
Views on page 671.
When finished selecting columns, a filter may be specified for one or more selected
columns, and the sorting order may be adjusted.
Filtering
By default, no filter will be applied to any column (indicated by None). To specify a filter
for an item in the selected column list, double-click on the Filter column for the item. This
displays a Filter dialog that is used to specify values or patterns by which to compare
column values. Values that do not satisfy the filter will be excluded from the query. After
a filter is applied it can be reset to None by clicking the Clear Filter button on the filter
dialog.
There are three filter dialog versions, depending on the selected column’s data type:
• Text - This dialog provides two ways to apply a textual filter.
The List tab on the Text Filter dialog lists of all possible values for the selected column
and selected batch ID, Figure 4.80. If the batch ID is by reference, then all possible
matches for that column will be listed. Simply select one or more values from the list
then click Ok. Values that do not match the selected value will be filtered out. Check the
NOT box to negate the filter. This filters out values that do match the selected value(s).
3BUF001094-610 A 209
4 DataDirect Inform IT
4.11 Retrieving Production Data
The Pattern tab is used to specify a textual pattern by which to compare column
values, Figure 4.81. Use the pull-down list to specify whether the value must be an
exact match (EQUALS), or simply contain the specified text string (LIKE).
Then specify the pattern. The % character may be used as a wildcard to substitute
for any character string when using the LIKE operator. For example, assuming LIKE
is selected, the pattern - %001 will cause the query to retrieve information for batches
whose Batch IDs end with the text string 001. Click the NOT check box to apply a
NOT operator and filter out values that match the pattern.
Extend the filter with AND or OR clauses by clicking the Add Filter button. This is
illustrated in Figure 4.82. By clicking Add Filter, another line is added to the filter.
Select whether to add the line as an AND clause, or an OR clause, then specify the
pattern as described above.
3BUF001094-610 A 210
4 DataDirect Inform IT
4.11 Retrieving Production Data
Text filters are case sensitive by default. Make them not case sensitive by unchecking
the Search Criteria is Case Sensitive check box on the PDL/Batch tab of the Options
dialog. Refer to Search Criteria is Case Sensitive on page 245. One exception is when
filtering on LogicalName for the Batch_Trend view. This filter is case sensitive and
requires the Search Criteria is Case Sensitive check box to be checked.
3BUF001094-610 A 211
4 DataDirect Inform IT
4.11 Retrieving Production Data
• Number Filtering - Choose a comparative operator from the pull-down list, then
adjust the minimum and maximum numbers as required, Figure 4.83.
• Date - For this dialog, choose a comparative operator from the pull-down list, then
adjust the start and end dates and times as required, Figure 4.84.
Sorting
The order in which the columns are listed here determines the order in which the columns
will be displayed on the spreadsheet, and the order in which they will be added to the
ORDER BY clause of the query. They may be dragged (one at a time) up and down the
list to change this order.
To sort the returned values in ascending or descending order, click the Sort Order
column for an item. This will display a pick list with the following choices: None,
Ascending, and Descending, Figure 4.85. When the query is executed, the columns
that have either Ascending or Descending specified will be added to the ORDER BY
clause according to the order in which they are listed. Items specified as none will not
be used in the ORDER BY clause.
3BUF001094-610 A 212
4 DataDirect Inform IT
4.11 Retrieving Production Data
Output Type
The option buttons on the top right part of the dialog are used to specify whether to enter
a reusable formula which will be executed each time the spreadsheet is updated, create
an SQL query, or execute a one-time data request Figure 4.86.
3BUF001094-610 A 213
4 DataDirect Inform IT
4.11 Retrieving Production Data
Maximum Rows
When this box is checked, the maximum number of rows on the spreadsheet can be
specified for which data will be returned. When this box is not checked (default condition),
the number of rows for which data is available will be returned.
If there are fewer values available than there are rows specified, the excess rows are
left blank.
SQL Queries
The SQL queries will be used in a call to ABBSQL. This query may then be used in other
applications. The following are the equivalent SQL query for the functions described
above:
ABBSQL("SELECT CampaignID, RecipeName, StartTime, EndTime FROM
BatchHeaderInfo WHERE BatchID='BATCH_001' ORDER BY StartTime ASC)
DataDirect Functions
The DataDirect-specific functions will all follow this generic form:
ABBGetSomeView(ByVal BatchID as String, _
3BUF001094-610 A 214
4 DataDirect Inform IT
4.11 Retrieving Production Data
3BUF001094-610 A 215
4 DataDirect Inform IT
4.11 Retrieving Production Data
When this dialog is used, the F9 function can not be used to re-calculate the workbook
and retrieve new data. DataDirect does not provide an equivalent function for this
dialog at this time.
3BUF001094-610 A 216
4 DataDirect Inform IT
4.11 Retrieving Production Data
Search Criteria
Use this part of the PDL dialog to specify the Task Type, Task Value, and Time Span
for the search. Click Search when finished, Figure 4.91.
3BUF001094-610 A 217
4 DataDirect Inform IT
4.11 Retrieving Production Data
Task Type
This specifies the level of the PDL hierarchy to be searched. The choices in the Task
Type list are based on the Type of PDL selected in the Messages tab of the Options
dialog.
When the Task Type specification is changed, any previous results in the PDL dialog
are cleared.
For this release of the software, Batch 300 and TCL-specific criteria are automatically
applied to the search to prevent the retrieval of Batch records which do not belong
to the selected PDL type. If Batch 300 is the current PDL type, then TCL Batch records
will not be retrieved when a search for Batch records is executed. If TCL is the current
PDL type, then Batch 300 batch records will not be retrieved during a Batch search.
Task Value
This specifies the name of the task to query. If a name is not specified, all tasks are
returned. Enter the complete name, or just a partial name. The wildcard character% can
be used to search for a particular pattern or format. Leading and trailing blanks are
removed before the search is executed.
The Search Criteria is Case Sensitive option in the Messages tab of the Options dialog
determines whether or not to convert the task name to uppercase characters. This is a
convenience option for those systems in which all names are stored as uppercase.
Time Span
The Time Span fields is used to specify a time range for the query. These fields can be
enabled or disabled through their respective check boxes.
To restrict the query to a time range, check both boxes, and enter both the Start and
End date/times.
To make a query for all tasks starting before a specific date/time, check just the End
check box, and enter the End date/time.
3BUF001094-610 A 218
4 DataDirect Inform IT
4.11 Retrieving Production Data
To make a query for all tasks starting after a specific date/time, check just the Start
check box, and enter the Start date/time.
By default, the End date/time are set to the current date and time when the PDL
dialog is opened. The Start date/time are set based on the Search Time Span option
on the Messages tab in the Options dialog (Start date/time = End date/time minus
Search Time Span).
The method of operation for the date and time fields is the same as for the History dialog.
For further information refer to Time Span for Retrieval in Retrieving History Data on
page 164.
3BUF001094-610 A 219
4 DataDirect Inform IT
4.11 Retrieving Production Data
Search Results
This part displays a listing of tasks that meet the search criteria, Figure 4.93. The search
results include: Task Name, Start Time and End Time. The rows are sorted by Start
Time. The header for the first displayed column changes according to the Task Type
that was searched.
The Drill buttons are used to move up and down the PDL hierarchy for a selected task
in order to view the data at all levels of the hierarchy for a task. Refer to Drilling on page
221 for details.
To enter the PDL data into the Excel worksheet, click the Output Results button. Refer
to Output Results on page 222 for details.
If the search is performed for a level lower than the topmost (job or campaign) level of
the PDL hierarchy, the results will also include the task names at each level of the
hierarchy, up to the topmost level, for each row in the listing. For the example, the results
shown in Figure 4.93 are for a search done at the Unit level in a Batch 300 application.
Each unit’s Batch and Job names are retrieved in addition to the unit level data.
The first row in the Search Results listing is automatically selected (highlighted), and the
associated data for the selected item are available for viewing in the Associated Data
Listing section of the dialog. When a different row is selected, the contents of the
Associated Data Listing changes accordingly.
Column width and the sort order of the rows are fixed. Some column values may be
truncated in the display due to the fixed widths of the columns; however, when the values
are output to the worksheet, the complete value will be output. Horizontal and vertical
scroll bars are provided when the number of rows or columns exceeds the limits of the
Search Results window.
The main search result count is displayed above the result listing. The associated data
search count is displayed below the listing. If a query does not return any results, a row
with the text No Data is displayed underneath the header row. Additionally, the search
count displays No rows returned.
3BUF001094-610 A 220
4 DataDirect Inform IT
4.11 Retrieving Production Data
Drilling
The Drill buttons, Figure 4.94, are used to move up and down the PDL hierarchy for a
selected task in order to view the data at all levels of the task hierarchy.
Drilling down displays data for the selected task at the next level down in the hierarchy.
Drilling up displays data for the selected task at the next level up in the hierarchy. For
example, clicking the drill down button for unit R-101 in Figure 4.94, displays the
phase-level search results for R-101, Figure 4.95.
The Task Type value indicates the next level defined in the hierarchy. The Task Value
is reset to a blank value, and the time values retain their previous values.
Throughout the drilling process, the task record that was selected before the drill function
was performed will be highlighted when the opposite drill function is later performed. For
example, if an initial search is performed for a particular batch, the drill down function
will display data at the unit level for the selected batch. If drill down is executed again,
data at the phase level for the selected unit will be displayed. When Drill Up is selected,
data at the unit level will be displayed. The unit that was originally selected for the drill
down function will be highlighted when drilling back from the phase level to the unit level.
3BUF001094-610 A 221
4 DataDirect Inform IT
4.11 Retrieving Production Data
Output Results
The PDL Output dialog, Figure 4.96, is used to enter PDL data into the Excel worksheet.
To display this form, click Output Results in the Search Results section of the PDL
dialog.
Use the Output Items and Output Choices sections to specify which data to output. The
Output Formatting Options section is used to format the output results.
Output Items
The Output Items grouping is used to specify whether to output the results for all tasks
currently in the Search Results list, or limit the output to just the task that is currently
selected in the list. The default is to use just the selected task.
3BUF001094-610 A 222
4 DataDirect Inform IT
4.11 Retrieving Production Data
Output Choices
The output choices lists the data categories that can be output for the selected item(s),
Figure 4.97. The choices correspond with the data tabs provided on the PDL dialog in
the Associated Data Listing and are described in Table 4.5.
To select a data category for output to the Excel spreadsheet, select the category in the
Output Choices list and then click the > button. This moves the selected item to the
Chosen Outputs list. To select all categories at once, click >>.
To un-select a currently selected data category, select the entry from the Chosen Outputs
list and then click <. This moves the selected item back to the Output Choices list. To
un-select all items, click <<.
The order in which the data will be output is dictated by the sequence in the Chosen
Outputs list. To change the sequence, select an entry from the Chosen Outputs list and
then click the up or down arrow as required to move the item up or down
If no entry is placed in the Chosen Outputs list and either Apply or OK are clicked, the
output will consist of the data as it appears in the Search Results listing on the PDL
dialog.
3BUF001094-610 A 223
4 DataDirect Inform IT
4.11 Retrieving Production Data
3BUF001094-610 A 224
4 DataDirect Inform IT
4.11 Retrieving Production Data
Variables
This tab displays: variable name, value, time, occurrence number, result value and result
time. Rows are sorted by Time, Variable Name, then Occurrence, Figure 4.99.
3BUF001094-610 A 225
4 DataDirect Inform IT
4.11 Retrieving Production Data
Resources
This tab displays: Resource Type, Name, Value, Time and Occurrence. The rows are
sorted by Type, then by Name, then by Occurrence, Figure 4.100.
Messages
This tab displays the following message data for the selected task: Message Type,
Message and Local Time. The rows are sorted by Local Time, Figure 4.101.
When the PDL type is specified as Produce IT Batch or 800xA Batch Management,
the time is displayed in UTC time rather than local time.
3BUF001094-610 A 226
4 DataDirect Inform IT
4.11 Retrieving Production Data
Some PDL tasks may not have start or end time values. Running queries without time
boundaries could result in a huge number of returned records. When one of the times
is not available, DataDirect tries to get a start or end time from the parent record of a
task. If both the start and end times are still not available after this attempt, then a
restriction is put on the query to limit the Maximum Rows to be Returned. This is specified
through the PDL tab on the Options dialog.
History
This tab displays Log Name, Start Time, End Time, Phase and Occurrence. The rows
are sorted by Log Name then by Start Time, Figure 4.102.
The History association tables track the start and end times for which history values were
collected for a particular object. The PDL tables do NOT store the actual history values,
just the initial and final times of the collection period.
History Log associations can be retrieved at two levels — owner and individual task
level. Each history association record has a taskid for the level at which the history log
was started. Because the history log may span multiple tasks within a level of the
hierarchy, each history association record also has an “owner” task.
For example, consider a Batch application where history collection began during Batch
123. Batch 123 had four Phases through which the history collection spanned. Batch
123 is the owner for each of the four phases. When a search is executed for Batch 123,
a record is displayed in the History listing. Additionally, when a search is done for each
of the four phases, a record is also displayed for each of the phases, even though the
history collection spanned across all four. The Phase value will be displayed if the owner
task is the currently displayed item.
Clicking the Trend Display button launches the Trend Display view of the selected log.
3BUF001094-610 A 227
4 DataDirect Inform IT
4.11 Retrieving Production Data
Clicking View displays the PDL History Data dialog, Figure 4.103. This dialog provides
a listing of history timestamps, values and data quality values for the selected log. The
log name, start and end times are taken from the selected row in the History listing. The
Log Calculation Algorithm is set to “ANY” and the number of values to be returned is set
to 500.
The contents and formatting options for the display are taken from the Data Format tab
in the Options dialog.
Clicking Copy to Clipboard copies the entire contents of the listing into the computer’s
clipboard. Each line is separated by a carriage control character. Each column value is
separated with a tab within the line.
Next-Level Listing
Usually, the last tab in the Associated Data listings contains data from the history.task
table for the next level down in the hierarchy. The actual name of the tab is based on
the level in the hierarchy for the data. For example, if the current Task Type is a Unit in
a Batch 300 system, then the tab name will be Phase List. The header for the first column
of data changes to reflect the ‘child’ level name.
3BUF001094-610 A 228
4 DataDirect Inform IT
4.11 Retrieving Production Data
If the current Task Type is the last level in the hierarchy, this tab will not be displayed.
The following data are displayed: Task Name, Start Time and End Time. The rows are
sorted by Start Time, Figure 4.104.
3BUF001094-610 A 229
4 DataDirect Inform IT
4.12 Retrieving Data by SQL Query
3BUF001094-610 A 230
4 DataDirect Inform IT
4.12 Retrieving Data by SQL Query
5. Select the number of values to be returned in the Number of Values field. This is
used to set the maximum number of responses to a manageable quantity.
Enter an integer value directly in this field, or use the corresponding pick list. The
pick list choices are: MAX, 1, 50, 100, 200, 300, 400, 500. The largest possible
number is 65,534 for direct entry.
6. Click the Insert check box to ensure that existing data are not overwritten by new
data.
7. Enter the query in the SQL Statement window.
As an option, choose to save the query, or open an existing query that has already
been saved. This is described in Saving and Re-using SQL Queries on page 231.
To be prompted to save a new query before running the query or when closing the
dialog, check the Confirm Save check box.
8. Click OK or Apply to send the query.
The data orientation and formatting options described in Data Format on page 236 DO
NOT apply to SQL queries. An example query result is shown in Figure 4.107.
For complex queries, the Timeout interval may need to be increased. Click the Options
button to display the Options dialog. For details refer to Timeout in Setup on page
246.
Save Icon
3BUF001094-610 A 231
4 DataDirect Inform IT
4.12 Retrieving Data by SQL Query
This displays the Save dialog, Figure 4.109. Enter a name for the query, then click OK.
Open Icon
Figure 4.110: Open Icon
This dialog, Figure 4.111, is used to select an existing query to re-use in the SQL Query
dialog. A selected query may also be deleted, and toggled between the detailed and list
views. To open an existing query, select the query, then click OK.
This enables the Use Named Query check box on the SQL Query dialog. Check this
box to use the query by name rather than the actual query. By using the named query,
any modifications will be implemented whenever a spreadsheet is used with the named
query. By using the actual query (Use Named Query not checked), the changes will
need to be made in all spreadsheets that use the query.
To delete an existing query, select the query then click the Delete icon, Figure 4.111.
Use the List and Detail icons to list queries by name only, or show the full detailed view.
The detailed view indicates the query name, the user that saved the query, the date and
time when the query was last saved, and the full query text. Figure 4.111 shows the
detailed view.
3BUF001094-610 A 232
4 DataDirect Inform IT
4.13 Retrieving Values for TCL Unit Arrays
Click here to
delete the selected
query
This dialog does not support using the F9 function to re-calculate the workbook and
retrieve new data.
Follow these basic steps to access TCL unit array data with this dialog:
1. Select the starting cell in the spreadsheet.
2. Use the menu or tool bar to open the Inform IT TCL Unit Array dialog. Either click
the TCL Unit Array button in the tool bar, or choose
DataDirect Inform IT > TCL Unit Array from the menu bar, Figure 4.112.
3BUF001094-610 A 233
4 DataDirect Inform IT
4.13 Retrieving Values for TCL Unit Arrays
3. Select the TCL object type from the pick list. The selected TCL Object Type filters
the contents of the TCL Object pick list. It also determines the contents of the TCL
Attribute and Data Type fields. These fields are read-only.
Refer to the Object Types Reference Manual for details regarding TCL Unit Array
object types, and their respective attributes.
4. Select the TCL Object from the pick list. This is the name of the TCL Unit Array
variable as defined in the TCL Load statement. Refer to the TCL User’s Guide for
details regarding the Load statement.
5. Click OK or Apply to send the query.
Other optional procedures are:
• Changing the Start Cell on page 61.
• Inserting or Overwriting Rows on page 61.
• Formatting on page 66.
3BUF001094-610 A 234
4 DataDirect Inform IT
4.14 Using the Information Management Browser
3BUF001094-610 A 235
4 DataDirect Inform IT
4.15 Configuring Options
The Restore Defaults button in the Options dialog restores the defaults for the
currently selected tab.
3BUF001094-610 A 236
4 DataDirect Inform IT
4.15 Configuring Options
3BUF001094-610 A 237
4 DataDirect Inform IT
4.15 Configuring Options
3BUF001094-610 A 238
4 DataDirect Inform IT
4.15 Configuring Options
Horizontal Orientation
Vertical Orientation
3BUF001094-610 A 239
4 DataDirect Inform IT
4.15 Configuring Options
4.15.2 View
The View tab, Figure 4.120, is used to select which add-in tools to show or hide on the
DataDirect tool bar and menu bar. Add-in tools are grouped under two categories:
• Inform IT for use with earlier platforms, and when using DataDirect on a remote
computer client.
• Batch Management/PDL- for retrieving production data.
Each add-in tool has a separate check box for showing/hiding the add-in tool in the
DataDirect menu and/or the corresponding tool bar. Restore the default settings at any
time by clicking Restore Defaults. Figure 4.120 shows the default settings when
DataDirect is initially installed on an 800xA System node.
3BUF001094-610 A 240
4 DataDirect Inform IT
4.15 Configuring Options
4.15.3 PDL/Batch
This tab, Figure 4.121, is used to specify:
• Type of PDL (800xA Batch Management, Batch 300, TCL, Profile Historian).
• Search Time Span.
• Whether or not to Search Criteria is Case Sensitive.
• Whether to Use Active Database or Use Restored Archive.
• Options for the Batch Data Dialog.
3BUF001094-610 A 241
4 DataDirect Inform IT
4.15 Configuring Options
Type of PDL
Use this pick list to specify the PDL application: 800xA Batch Management (default),
Batch 300, Taylor Control Language (TCL), Produce IT Batch, or Profile Historian. This
determines types of tasks available in the Task Type list in the PDL dialog (Configuring
Options on page 235). Task types for the various PDL applications are indicated in Table
4.7.
3BUF001094-610 A 242
4 DataDirect Inform IT
4.15 Configuring Options
Table 4.7: Resulting Task Type Options Based on Type of PDL Selected
Type of PDL Task Type Options
800xA Batch Management (Default) Up to 15 user-configurable task types. Refer to
Configuring Flexible Task Types on page 243 for
details.
Produce IT Batch version 1.1 (and 1.2/0) Campaign - Level 0
Batch - Level 1
Procedures Level 1 - Level 2,3
Procedures Level 2 - Level 3,12
Phase - Level 12
Batch 300 Job, Batch, Unit, Phase
TCL TCL Batch
Profiles Profile Events (Reel, Grade, Dayshift) - Level 1
Roll Set Information - Level 2
Generic Not applicable for this release.
The Produce IT Batch option is only applicable for Produce IT Batch versions 1.1 and
1.2/0. When using Produce IT batch version 1.2/1 or later, or 800xA Batch
Management select the 800xA Batch Management PDL Type.
3BUF001094-610 A 243
4 DataDirect Inform IT
4.15 Configuring Options
This button displays the Customize PDL Hierarchy dialog, Figure 4.123. Each level has
a default name. These names can be changed. To choose which levels to include in the
Task Type list in the PDL dialog, check the corresponding checkbox. Any level whose
checkbox is checked is included in the list.
3BUF001094-610 A 244
4 DataDirect Inform IT
4.15 Configuring Options
3BUF001094-610 A 245
4 DataDirect Inform IT
4.15 Configuring Options
The Search Criteria is Case Sensitive check box is used to specify whether or not to
make the text strings in the text filter dialogs case sensitive. The default is to make the
text strings not case sensitive. The text strings will be case sensitive when this box is
checked.
4.15.4 Setup
This tab, Figure 4.125, is used to configure the following communications settings:
• Data Provider Connections.
• Enable/Disable Write Access to History and Process Values.
• Port Number.
• Timeout.
• Write Debug File.
3BUF001094-610 A 246
4 DataDirect Inform IT
4.15 Configuring Options
• Disable Functions.
• Auto Apply Filters.
•
Figure 4.125: Options Dialog, Setup Tab
3BUF001094-610 A 247
4 DataDirect Inform IT
4.15 Configuring Options
Data from a DCS data provider will be unavailable and its type set to UNK (unknown)
if DCS data provider connects to server after remote OPC data provider has been
connected. Do the following:
• Use different channel number for DCS data provider than one used by OPC data
provider. (This also requires changes in displays to reference new channel number
or new DCS data provider name).
• Make sure that DCS data provider connects to server before OPC data provider
does.
3BUF001094-610 A 248
4 DataDirect Inform IT
4.15 Configuring Options
Port Number
This is the current communications port on the computer from which data are being
retrieved. Use the default port (19014) unless there is a conflict between DataDirect and
some other application that requires that port number.
3BUF001094-610 A 249
4 DataDirect Inform IT
4.15 Configuring Options
Timeout
This is the maximum time that DataDirect will wait for the selected object to respond to
the query before timing out. Increase the timeout interval if the application uses complex
SQL queries.
Disable Functions
When this check box is selected, all DataDirect functions in the Excel spreadsheet are
disabled. Functions must be disabled when inserting functions as described in Configuring
Options on page 235. The functions must be enabled to execute a specific function, or
calculate the entire workbook.
Any time functions are disabled and then re-enabled, then all functions in the
spreadsheet must be executed individually before the F9 key can be used to calculate
the entire workbook.
2. The default path for %ABB_ROOT% is: C:\Program Files\Abb Industrial IT\
3BUF001094-610 A 250
4 DataDirect Inform IT
4.15 Configuring Options
This tab is NOT applicable for Industrial IT tools. Use the File Setup tab to manage text
files for object and attribute pick lists in the ad-hoc data retrieval/entry dialogs, as well
as the data provider pick lists on the Setup tab in the Options dialog. The operations
supported by this tab are:
• Changing the Text File Specification for a Pick List.
• Editing a Text File.
• Setting Object Name and Alias Options.
• Auto-Creating a Text File.
3BUF001094-610 A 251
4 DataDirect Inform IT
4.15 Configuring Options
The Auto Create function is only applicable for Message Log Types (for example
Message Log Tag Names). The button is dimmed for all other Types.
3BUF001094-610 A 252
4 DataDirect Inform IT
4.15 Configuring Options
1. To auto create a text file select one of the Message Log types, and then click the
Auto Create button, Figure 4.127. This displays the Auto Create dialog, Figure
4.128.
2. Use the Log Name and Database Field settings in this dialog to specify the message
log and message log attribute for which the file will be created.
Auto Create returns one instance of each unique entry in the specified Database
field. For instance, if the Database field is Tag_Name, and there are multiple
instances of the tag TC101, only one entry for that tag is returned.
3BUF001094-610 A 253
4 DataDirect Inform IT
4.15 Configuring Options
3. Use the Filter edit box to limit the number of entries in the file by returning only those
database items that satisfy the filter. For example, if the Database Field is Tag_Name,
and the filter is TC* (or TC%), the file will only be populated with tag names that
have the TC prefix.
The query result is written to a text file with a default name and location as indicated in
the Output File edit box. Change the file name and/or location as required. The Browse
button launches the standard Windows dialog for directory navigation and file selection.
The Edit button is used to open the specified file in the notepad text editor.
3BUF001094-610 A 254
4 DataDirect Inform IT
4.15 Configuring Options
4.15.6 Messages
This tab is used to configure message viewing options, Figure 4.129.
• Filter - when using the Alarm and Event tab on Inform IT Message Log dialog, this
specifies whether to query MOD 300 or Master message logs. Other specifies both
MOD 300 and Master.
• Query Time Span - specifies the default time span for message queries. This time
span can be changed when the message query is actually generated as described
in Retrieving Message Logs on page 189.
• Batch Messages - specifies the batch application being used:
– ProduceIT 1.1 PDL Messages - Produce IT Batch v1.1 - 1.2.
– Batch Management Messages Log - 800xA System batches.
3BUF001094-610 A 255
4 DataDirect Inform IT
4.16 Configuring Pick Lists for Advant OCS Objects
3. The default path for %ABB_ROOT% is: C:\Program Files\Abb Industrial IT\
3BUF001094-610 A 256
4 DataDirect Inform IT
4.17 Populating Pick Lists
3BUF001094-610 A 257
4 DataDirect Inform IT
4.17 Populating Pick Lists
Example MOD 300 Object Text File Example Master Object Text File
Figure 4.131: Example Text Files
3BUF001094-610 A 258
4 DataDirect Inform IT
4.17 Populating Pick Lists
When a specific object type is associated with an object, the object will only be included
in the Object pick list when the corresponding object type is selected. If an object type
is not associated with an object, the object will always be included in the Object pick list,
no matter which object type is chosen.
DO NOT enter a comma (,) after the object name unless an object type is also being
specified.
• Naming History Objects - For History Object text files, use the full log name as
specified in the History database. Include commas (,) if there are any. Refer to
Property Log Naming Conventions on page 32 for details regarding log name syntax.
• Data Providers - Enter the data provider name followed by the data provider type,
separated by a comma. Each instance of a data provider type requires a separate
line. For example in Figure 4.132, there are two DCS (real-time data) data providers.
One is named DCS (the default). The second is named DCS2.
Aliases
Aliases are alternate names for objects. Aliases can replace, or be used in combination
with object names where ever object names are used. This includes all object pick lists
in DataDirect dialogs, and in Excel spreadsheets where query results are displayed. An
example is shown in Figure 4.133.
Aliases are optional, and apply only to Object and History object text files. If the object
text file is created with aliases, then use the Options File Setup tab to specify whether
to show just aliases, just object names, or both aliases and object names.
3BUF001094-610 A 259
4 DataDirect Inform IT
4.17 Populating Pick Lists
Object Names
Aliases
To include aliases in the object text file, use the following format:
@Alias, ObjectName, ObjectType
To include aliases in the History object text file, use the following format:
@Alias, ObjectName,Attribute
The alias is the first value in each line, and must be prefixed with a @ symbol. An example
is shown in Figure 4.134.
3BUF001094-610 A 260
4 DataDirect Inform IT
4.18 Functions for Reading/Writing Inform IT Process Values
• The @ symbol MUST be the first character on the line. Leading spaces are not
allowed.
• Spaces are allowed in alias names, for instance Flow 1.
3BUF001094-610 A 261
4 DataDirect Inform IT
4.18 Functions for Reading/Writing Inform IT Process Values
4.18.1 ABBGetObj
The ABBGetObj function retrieves the specified attribute value for the specified object.
The Inform IT Process Values dialog may also be used in the Formula mode to insert
this function (Using the Inform IT Process Values Dialog on page 138). The syntax for
ABBGetObj is:
=ABBGetObj(Object Type, ObjectName [,Attribute] [,data provider])
where:
Object Type when getting data from an OPC server, enter OPC for object type. For
MOD 300 or Master OCS applications, this is the table name where
objects having a specific set of object attributes reside. For example,
CCF_PID_LOOP for systems with MOD 300 software, or PIDCON for
systems with Master software.
ObjectName is the tag name for the object. Use the object browsing tools in the
Process Values dialog to find object names for the specified object type.
Refer to Selecting OPC Tags on page 140.
[Attribute] is the name of the attribute whose value is to be retrieved. The attribute
specification is NOT required for queries on OPC objects. The Value
attribute is always returned.
[data specifies the name of the data provider through which this query will be
provider] routed. This parameter is optional. If a data provider is not specified, the
default data provider is used. To use a different data provider, specify
the -name argument that uniquely identifies the data provider. For further
details regarding data providers refer to Data Provider Connections on
page 247.
For OPC object values, the data provider must be referenced using the -name
argument and not the channel number. The Use Channel Numbers option must NOT
be selected in the Setup tab of the Options dialog.
Enter all parameters as text strings with double quotes. Examples:
=ABBGetObj(“CCF_PID_LOOP”, “TC101”, “MEASURE”)
=ABBGetObj(“PIDCON”, “FIC101”, “VALUE”)
=ABBGetObj (“OPC”, “CalculationServer_ENG189ExecPerMin:Value”)
4.18.2 ABBUpdateObj
The ABBUpdateObj function is used to update process values. This is the same
functionality provided by the Update Process Values dialog as described in Writing
Process Values on page 144.
3BUF001094-610 A 262
4 DataDirect Inform IT
4.18 Functions for Reading/Writing Inform IT Process Values
User Authority
The proper user authority is required to update process values. This is controlled at three
levels - data server, DataDirect client, and user:
• At the DataDirect client level, the Allow Process Updates option must be checked
on the Setup tab of the Options dialog. Log in as an Administrator-level user to
change these settings. Refer to Enable/Disable Write Access to History and Process
Values on page 249.
• At the data server level, the applicable data provider must be configured to allow
write transactions. This is the default set-up. Verify this set-up when configuring
data providers.
• On the user level, individual users must be authorized to write to process objects.
This is configured in the user preference file. By default, users are NOT granted this
authority. Adjust this preference for a user when managing Information Management
users.
Data Provider Specification
This function does not recognize data providers by channel number, but rather by the
-name argument. Therefore the Use Channel Numbers option in the Options dialog
Setup tab must be DEACTIVATED (not selected). Refer to Setup on page 246.
Syntax
The syntax is as follows:
=ABBUpdateObj (objtype, objname, value, [objatt], [,data provider])
where:
ObjType when updating data on an OPC server, enter OPC for object type. For
MOD 300 or Master OCS applications, this is the table name where
objects having a specific set of object attributes reside. For example,
CCF_PID_LOOP for systems with MOD 300 software, or PIDCON for
systems with Master software.
ObjName is the tag name for the object. Use the object browsing tools in the
Process Values dialog to find object names for the specified object type.
Refer to Selecting OPC Tags on page 140.
Value is the new value to be applied to the specified attribute.
ObjAtt is the name of the attribute whose value is to be retrieved. The attribute
specification is NOT required for queries on OPC objects. The Value
attribute is always returned.
3BUF001094-610 A 263
4 DataDirect Inform IT
4.19 Functions for Reading/Writing Inform IT History Values
[data specifies the data provider through which this update operation will be
provider] routed. This parameter is optional. If data provider is not specified, the
default data provider is used. To use a different data provider, specify
the -name argument that uniquely identifies the data provider. For further
details regarding data providers refer to Data Provider Connections on
page 247.
Enter all parameters as text strings with double-quotes.
Example:
=ABBUpdateObj("CCF_PID_LOOP", "FC3015", "SETPOINT", "8", "DCS")
=ABBUpdateObj(“PIDCON”, “FIC101”, “VALUE”, “19”, “DCS”)
=ABBGetObj (“OPC”, “CalculationServer_ENG189ExecPerMin:Value”, “100”, “AIPOPC”)
3BUF001094-610 A 264
4 DataDirect Inform IT
4.19 Functions for Reading/Writing Inform IT History Values
4.19.1 ABBGetHistory
The ABBGetHistory function retrieves a specified number of values for the specified
history log object. By default this function retrieves the columns of data selected on the
Data Format tab on the Options dialog. Refer to Data Format on page 236. The default
setting on this tab is to display Time Stamp, History Data Quality Indication, and Value.
Change the settings on the Data Format tab, or use the output parameter in this function
to change the output specification.
The syntax for ABBGetHistory is:
=ABBGetHistory(Logname, Interpolation, Start Time, End Time, MaxCount [,Format
Date] [,data provider][,output][,mSec])
where:
Logname is the access name for the log whose data is to be retrieved. Use the
object browsing tools in the History Values dialog to find log names. Refer
to Accessing Property Logs through OPC HDA on page 167.
Interpolation is the type of calculation performed by the log. The available options
depend on the connected data provider for history access. For further
information refer to Log Calculation Algorithm on page 92.
Start/End these specify the time range for which data will be retrieved.
Time
MaxCount specifies the number of values to return. This in combination with the
time span divides the time range into discrete intervals for which data
values are returned.
[Format is an optional parameter that is used to specify whether to use standard
Date] Excel formatting (n) or DataDirect formatting (y). Refer to Formatting the
Date on page 267.
[data specifies the data provider through which this operation will be routed.
provider] This is optional. If data provider is not specified, the default data provider
is used. To use a different data provider, specify the
-name argument that uniquely identifies the data provider. For further details regarding
data providers refer to Data Provider Connections on page 247.
[output] specifies the information to display as a result of the historical data query.
If this option is not specified, the information selected in the Data Format
tab of the Options dialog will be displayed (Data Format on page 236).
Use this option to specify that any combination of the following columns
be displayed:
header = 1
3BUF001094-610 A 265
4 DataDirect Inform IT
4.19 Functions for Reading/Writing Inform IT History Values
object name = 2
calculation = 4
time stamp = 8
attribute name = 16
data quality = 32
To use this option, enter the parameter as an integer which is equal to
the sum of the integer values for the columns being displayed. For
example, to specify the time stamp and object name, enter 10 (8 for
timestamp plus 2 for object name).
The history value is always displayed. Specify that only the history value
be displayed by entering 0.
[mSec] specifies whether or not to show the time stamp with millisecond resolution
(true = show milliseconds, false = do not show milliseconds).
Enter all parameters (except MaxCount, output, and displayMilliseconds) as text strings
with double quotes. For start time and end time, the date and time must be separated
by a space. MaxCount and output are specified as integer values.
Example:
=ABBGetHistory(“FC3051,MEASURE”, “max”, "11/3/00 14:30", “11/3/00 19:30”, 5,
“n”,“IMHDA”)
=ABBGetHistory(“H0000X000K-000000:MEASURE,log1”, “max”, "11/3/00 14:30", “11/3/00
19:30”, 5, “n”,“AIPHDA”)
3BUF001094-610 A 266
4 DataDirect Inform IT
4.19 Functions for Reading/Writing Inform IT History Values
Again, if there are less values in the log than there are rows specified, the excess rows
are left blank.
4.19.2 ABBEditLog
The ABBEditLog function is used to add a single entry to a lab data history log, or modify
an existing log entry. This is the same functionality provided by the Add/Modify Values
dialog as described in Adding/Modifying Entries for a Lab Data Log on page 173. To add
multiple entries in one function call, use ABBEditNLogs on page 269.
User Authority
3BUF001094-610 A 267
4 DataDirect Inform IT
4.19 Functions for Reading/Writing Inform IT History Values
The proper user authority is required to add and/or modify logs. This is controlled at three
levels - data server, DataDirect client, and user:
• At the DataDirect client level, the Allow Process Updates option must be checked
on the Setup tab of the Options dialog. Log in as an Administrator-level user to
change these settings. Refer to Enable/Disable Write Access to History and Process
Values on page 249.
• At the data server level, the applicable data provider must be configured to allow
write transactions. This is the default set-up. Verify this set-up when configuring
data access for display and client services.
• On the user level, individual users must be authorized to write to log objects. This
is configured in the user preference file. By default, users are NOT granted this
authority. Adjust this preference for a user when managing Information Management
users.
Data Provider Specification
This function does not recognize data providers by channel number, but rather by the
-name argument. Therefore the Use Channel Numbers option in the Options dialog
Setup tab must be DEACTIVATED (not selected). Refer to Data Provider Connections
on page 247.
Syntax
Enter all parameters as text strings with double-quotes. The syntax is as follows:
=ABBEditLog ("ADD" or "MODIFY”, ObjName, ObjValue, timeStamp, objectStatus
[,data provider])
where:
ObjName is the log name. Use the access name to add an entry. Always use the
full log name to modify. Use the object browsing tools in the History
Values dialog to find log names. Refer to Accessing Property Logs through
OPC HDA on page 167.
ObjValue is the new value for the log entry.
timeStamp is the time stamp for the entry. When modifying an existing entry the time
stamp must be accurate within one second. To get the precise time stamp,
retrieve the raw data for the log entry as described in Reading/Writing
History Data on page 162.
objectStatus is an option used to enter an integer value to associate with this log entry.
For example, ObjectStatus may be used to identify the user that
added/modified the entry. This value defaults to 0 (zero). It is not
necessary to change this value if this functionality is not used.
3BUF001094-610 A 268
4 DataDirect Inform IT
4.19 Functions for Reading/Writing Inform IT History Values
[data specifies the name of the data provider through which this update
provider] operation will be routed. This parameter is optional. If data provider is
not specified, the default data provider is used. To use a different data
provider, specify the -name argument that uniquely identifies the data
provider. For further details regarding data providers refer to Data Provider
Connections on page 247.
Examples:
=ABBEditLog("ADD", "H000X000K-000000,MEASURE", "15", "3/16/2001 13:22:00", "0",
"IMHDA")
=ABBEditLog("MODIFY", "H000X000K-000000:MEASURE,Log1", "15", "3/16/2001
13:22:00", "0", "AIPHDA")
4.19.3 ABBEditNLogs
The ABBEditNLogs function is used to add multiple entries to a lab data history log, or
modify existing log entries. This is the same functionality provided by the Add/Modify
Values dialog as described in Adding/Modifying Entries for a Lab Data Log on page 173.
To change one entry at a time, use ABBConnect on page 275.
User Authority and Data Provider Specification
The requirements for user authority and data provider specification are the same as for
ABBConnect on page 275.
Log Entry Specification
The log entry specification contains the values, time stamps and object statuses for each
log entry being added or modified. This specification must be entered in the proper format
in the spreadsheet. The function references the row/column range where this information
is entered. An example specification is shown in Figure 4.135.
Refer to ABBConnect on page 275 for details regarding values, time stamps, and object
statuses.
3BUF001094-610 A 269
4 DataDirect Inform IT
4.19 Functions for Reading/Writing Inform IT History Values
Syntax
The syntax is as follows:
=ABBNEditNLogs ("ADD" or "MODIFY”, ObjName, range, [,data provider])
where:
ObjName is the log name. Use the access name to add an entry. Always use the
full log name to modify. Use the object browsing tools in the History
Values dialog to find log names. Refer to Accessing Property Logs through
OPC HDA on page 167.
rangeis the range of rows and columns in the spreadsheet where the pre-formatted log
entry specification is located.
[data specifies the data provider through which this update operation will be
provider] routed. This parameter is optional. If data provider is not specified, the
default data provider is used. To use a different data provider, specify
the -name argument that uniquely identifies the data provider. For further
details regarding data providers refer to Data Provider Connections on
page 247.
Enter all parameters as text strings with double-quotes.
Examples:
To add a log:
=ABBNEditLogs("ADD", "FC3015,MEASURE", A1:C5, "LOG")
=ABBNEditLogs("ADD", "H000X000K-000000,MEASURE", A1:C5, "IMHDA")
To modify a log:
=ABBNEditLogs("MODIFY", "$HSFC3015,MEASURE-1-o", A1:C5, "LOG")
=ABBNEditLogs("MODIFY", "$H000X000K-000000:MEASURE,Log1", A1:C5, "AIPHDA")
3BUF001094-610 A 270
4 DataDirect Inform IT
4.19 Functions for Reading/Writing Inform IT History Values
4.19.4 ABBGetAttributes
The ABBGetAttributes function retrieves the attribute list for history objects that reside
on an OPC HDA server (for example, the 800xA OPC HDA server). Use the result from
this function call to query for attribute values in the ABBGetAttributeValue function.
To specify the server whose attribute list is being retrieved, indicate the corresponding
data provider -name in the function call. The syntax for ABBGetAttributes is:
=ABBGetAttributes(dataProvider)
where:
data provider indicates the -name argument of data provider that supports the OPC
HDA server whose attribute list is to be retrieve. For example, the -name
argument for the data provider that supports the 800xA OPC HDA server
is AIPHDA.
For further details regarding data providers refer to Data Provider
Connections on page 247.
Enter the data provider text string with double quotes. Example:
=ABBGetAttributes(“AIPHDA”)
4.19.5 ABBGetAttributeValue
The ABBGetAttributeValue function retrieves values for a specified OPC HDA object
attribute for a specified time period. The syntax for ABBGetAttributeValue is:
=ABBGetAttributeValue(ObjectName, TimeHandling, Time, TimeScope, AttributeID, data
provider)
where:
ObjectName Enter the object name directly if known. If not, use the History Values
dialog as described in Accessing Property Logs through OPC HDA on
page 167. If the Object Name has been inserted into the spreadsheet,
reference the applicable cell in this argument - for example: C9.
TimeHandling This is used in combination with Time and TimeScope to define the time
period for which to retrieve data. Enter one of the following text strings:
To - Causes Time to be used as an end point for the time period. The
start point is set by TimeScope.
From - Causes Time to be used as a start point for the time period. The
end point is set by TimeScope.
3BUF001094-610 A 271
4 DataDirect Inform IT
4.20 Miscellaneous Functions
Time This is the time period starting point (when TimeHandling is From) or
ending point (when TimeHandling is To)
TimeScope This specifies the amount of time (in seconds) to go back from Time
(when TimeHandling is To) or to go forward from Time (when
TimeHandling is From)
AttributeID is an integer value that identifies the attribute whose value is to be
retrieved. This ID is provided in the result of the ABBGetAttributes function
call.
data provider specifies the name of the data provider through which this query will be
routed. Specify the -name argument that uniquely identifies the data
provider. For further details regarding data providers refer to Data Provider
Connections on page 247.
Enter all parameters (except AttributeID and TimeScope) as text strings with double
quotes. For Time, the date and time must be separated by a space. AttributeID is an
integer. TimeScope is a long.
Examples:
=ABBGetAttributeValue(“C9”, “From”, "06/03/02 14:30", 28800, 7,”AIPHDA”)
This query gets the attribute value for the attribute whose ID = 7 for the object whose
name is inserted in cell C9 of the spreadsheet, starting at 14:30 on June 3rd 2002 and
ending eight hours later (28,800 seconds).
3BUF001094-610 A 272
4 DataDirect Inform IT
4.20 Miscellaneous Functions
4.20.1 ABBSql
The ABBSql function retrieves data according to the specified SQL query. It is intended
primarily for access to Oracle data. This function is not intended for querying historical
and process objects on Windows-based data servers. These applications are better
supported by ABBGetOPCHDA and ABBGetOPCDA.
To use this function to query historical and process objects on a Windows-based data
server, then install the Open Data Access (ODA) option on the data server, and
configure an ADO data provider to support ODA. The easiest way to create this data
provider is to copy the existing ADO data provider, and make the following two changes
to the data provider argument list:
• Change the -name argument, for example: from DBA to DBA1.
• Set the -dbname argument to Database1.
Configuring data providers is an Information Management configuration activity.
During development, attempt data retrieval for Numeric Logs using both methods
ABBGetOPCHDA() and the ODA provider using ABBSql(). Similarly for Alarm data test
using both ABBAERetrieval() and ABBSql() to the Message log. There are advantages
and disadvantages to each in terms of performance and the ability to manipulate the
data in a useful manner, often depending upon the application.
The syntax for ABBSql is:
=ABBSql(SQL Statement, MaxCount [,data provider])
where:
SQL is an SQL statement. A query saved through the SQL Query dialog
Statement (Saving and Re-using SQL Queries on page 231) or OPC/Audit Trail
message dialog (Saving a Query on page 196)may be used. To do this,
enter @QueryName, for example @MsgLog1.
MaxCount This is used to set the maximum number of responses to a manageable
quantity. The largest possible number is 9999.
[data specifies the data provider through which this query will be routed. This
provider] parameter is optional. If a data provider is not specified, the default data
provider is used. To use a different data provider, specify the -name
argument that uniquely identifies the data provider. For further details
regarding data providers refer to Data Provider Connections on page 247.
Enter the SQL statement and data provider (if used) as text strings with double quotes.
MaxCount is an integer.
Example:
3BUF001094-610 A 273
4 DataDirect Inform IT
4.20 Miscellaneous Functions
4.20.2 ABBArray
The ABBArray function retrieves data for the specified TCL unit array. The syntax for
ABBArray is:
=ABBArray(Object Type, Object, Attribute, MaxCount [,data provider])
where:
Object Type is the table name where TCL objects having a specific set of object
attributes reside. For example: TCL_AI_UNIT_VAR or
TCL_AS_UNIT_VAR.
Object is the name of the TCL object.
Attribute is the name of the attribute whose value is to be retrieved.
MaxCount This is used to set the maximum number of responses to a manageable
quantity. The largest possible number is 9999.
3BUF001094-610 A 274
4 DataDirect Inform IT
4.20 Miscellaneous Functions
[data specifies the data provider through which this query will be routed. This
provider] parameter is optional. If data provider is not specified, the default data
provider is used. To use a different data provider, specify the -name
argument that uniquely identifies the data provider. For further details
regarding data providers refer to Data Provider Connections on page 247.
Refer to the Object Types Reference Manual for more information on TCL Unit Array
object types, and their respective attributes.
Enter all parameters (except MaxCount) as text strings with double quotes. MaxCount
is an integer.
Example:
=ABBArray(“TCL_AI_UNIT_VAR”, “TIC101”, “AIVALUE”, 20)
Requesting All Data
The number of values returned by the ABBArray function is determined by the MaxCount
parameter, and by the number of rows selected in the Excel spreadsheet (step 2 in
Inserting DataDirect Functions Manually on page 73).
Use the MaxCount parameter to return all values in the array. To do this specify the
MaxCount parameter as 0. For example:
=ABBArray(“TCL_AI_UNIT_VAR”, “TIC101”, “AIVALUE”, 0)
• If MaxCount > selected rows, the excess values are truncated.
• If MaxCount < selected rows, the excess rows are filled in with blanks.
The maximum number of values that Excel is used to return is 32,767. This number
may be limited further by the amount of data associated with each value.
4.20.3 ABBConnect
ABBConnect is used to connect the DataDirect client to the data server. This is the same
functionality provided by the Login dialog as described in Login on page 135.
The syntax is as follows:
=ABBConnect (Host, User, Password)
where:
Host is the computer name for the computer where the display server software
is installed. Refer to Host on page 137.
User the user name for the Display client. Refer to User on page 136.
3BUF001094-610 A 275
4 DataDirect Inform IT
4.20 Miscellaneous Functions
Password is the password for the specified User. Refer to Password on page 136.
Enter all parameters as text strings with double quotes.
Example:
=ABBConnect ("tar220", "aid" ,"password")
4.20.4 ABBDisconnect
ABBDisconnect is used to disconnect the DataDirect client from the data server.
The syntax is as follows:
=ABBDisconnect ()
There are no parameters for this function.
Example:
=ABBDisconnect ()
To schedule a DataDirect report with VBA macros, set the Macro security level to low
on the computer where the report will run. Refer to Enabling Macros on page 52.
The following is a simple macro which extracts historical log data and charts it in an xy
scatter chart.
Sub runFunctionsFromMacro()
Dim outputRange As Range
3BUF001094-610 A 276
4 DataDirect Inform IT
4.20 Miscellaneous Functions
3BUF001094-610 A 277
4 DataDirect Inform IT
4.20 Miscellaneous Functions
3BUF001094-610 A 278
4 DataDirect Inform IT
4.20 Miscellaneous Functions
Original Formula
Edited Formula
3BUF001094-610 A 279
3BUF001094-610 A 280
5 Using Desktop Trends
5.1 Product Overview
This section describes how to use Desktop Trends for data access. To get familiar with
this application, refer to Product Overview on page 281. For connection and set-up
instructions, refer to Connection and Setup on page 282. For a solution to user errors
caused by changing regional settings, refer to Changing Regional Settings Causes User
Errors on page 287. For instructions on using the various desktop tools, refer to:
• Trend Display on page 289.
• Ticker on page 331.
• Tag Explorer on page 368.
• PDL Browser on page 378.
• Batch Batch Display on page 394.
• Event Browser on page 396.
• SQL Browser on page 400.
• OPC Browser on page 407.
3BUF001094-610 A 281
5 Using Desktop Trends
5.2 Connection and Setup
• The Batch to Batch Display combines the functionality of the Trend Display with
the PDL Browser to navigate the PDL structure to find and display historical trends
for different batches. Refer to Batch Batch Display on page 394.
• The Event Browser is used to retrieve messages from OPC and Audit Trail message
logs configured through the Information Management - History Server function. Refer
to Event Browser on page 396.
• The SQL Browser is used to run ad-hoc SQL queries. A query can be saved once
it is run. It can then be reopened for viewing at some time in the future or deleted.
Refer to SQL Browser on page 400.
3BUF001094-610 A 282
5 Using Desktop Trends
5.2 Connection and Setup
Enter the client user name and password. All other fields may be left at their default
values. All other fields may be left at their default values. Click OK when finished.
3BUF001094-610 A 283
5 Using Desktop Trends
5.2 Connection and Setup
Pre-defined text files are provided as a starting point. Customize these pick lists to better
fit the object/attribute selection requirements. This is done by creating new text files and
then associating those text files with the corresponding pick lists. Text files define the
contents of the pick lists for tag and attribute selection for the Ticker and Tag Explorer
controls. These text files are located in “%ABB_ROOT%InformIT\Desktop Trends\Default
Files\Picklists”.4
A set of standard text files are provided as described in Table 5.1. These standard files
are not complete, and are only intended as a starting point. Create additional files to
customize tag/attribute selection for the application. For instance, create a file structure
such as the one shown in Figure 5.2 to follow the specific plant structure.
4. The default path for %ABB_ROOT% is: C:\Program Files\ABB Industrial IT\
3BUF001094-610 A 284
5 Using Desktop Trends
5.2 Connection and Setup
3BUF001094-610 A 285
5 Using Desktop Trends
5.2 Connection and Setup
3BUF001094-610 A 286
5 Using Desktop Trends
5.3 Changing Regional Settings Causes User Errors
When adding an OPC tag to a ticker or tag explorer, and the OPC tag uses other OPC
tags to set the high/low limits, then enter the user-defined object type for high/low limits
in the new tag’s object type field, and set the Limit Check option to Get From System.
Refer to Tag Name on page 343, and Limit Check on page 344.
This settings has to be done to change the default settings of internet explorer 11
and above.
3BUF001094-610 A 287
5 Using Desktop Trends
5.4 Settings to open the Desktop Trend Tools
4. Click OK.
3BUF001094-610 A 288
5 Using Desktop Trends
5.5 Trend Display
The Trend display exposes control system trend data as graphic traces. It can display
from one to eight trended tags. Trend data is retrieved from property logs. The trend
definitions are html files that support navigation through Internet Explorer conventions.
In addition to well known trending functionality (scope, zooming, ruler and so forth) a
unique active zoom functionality is implemented. Active zoom is used to magnify a portion
of the current scope, without changing the overall scope. In this way a specific part of
the scope can be enlarged without losing the overview.
The Trend display is also used to:
• Zoom in to see greater detail, and zoom out to see a wider time scope.
• Use a ruler to select a point on the graphical view, and then read the corresponding
times and values for each trace.
• Apply filtering to a trace to reduce the percentage of samples.
• Apply a time offset for comparing different traces.
• Monitor the status for each trace.
• Capture data from either the graphical or table view, and then paste the data in a
third party application such as Microsoft Excel.
For instructions on setting up and using the Trend display refer to:
• Launching the Trend Display on page 289.
• Setting Up the Trend Display on page 293.
• Using the Trend Display on page 312.
3BUF001094-610 A 289
5 Using Desktop Trends
5.5 Trend Display
• DataDirect - by selecting Trend Display as the Retrieval Type in the History Values
dialog, or by clicking the Trend button on the PDL display. Refer to DataDirect
Operation for details.
• Ticker - Refer to Launching the Trend Display from the Ticker on page 366.
• Tag Explorer - Refer to Launching the Trend Display from the Tag Explorer on page
378.
• PDL Browser - Refer to History on page 393.
5.5.2 Description
The Trend Display, Figure 5.6, is divided into a Frame Bar, a toolbar for
Save/Open/Print/Browse operations, Graphical Trend Area, Value and Time Scales,
Scope/Zoom Tool Bar, and Table
3BUF001094-610 A 290
5 Using Desktop Trends
5.5 Trend Display
Frame Bar
The frame bar is provided by Internet Explorer. The description along the top of the
display is specific to the trend object and identifies the display type and associated tag
or name.
3BUF001094-610 A 291
5 Using Desktop Trends
5.5 Trend Display
Both the Table and the Scope/Zoom Tool Bar can be undocked so that they float
and can be moved to another location on the screen. When undocked, re-docking
one of these components moves it back to its original location. The context menu
can be used for these actions. Refer to Showing/Hiding and Docking/Undocking Trend
Display Components on page 325.
3BUF001094-610 A 292
5 Using Desktop Trends
5.5 Trend Display
3BUF001094-610 A 293
5 Using Desktop Trends
5.5 Trend Display
• specify the maximum number of interpolated points when the retrieval type is
interpolated. Refer to Maximum Interpolated Points on page 300.
• configure data update. Refer to Miscellaneous Settings on page 298.
• specify whether to save debug messages to a text file. Refer to Miscellaneous
Settings on page 298.
• configure print colors. Refer to Print Colors on page 300.
• view connection status information. Refer to Status on page 302.
• view version information. Refer to Versions on page 303.
5.5.5 Data
The Data tab, Figure 5.10, is used to:
• specify default and trace-specific data provider connections. Refer to Data Provider
Connections on page 295.
• specify whether to retrieve raw or interpolated data. Refer to Raw/Interpolated Data
on page 295.
• apply an aggregate (calculation) to a trace. Refer to Aggregates on page 296.
3BUF001094-610 A 294
5 Using Desktop Trends
5.5 Trend Display
Raw/Interpolated Data
New traces are automatically assigned the default data type specified in this dialog,
Figure 5.11. Change the specification for individual traces by clicking the trace’s Int or
Raw option button. Reset all individual traces to the default specification by clicking
Update All.
Data Type
Buttons
Figure 5.11: Selecting Raw or Interpolated Data
• Interpolated - This returns values at regular intervals. The specified time range and
the Maximum Interpolated Points property (set through Miscellaneous Settings tab)
divide the time range into discrete intervals for which interpolated values are
calculated. For example, if the time range is 15 hours and Maximum Interpolated
Points is 300 (default), a value will be provided for each three-minute interval. The
values are not actual samples, but rather values interpolated from the actual samples.
If the number of values requested exceeds pixel capacity of the screen, the trend will
display as many points has it can, and the Maximum Interpolated Points setting will
automatically adjust itself to that number.
• Raw - This returns values for actual samples collected and stored by History. If the
quantity of raw values exceeds the width of the trend display, a warning message
will be displayed, and the trace will be drawn with interpolated values.
3BUF001094-610 A 295
5 Using Desktop Trends
5.5 Trend Display
Aggregates
Any aggregate (calculation) can be applied to the trend that is supported by the OPC/HDA
server. To do this click in the Aggregates column, Figure 5.12. The Aggregates menu
includes all aggregates support by the HDA server. An aggregate cannot be applied to
any trace whose data type is set to Raw (Raw/Interpolated Data on page 295).
5.5.6 Visibility
This tab is used to specify whether to show or hide various features on the trend display,
Figure 5.13, such as the Info area in its entirety, or individual columns in the table.
The Trend Area X and Y-axis features relate to the standard time (X-axis) and value
(Y-axis) scales. Zoom Bar displays the Scope/Zoom Tool Bar. When checked, Value
Scales displays the numeric Max./Min. values along the left side of the trend graphic.
The Time Scales can be displayed without the Date Scales; however, the Date Scales
can not be shown without the Time Scales. The Slide option allows the slide to be turned
on or off; however, it only is useful with the Active Zoom feature.
All items are checked (shown) by default. Individual items can be unchecked to hide
them. After making selections, click OK to exit.
3BUF001094-610 A 296
5 Using Desktop Trends
5.5 Trend Display
The Table or Scope/Zoom Tool Bar can also be shown or hidden directly from the
Trend area context menu.
3BUF001094-610 A 297
5 Using Desktop Trends
5.5 Trend Display
• Column widths may also be set directly on the Table view. Refer to Using the
Table (Info) Area on page 322.
• If the Visibility of a column is turned off, the column width is set to zero and cannot
be changed in the Setup dialog.
3BUF001094-610 A 298
5 Using Desktop Trends
5.5 Trend Display
• Whether or not to read limits, engineering units, and description information for
traces from the database. Refer to Database Information on page 300.
• whether or not to save debug information. Refer to Saving Debug Information on
page 300.
Colors
To specify a color for trend background, ruler, or grid, double-click the applicable box.
This displays the standard Windows color-chooser dialog.
3BUF001094-610 A 299
5 Using Desktop Trends
5.5 Trend Display
Database Information
The check boxes in this section are used to specify whether the corresponding attributes
will be read from the database. When a check box is checked, the database reading can
be superseded by entering a value directly in the table (info) area or through the Property
Page. However, the database settings will replace any entries made the next time the
Trend display is opened.
3BUF001094-610 A 300
5 Using Desktop Trends
5.5 Trend Display
To preview the color scheme, click the Toggle Print Color icon on the toolbar, Figure
5.18. An example preview is shown in Figure 5.19.
3BUF001094-610 A 301
5 Using Desktop Trends
5.5 Trend Display
5.5.10 Status
The Status tab, Figure 5.20, lists messages relating to the success or failure of a
connection between the trend control and the history log that is the data source. When
a connection succeeded message is displayed, trend data is collected. A communication
failed message occurs when data can not be retrieved. The trend control will try to
re-establish the connection five times before terminating further attempts. If this happens,
check the Information Management server, and the client where this application is running
to make sure everything is ok. The Clear button clears the status information.
3BUF001094-610 A 302
5 Using Desktop Trends
5.5 Trend Display
5.5.11 Versions
This tab shows version information for the trend display, Figure 5.21.
3BUF001094-610 A 303
5 Using Desktop Trends
5.5 Trend Display
3BUF001094-610 A 304
5 Using Desktop Trends
5.5 Trend Display
Enabled
The Enabled check box in the upper right portion of this page is used to enable (show)
or disable (hide) the trace. The trace is enabled when the box is checked. Traces may
also be enabled/disabled directly in the Table (Info) area.
Name
This is the tag name for the trace’s data source. Follow the naming conventions for the
system where the tag resides.
Description
The Description is an optional text string to further identify the trace.
3BUF001094-610 A 305
5 Using Desktop Trends
5.5 Trend Display
Trace Type
This pull-down list is used to specify whether to show the trace as a Line, Pole, Step,
and Rev. Step. Refer to Type on page 323.
Trace Lines
The controls in this section are used to specify the color and thickness of the trace lines
for indicating Normal Data, No Data, or Bad Data. Double click on the line to get a color
menu and select a color.
Limit Lines
The controls in this section are used to specify the high and low values, color and
thickness of the limit lines. The corresponding Enabled check box is used to enable
(show) or disable (hide) these lines.
Scale
The fields in this section are used to specify the minimum and maximum values and
format of the value scale.
Scale Format
0 Digit placeholder. Display a digit or a zero. If the expression has a digit
in the position where the 0 appears in the format string, display it;
otherwise, display a zero in that position.
If the number has fewer digits than there are zeros (on either side of the
decimal) in the format expression, display leading or trailing zeros. If the
number has more digits to the right of the decimal separator than there
are zeros to the right of the decimal separator in the format expression,
round the number to as many decimal places as there are zeros. If the
number has more digits to the left of the decimal separator than there
are zeros to the left of the decimal separator in the format expression,
display the extra digits without modification.
# Digit placeholder. Display a digit or nothing. If the expression has a digit
in the position where the # appears in the format string, display it;
otherwise, display nothing in that position.
3BUF001094-610 A 306
5 Using Desktop Trends
5.5 Trend Display
This symbol works like the 0 digit placeholder, except that leading and
trailing zeros aren't displayed if the number has the same or fewer digits
than there are # characters on either side of the decimal separator in the
format expression.
. Decimal placeholder. In some locales, a comma is used as the decimal
separator. The decimal placeholder determines how many digits are
displayed to the left and right of the decimal separator. If the format
expression contains only number signs to the left of this symbol, numbers
smaller than 1 begin with a decimal separator. To display a leading zero
displayed with fractional numbers, use 0 as the first digit placeholder to
the left of the decimal separator. The actual character used as a decimal
placeholder in the formatted output depends on the Number Format
recognized by the system.
% Percentage placeholder. The expression is multiplied by 100. The percent
character (%) is inserted in the position where it appears in the format
string.
, Thousand separator. In some locales, a period is used as a thousand
separator. The thousand separator separates thousands from hundreds
within a number that has four or more places to the left of the decimal
separator. Standard use of the thousand separator is specified if the
format contains a thousand separator surrounded by digit placeholders
(0 or #). Two adjacent thousand separators or a thousand separator
immediately to the left of the decimal separator (whether or not a decimal
is specified) means "scale the number by dividing it by 1000, rounding
as needed." For example, use the format string "##0,," to represent 100
million as 100. Numbers smaller than 1 million are displayed as 0. Two
adjacent thousand separators in any position other than immediately to
the left of the decimal separator are treated simply as specifying the use
of a thousand separator. The actual character used as the thousand
separator in the formatted output depends on the Number Format
recognized by the system.
E- E+ e- e+ Scientific format. If the format expression contains at least one digit
placeholder (0 or #) to the right of E-, E+, e-, or e+, the number is
displayed in scientific format and E or e is inserted between the number
and its exponent. The number of digit placeholders to the right determines
the number of digits in the exponent. Use E- or e- to place a minus sign
next to negative exponents. Use E+ or e+ to place a minus sign next to
negative exponents and a plus sign next to positive exponents.
3BUF001094-610 A 307
5 Using Desktop Trends
5.5 Trend Display
Scope
The Scope section, Figure 5.24, is only displayed when multiple scopes are enabled
through the Scope tab. In this case, the scope for each trace is specified through its
respective trace tab. If single scope is specified, all traces share the same scope which
is set through the Scope tab. For details on how to set the formats for the data and time
fields, refer to Date Format on page 310 and Time Format on page 311.
3BUF001094-610 A 308
5 Using Desktop Trends
5.5 Trend Display
3BUF001094-610 A 309
5 Using Desktop Trends
5.5 Trend Display
Scope Type
This determines how the scope start and end time are specified. The StartTime and
EndTime fields are enabled/disabled based on this setting.
• Start End - Used to specify the start and end time for the scope. In this case the
Scope Width fields are disabled.
• Start Scope - Used to specify the start time for the scope. The end time is determined
by specifying the Scope Width.
• End Scope - Used to specify the end time for the scope. The start time is determined
by specifying the Scope Width.
• Current Scope - Uses the current time as the end time. The start time is determined
by specifying the Scope Width.
Mode
This is used to specify whether all traces will share the same scope, or whether each
trace will have a unique scope. This feature is disabled when the Scope Type is Current
Scope. If a single scope is used for all traces, configure the StartTime and EndTime on
this tab.
If multiple time ranges are used, the scope for each trace must be specified on its
respective trace tab. Scopes are color-coded to match their respective traces. The trend
display shows the scope for one trace at a time. This is selected through the time scale
context menu as described in Selecting the Time Scale for a Trace on page 328.
Scope Width
The Scope Width is used to specify the duration of the trace in days and hours. This
option is disabled when Scope Type is set to Start End.
Date Format
This specifies the format to use for the date portion of the time scale labels. Use the
dash (-) character to separate day, month, and year units. Valid character strings for
day, month, and year are described below:
3BUF001094-610 A 310
5 Using Desktop Trends
5.5 Trend Display
Day options:
• d - Display the day as a number without a leading zero (1 - 31).
• dd - Display the day as a number with a leading zero (01 - 31).
• ddd - Display the day as an abbrethroughtion (Sun-Sat).
• dddd - Display the day as a full name (Sunday-Saturday).
• ddddd - Display the date as a complete date (including day, month, and year),
formatted according to the system's short date format setting. The default short date
format is m/d/yy - for example: 2-7-02 (February 7, 2002).
• dddddd - Display a date serial number as a complete date (including day, month,
and year) formatted according to the long date setting recognized by the system.
The default long date format is mmmm dd, yyyy - for example February 07, 2002.
Month options:
• m- Display the month as a number without a leading zero (1 - 12).
• mm - Display the month as a number with a leading zero (01 - 12).
• mmm - Display the month as an abbrethroughtion (Jan -Dec).
• mmmm - Display the month as a full name (January-December).
Year options:
• y - Display the day of the year as a number (1 - 366).
• yy - Display the year as a 2-digit number (00 - 99).
• yyyy - Display the year as a 4-digit number (100 - 9999).
Examples for February 7, 2002
Date units can be entered in any order. Some valid combinations are illustrated below:
dd-mm-yy = 07-02-02
d-m-yy = 7-2-02
mm-d-yyyy = 02-7-2002
y = 38
Time Format
This specifies the format to use for the time portion of the time scale labels. Use the
colon (:) character to separate hour, minute, and second units. Valid character strings
hours, minutes, and seconds are described below:
3BUF001094-610 A 311
5 Using Desktop Trends
5.5 Trend Display
Hour options:
• h - Display the hour as a number without a leading zero (0 - 23).
• hh - Display the hour as a number with a leading zero (00 - 23).
Minute options:
• m- Display the minute as a number without a leading zero (0 - 59).
• mm - Display the minute as a number with a leading zero (00 - 59).
Second options:
• s - Display the second as a number without leading zero (0 - 59).
• ss - Display the second as a number with a leading zero (00 - 59).
24-hour Clock or 12-hour Clock:
Time is displayed in 24-hour format by default. To display time in 12-hour format append
AMPM to the time specification, for example: hh:mm:ss AMPM. In this case, 15:45:30
would be displayed as 03:45:30 PM
Examples for 15:45:30:
hh:mm:ss= 15:45:30
hh:mm:ss AMPM = 03:45:30 PM
3BUF001094-610 A 312
5 Using Desktop Trends
5.5 Trend Display
This adds a new row in the Table . To configure the new trace, first enter the tag name
in the table (info) area, and then refer to Property Page on page 304.
Traces for OPC HDA objects may also be added through the OPC Browser. Refer
to Browsing an OPC Server on page 313.
To delete a trace, right-click in the trend area and choose Trace>Remove>Trace# from
the context menu, Figure 5.27.
3BUF001094-610 A 313
5 Using Desktop Trends
5.5 Trend Display
To launch this browser, click the Browse Objects button on the tool bar, Figure 5.28.
3BUF001094-610 A 314
5 Using Desktop Trends
5.5 Trend Display
3BUF001094-610 A 315
5 Using Desktop Trends
5.5 Trend Display
2. In the left pane, browse to the location for property logs (usually the control structure).
The contents of the left pane varies, depending on the type of OPC HDA server.
For AIPHDA, the browser provides a directory structure similar to the Plant Explorer,
Figure 5.29.
For IMHDA, the left pane is used to choose one of three methods by which to conduct
a search: EH for local access, EH_PUBL for published archived log data, and
EH_NET for network-wide access (LOGMAN is not applicable).
The following browsing methods are supported:
• Basic point and click to show the logs within a specific folder.
• Select a folder then choose Get Entire List from the context menu. This shows
all logs in the selected folder as well as logs from all sub-folders within the
selected folder.
• Apply a filter to either show or exclude all logs whose name has a specified text
string.
• With AIPHDA, the Seamless retrieval option can be used when it is uncertain
which component log within the property log will provide best coverage of the
requested time range.
3BUF001094-610 A 316
5 Using Desktop Trends
5.5 Trend Display
3. Select one or more objects in the middle pane, and then move them to the Selected
Tags (right) pane by clicking the > button. To move all objects from the middle to
the Selected Tags pane, click the >> button. To remove selected tags from the list
use either the < or << buttons.
4. Combine tags from different locations by repeating steps 2 and 3.
5. When finished selecting tags, click Add Traces. This adds traces for the selected
tags.
As an option, copy tags from this browser to the clipboard for pasting into external
applications.
3BUF001094-610 A 317
5 Using Desktop Trends
5.5 Trend Display
3BUF001094-610 A 318
5 Using Desktop Trends
5.5 Trend Display
Value Zoom
SHIFT+Left Mouse starts a value zoom which is shown as the mouse is dragged as
white lines draw the new high and low value area (vertical lined box). When releasing
the mouse the value scales are changed.
Time Zoom
CTRL+Left Mouse starts a time zoom which is shown as the mouse is dragged as white
lines draw the time area (horizontal lined box). When releasing the mouse the time scales
are changed.
Area Zoom
CTRL+SHIFT+Left Mouse starts an area zoom which is shown as the mouse is dragged
as white lines draw the combined value/time area, Figure 5.31. When releasing the
mouse the time and value scales are changed.
3BUF001094-610 A 319
5 Using Desktop Trends
5.5 Trend Display
3BUF001094-610 A 320
5 Using Desktop Trends
5.5 Trend Display
Backward Active
Set Start
Scope Step Zoom Zoom
Time
Large/Small Out Level/Enable
Zoom In
Activating the Zoom In button will decrease the scope Zoom Factor In amount (in %).
Default for Zoom Factor In is 25%.
Zoom out
Activating the Zoom Out button will increase the scope Zoom Factor Out amount (in %).
Default for Zoom Factor Out is 25%
Default Scope
Activating the Default Scope button will restore the trend to the Current Scope with a 30
minute scope width.
3BUF001094-610 A 321
5 Using Desktop Trends
5.5 Trend Display
3BUF001094-610 A 322
5 Using Desktop Trends
5.5 Trend Display
To adjust the screen space for the graphical view, open or close the table through the
context menu or the Visible tab on the Setup dialog (Setup Dialog on page 293). The
table can also be undocked so that it floats and can be moved to another location on the
screen. When undocked, re-docking the table moves it back to its original location. This
functionality is provided through a right-click (context) menu. Refer to Showing/Hiding
and Docking/Undocking Trend Display Components on page 325
Trace
Alternately show or hide a trace by checking or unchecking its check box. These check
boxes are color-coded to match the trace color.
Name
This is the tag name for the trace’s data source. Follow the naming conventions for the
system where the tag resides.
Description
The description is read from the system database by default. Disable this function through
the Miscellaneous Settings tab on the Setup dialog (Database Information on page
300). When this function is enabled, the database reading can be superseded by entering
a value directly in the table (info) area or through the Property Page. However, the
database settings will replace any entries made the next time the Trend display is opened.
Type
This pull-down list is used to select the presentation for the trace in the graphical view.
The options are shown in Figure 5.34 and described below:
Line - Time between values shown as line indicating interpolated rate of change. When
viewing interpolated data, the ruler value shows the interpolated values. When viewing
raw data, the ruler value only shows actual stored values. Refer to Ruler Value on page
324.
3BUF001094-610 A 323
5 Using Desktop Trends
5.5 Trend Display
Status
This cell shows the quality status of the tag data (trace colors are set on the Trace tab
of the Property Page - refer to Property Page on page 304):
• When the status is GOOD, the trace color appears as Normal Data.
• When status is BAD, the trace color appears as Bad Data.
• When status is NODATA, the trace color appears as No Data.
Ruler Time
This column indicates the time corresponding to the current ruler position (when ruler is
active). If a time offset has been applied to one or several traces, the times in this column
will differ for each trace. When the ruler is placed between two data points for a trace,
the stored time for the closest point is used.
Ruler Value
This column indicates the value for each trace corresponding to the current ruler position.
When the ruler is placed between two data points for a trace, the value for the older point
is used until the next sample time is reached.
Engineering Units
The engineering units are read from the system database by default. Disable this function
through the Miscellaneous Settings tab on the Setup dialog (Database Information on
page 300). When this function is enabled, the database reading can be superseded by
entering a value directly in the table (info) area or through the Property Page. However,
the database settings will replace any entries made the next time the Trend display is
opened.
3BUF001094-610 A 324
5 Using Desktop Trends
5.5 Trend Display
Filter
The trend filter is a low pass filter that is used to smooth a trend and remove unwanted
signal noise. The filter value entered for each trace must be a value between 0.0 and
1.0 inclusive. At 1.0, no points are removed and a true trace is given. At 0.0, all but one
point is removed resulting in a flat trace. The relationship is linear so that fifty percent of
the points would be removed at 0.5.
Time Offset
This cell shows the time offset for the trace. To time scope directly, select the cell and
then enter the desired offset. Refer to Applying Time Offsets on page 329.
Limits
Alternately show or hide the corresponding high/low limit lines by checking or un-checking
this cell. If these limits are violated, the trace is drawn with the limit color where the limit
is exceeded. The trace limits are read from the system database by default. Disable this
function through the Miscellaneous Settings tab on the Setup dialog (Database
Information on page 300). When this function is enabled, the database reading can be
superseded by entering a value directly in the table (info) area or through the Property
Page. However, the database settings will replace any entries made the next time the
Trend display is opened.
Figure 5.35: Context Menu for Zoom Bar and Info Area
3BUF001094-610 A 325
5 Using Desktop Trends
5.5 Trend Display
This displays the Statistics window, Figure 5.37. Set the resolution for the statistical
values through the Decimal Places control. The default is three decimal places.
Copy statistics for selected traces to the clipboard for pasting into external application
such as Microsoft Word or Excel. The copy function is shown in Figure 5.38. Statistical
information can also be dragged to the external application if this functionality is supported
by the application.
3BUF001094-610 A 326
5 Using Desktop Trends
5.5 Trend Display
3BUF001094-610 A 327
5 Using Desktop Trends
5.5 Trend Display
2. To paste the bitmap image to an external application (for instance, Microsoft Excel),
go to the external application and use the Paste function to copy the contents of the
Windows paste buffer.
3BUF001094-610 A 328
5 Using Desktop Trends
5.5 Trend Display
Figure 5.41: Example, Same Trend With and Without Time Offset
3BUF001094-610 A 329
5 Using Desktop Trends
5.5 Trend Display
The Save button is used to save the current Trend Display as an Html file. Clicking
this button displays a standard Windows Save dialog. This dialog points to the default
location where Trend Display html files are stored (C:\ABB Industrial IT\Inform IT\Desktop
Trends\Data\Html). This dialog can be pointed to another location to store the files in
another directory. Once a display has been saved as an Html file, it can be reopened
for viewing as described in Opening a Saved Display on page 330.
The tool bar buttons for saving displays as HTML files and for printing displays MUST
be used rather than the File>Save and File>Print functions available through the
Internet Explorer user interface.
The Open button is used to open an existing Trend Display which was previously
saved as an html file. Clicking this button displays a standard Windows file chooser
dialog. This dialog points to the default location where Trend Display html files are stored
(C:\ABB Industrial IT\Inform IT\Desktop Trends\Data\Html). Point this dialog to another
location if files are stored in another directory.
The Print button on the Trend Display is used to print the entire trend display,
including the table data. Clicking this button displays a standard Windows print dialog.
DO NOT use File>Print in Internet Explorer. This function does not work due to an ActiveX
limitation.
5.5.31 Launching Other Desktop Trend Tools from the Trend Display
The operations tool bar is used to launch the other tools from the Trend Display, Figure
5.8.
3BUF001094-610 A 330
5 Using Desktop Trends
5.5 Trend Display
5.5.32 Ticker
The Ticker displays a repeating stream of real time data for selected tags, similar to a
stock market ticker, Figure 5.42. It is an ActiveX control hosted within Windows Internet
Explorer. Access real-time data from the 800xA OPC DA server, a third party OPC DA
server, or an Advant OCS (MOD 300 and Master) by connecting to the applicable data
provider. Additionally, specify whether to retrieve the actual process data or the last
history value from the history log associated with the process tag.
Make sure the text files for the pick lists and limits file have been configured as
described in Setting Up Pick Lists on page 283.
3BUF001094-610 A 331
5 Using Desktop Trends
5.5 Trend Display
3BUF001094-610 A 332
5 Using Desktop Trends
5.5 Trend Display
The Tag Configuration dialog is shown in Figure 5.45. This dialog has two tabs.
3BUF001094-610 A 333
5 Using Desktop Trends
5.5 Trend Display
Use the Tags tab to specify which tags to include in the ticker file. Tags can be added
from the following data sources:
• 800xA OPC HDA server.
• OPC DA servers.
• Advant OCS (MOD 300 and Master).
Use the Appearance tab to configure ticker presentation characteristics and general
operating parameters.
This dialog and the procedures for adding and removing tags also apply for adding
tags to a tag group in the Tag Explorer. The only difference is the absence of the
Appearance tab which is not required for the Tag Explorer.
3BUF001094-610 A 334
5 Using Desktop Trends
5.5 Trend Display
It is recommended that the size of a Ticker File be limited to no more than 50 tags.
• The Old Style view supports connecting to an older server that contains Advant
OCS (MOD 300 or Master) tags. To use this view select the Old Style option button,
then refer to Adding an Advant OCS Tag on page 341.
3BUF001094-610 A 335
5 Using Desktop Trends
5.5 Trend Display
3BUF001094-610 A 336
5 Using Desktop Trends
5.5 Trend Display
1. In the left pane, browse to the location for property logs (usually the control structure).
The data provider defaults to AIPOPC which is used to browse the plant structure
for real time OPC-type tags. This is recommended when adding OPC tags for the
Ticker and Tag Explorer.
To retrieve the last history value rather than the actual real time value, change the
data provider name to an HDA data provider (AIPHDA or IMHDA), then click Change,
Figure 5.47. The data provider specification may also be changed for individual tags
once they are selected. This is described later in this procedure.
The browser defaults to the last selected location. The following browsing methods
are supported:
• Basic point and click to show the objects within a specific folder.
• Select a folder then choose Get Entire List from the context menu. This shows
all objects in the selected folder as well as objects from all sub-folders within
the selected folder.
• Apply a filter to either show or exclude all objects whose name has a specified
text string. Figure 5.48 shows how a filter may be used to limit the scope of
selectable objects.
• With AIPHDA, the Seamless retrieval option can be used when it is uncertain
which component log within the property log will provide best coverage of the
requested time range.
3BUF001094-610 A 337
5 Using Desktop Trends
5.5 Trend Display
Example Filter
Filter result
The available objects (of the applicable type) will be displayed in the available
tags list in right pane.
2. Select one or more objects from the available tags list, Figure 5.49, and then click
Add Selected Tags to move them to the Selected Tags list (bottom pane), Figure
5.50.
Move all available tags by clicking Add All Tags. However, be careful when selecting
this option, particularly if the available tag list is unfiltered.
3BUF001094-610 A 338
5 Using Desktop Trends
5.5 Trend Display
3BUF001094-610 A 339
5 Using Desktop Trends
5.5 Trend Display
5. To remove a tag from the selected tags list, check the corresponding check box,
then click Remove Selected Tags, Figure 5.52.
6. When finished selecting tags, click OK. This adds the tags to the ticker. As an option,
copy tags from this browser to the clipboard for pasting into external applications.
3BUF001094-610 A 340
5 Using Desktop Trends
5.5 Trend Display
3BUF001094-610 A 341
5 Using Desktop Trends
5.5 Trend Display
Specify the tag properties starting with tag name. To specify each property, click in the
corresponding field. This highlights the property label (bold type). If the field has an
associated pick list, the pick list contents are displayed on the right side of the dialog.
For example, when clicking in the first field, the Tag Name label is highlighted, and the
tag name pick list is displayed, Figure 5.55.
Tag Name
Picklist Displayed
3BUF001094-610 A 342
5 Using Desktop Trends
5.5 Trend Display
Tag Name
Tag name is one of three properties used to reference a specific data point. The other
two are Attribute and Object Type. To enter the tag name, click in the first field. This
highlights the Tag Name label and displays the tag name pick list, Figure 5.55. Either
enter the value directly in the field, or use the corresponding pick list.
To add aspect objects from the platform’s OPC DA or OPC HDA server, use the
Browse button. Refer to Browsing for OPC Objects on page 335.
The Tag Name pick list shows up to 25 tags at a time. When the Ticker File contains
more than 25 tags, a pull-down list is displayed at the bottom of the dialog. This is used
to display another set of up to 25 tags in the pick list, Figure 5.56.
3BUF001094-610 A 343
5 Using Desktop Trends
5.5 Trend Display
For systems with MOD 300 or Master software, tags are organized by object type. To
uniquely identify a tag, specify the object type, tag name, and attribute.
MOD 300 Example:
Object Type = CCF_CONTIN_LOOP
Tag = AFWAVE1
Attribute = MEASURE
Master Example:
Object Type = PIDCON
Tag = AFWAVE2
Attribute = VALUE
Limit Check
The ticker can perform a limit check to determine whether the tag value is within the
normal range, or is out of range.
To enable this check the Tag(s) Out of Range option must be selected on the Indicator
tab of the Ticker Default Configuration dialog. Refer to Changing Ticker Defaults on
page 352.
Specify one of the following options:
• Get From System - Use high/low limits from the data source. This requires
configuring the Limits text file (refer to Setting Up the Limits File on page 286). For
OPC tags, specify the user-defined high/low limit object type in the Object Type
field. To see how this object type is defined, refer to Setting Up the Limits File on
page 286.
The limits are retrieved after all tags have been added to the ticker, and an attempt
has been made to get values for these tags. The limits are not refreshed unless new
tags are added, or the Refresh Limits menu item is invoked.
• Use these Limits - Use limits from Low Lim. & High Lim. fields in this dialog.
• Do Not Use Limits - Do not perform a limit check.
Subscription Type
When the data source is a system with MOD 300 or Master software, specify whether
to retrieve the Realtime Value directly from the process tag, or the Last History Value
from the corresponding History log.
To subscribe to the last history value, the corresponding data provider must reside
on the same node where the history log is located.
3BUF001094-610 A 344
5 Using Desktop Trends
5.5 Trend Display
When the data source is an OPC server, the subscription type must be OPC Value.
Data Provider
The correct data provider must be specified in order to access the applicable platform,
and retrieve the type of data (real-time process data or last history value).
When the aspect object browser is used, the corresponding data provider is automatically
filled in. For all other tags, specify the applicable data provider. Data providers are
uniquely identified by the -name argument. These data providers are configured through
the ADSS Config tool on the Windows Control Panel.
• For real-time data from a MOD 300 or Master data source, specify a DCS data
provider. The default -name is DCS.
• For last history value from a MOD 300 or Master data source, specify a LOG data
provider. The default -name is LOG.
To look up the -name for a data provider, use the Server Status tool ABB Start Menu
> ABB System 800xA > Information Mgmt> Display Services> IM Display Server
Status. When asked to indicate the server with which to connect, be sure to specify the
server where the tag resides.
3BUF001094-610 A 345
5 Using Desktop Trends
5.5 Trend Display
When multiple copies are made, a dialog is provided for specifying the quantity. Do not
add more than 50 tags to a Ticker file. After specifying the number of copies, the tag
naming procedure described above is repeated as many times as required to add the
specified number of tags. When finished adding tags, click OK. This displays the file on
the ticker.
Be sure to save the ticker file. To do this, right click on the ticker status indicator and
choose Save from the context menu.
3BUF001094-610 A 346
5 Using Desktop Trends
5.5 Trend Display
3BUF001094-610 A 347
5 Using Desktop Trends
5.5 Trend Display
3BUF001094-610 A 348
5 Using Desktop Trends
5.5 Trend Display
Data Format
0 Digit placeholder. Display a digit or a zero. If the expression has a digit
in the position where the 0 appears in the format string, display it;
otherwise, display a zero in that position.
If the number has fewer digits than there are zeros (on either side of the
decimal) in the format expression, display leading or trailing zeros. If the
number has more digits to the right of the decimal separator than there
are zeros to the right of the decimal separator in the format expression,
round the number to as many decimal places as there are zeros. If the
number has more digits to the left of the decimal separator than there
are zeros to the left of the decimal separator in the format expression,
display the extra digits without modification.
# Digit placeholder. Display a digit or nothing. If the expression has a digit
in the position where the # appears in the format string, display it;
otherwise, display nothing in that position.
This symbol works like the 0 digit placeholder, except that leading and
trailing zeros aren't displayed if the number has the same or fewer digits
than there are # characters on either side of the decimal separator in the
format expression.
. Decimal placeholder. In some locales, a comma is used as the decimal
separator. The decimal placeholder determines how many digits are
displayed to the left and right of the decimal separator. If the format
expression contains only number signs to the left of this symbol, numbers
smaller than 1 begin with a decimal separator. To display a leading zero
displayed with fractional numbers, use 0 as the first digit placeholder to
the left of the decimal separator. The actual character used as a decimal
placeholder in the formatted output depends on the Number Format
recognized by the system.
% Percentage placeholder. The expression is multiplied by 100. The percent
character (%) is inserted in the position where it appears in the format
string.
3BUF001094-610 A 349
5 Using Desktop Trends
5.5 Trend Display
3BUF001094-610 A 350
5 Using Desktop Trends
5.5 Trend Display
Changing Colors
1. Click in the field to select it. The text label for the field changes to white.
2. Double-click the selected field to display a standard Windows color palette, Figure
5.61.
3BUF001094-610 A 351
5 Using Desktop Trends
5.5 Trend Display
3BUF001094-610 A 352
5 Using Desktop Trends
5.5 Trend Display
For the most part, the ticker is operated using the defaults. To adjust one or more global
operating parameters, right click on the ticker status indicator and choose Configure
Ticker Defaults from the context menu. This displays the Default Ticker Configuration
dialog, Figure 5.63.
3BUF001094-610 A 353
5 Using Desktop Trends
5.5 Trend Display
3BUF001094-610 A 354
5 Using Desktop Trends
5.5 Trend Display
Errors to Show
This is used to specify whether to annunciate or ignore error conditions. Disable the
annunciation of any error condition by deselecting the check box.
Error conditions related to tags are annunciated by showing the tag text and status
indicator in a specified color. Also, under the Behavior category, the status indicator can
be specified to blink or not.
The Save Needed condition refers to the need for saving a new ticker file, or saving
changes to an existing file. This condition is annunciated by showing the status indicator
in the specified color. In addition, a warning message is displayed if an attempt is made
to clear the ticker without first saving the ticker file.
Colors
This is used to select a unique color for each error condition. For details on how to select
a new color refer to Changing Colors on page 351.
3BUF001094-610 A 355
5 Using Desktop Trends
5.5 Trend Display
Priorities
This is used to associate a priority with each of the possible error conditions. This may
be used when specifying the Behavior for the case where multiple error conditions exist
at the same time.
Behavior
This is used to enable/disable blinking, and specifies the behavior of the status indicator
light when multiple error conditions exist.
The options for When Multiple Errors Occur are:
• Do Not Show Errors - The status indicator light will remain in the specified No Error
color.
• Show First Error Encountered - The status indicator light will remain in the specified
color for the first condition that was detected.
• Show All Errors of the Highest Priority - The status indicator light will alternate
between the colors for each of the existing error conditions at the highest priority.
• Show All Errors - The status indicator light will alternate between the colors for
each of the existing error conditions.
3BUF001094-610 A 356
5 Using Desktop Trends
5.5 Trend Display
To change any of the default specifications, click the corresponding browse button. This
displays a standard Windows File Chooser dialog. Use this dialog to navigate to and
select the text file (for pick lists) or folder (for ticker files).
Clicking the Ed. Button launches a text editor that is used to change the corresponding
text file, Figure 5.66.
3BUF001094-610 A 357
5 Using Desktop Trends
5.5 Trend Display
To subscribe to the last history value, the corresponding data provider must reside
on the same node where the history log is located.
3BUF001094-610 A 358
5 Using Desktop Trends
5.5 Trend Display
3BUF001094-610 A 359
5 Using Desktop Trends
5.5 Trend Display
This displays a standard Windows file chooser dialog. By default, the dialog points to
the Data folder where ticker files are stored. Use this dialog to choose a file from this
folder, or navigate to another folder where ticker files are stored.
3BUF001094-610 A 360
5 Using Desktop Trends
5.5 Trend Display
Showing Errors
Error conditions are annunciated by showing tag text and the status indicator light in a
specified color. The status indicator may also blink, if it is configured to do so. The method
and format for indicating error conditions on the ticker is configurable through the Indicator
tab in the Default Ticker Configuration dialog. For instance, configure whether or not to
annunciate tags out of range, or unconnected tags. In addition, how to handle multiple
error conditions can be specified, and whether or not to have the status indicator blink.
Regardless of how these parameters are configured, a message box (refer to example
in Figure 5.69) can always be displayed that describes the current error conditions for
the ticker.
1. Choose Show Current Errors from the context menu of the ticker status indicator.
2. Click OK to acknowledge the message.
3BUF001094-610 A 361
5 Using Desktop Trends
5.5 Trend Display
The Save dialog points to the default folder for storing ticker files:
C:\Program Files\ABB IndustrialIT\InformIT\Desktop Trends\Data
It is recommended that the files be stored in this folder because this makes it easier to
find the files to display on the ticker. This is where the File-Open dialog points by default.
If necessary, another location can be specified.
3BUF001094-610 A 362
5 Using Desktop Trends
5.5 Trend Display
Drag the tags directly onto the desktop control, or into a tag specification in the Tag
Configuration dialog (refer to Configuring Tags on page 333).
Two separate controls must be opened in two separate Internet Explorer windows. In
the source control, point to the tag to be copied with the left mouse button and then drag
and drop the tag on the destination control, Figure 5.72.
This note is only applicable when dropping tags on a ticker. If the ticker is empty, the
tag will simply be placed on the ticker. If the ticker is already displaying a ticker file,
then verify whether to join the new tag with the current file, or clear the current file
before putting the new tag on the ticker. In either case, to preserve the new file,
execute a save.
3BUF001094-610 A 363
5 Using Desktop Trends
5.5 Trend Display
3BUF001094-610 A 364
5 Using Desktop Trends
5.5 Trend Display
The following are examples of complete tag specifications for a text editor:
• MOD 300:
FC100:Measure:100:0:500:1:DCS:CCF_CONTIN_LOOP:Realtime Value
• For Master: FC100:Value:100:0:500:1:DCS:PIDCON:Realtime Value
An example for dragging and dropping a tag specification from Microsoft Word is shown
in Figure 5.73.
3BUF001094-610 A 365
5 Using Desktop Trends
5.5 Trend Display
3BUF001094-610 A 366
5 Using Desktop Trends
5.5 Trend Display
This displays list of tags defined in the current tag file, Figure 5.76. Use this dialog to
select up to eight tags for display on the trend display. By checking the Include Limits
Where Applicable check box, the high and low limits, as well as the high and low scale
values are set for all tags not marked as No Limit Checking. Check the Get Attributes
From Database check box, to get the attributes for the tag.
3BUF001094-610 A 367
5 Using Desktop Trends
5.6 Tag Explorer
<OBJECTID=”ABBTicker”Name=”ABBTicker”
CLASSID=”clsid:4CD2A7FE-E56F-11D4-89B8-005004830B74”
BORDER=”0” WIDTH=”557” HEIGHT=”45”>
<!--To override empty defaults for Ticker refresh, input path to
ticker template file (*.tik) for ‘value’ field -->
<Param name=”TickerFile” value=”%ABB_ROOT%\Inform IT\Desktop
Trends\Data\Ticker Files\Ticker1.tik”></PARAM>
</OBJECT></P>
Before configuring the Tag Explorer, make sure the text files for the pick lists and
limits file have been configured as described in Setting Up Pick Lists on page 283.
To set up and use the Tag Explorer, follow the instructions in:
• Launching the Tag Explorer on page 368.
• Configuring the Tag Explorer on page 369.
• Using the Tag Explorer on page 375.
3BUF001094-610 A 368
5 Using Desktop Trends
5.6 Tag Explorer
Figure 5.78: Adding Tag Groups Under the Tag Groups Object
Tag groups can also be added as children under an existing parent tag group. The
existence of children tag groups under a parent tag group is indicated by the +/- symbol.
3BUF001094-610 A 369
5 Using Desktop Trends
5.6 Tag Explorer
This adds a new group under the selected parent object. The default name is
highlighted to edit the name.
3. Rename the new group, Figure 5.80.
It is recommended that the size of a tag group be limited to no more than 50 tags.
3BUF001094-610 A 370
5 Using Desktop Trends
5.6 Tag Explorer
It is recommended that the size of a tag group be limited to no more than 50 tags.
Importing Files
Existing Ticker and/or Tag Explorer files may be imported into a tag group. This
automatically adds all tags in the file to the tag group. Ticker and explorer files are built
through the Tag Configuration dialog (refer to Configuring Tags on page 333).
To import ticker and explorer files,
1. Select a tag group,
2. Right click and choose from the context menu either:
• Import/Export > Import Ticker File or
• Import/Export > Import Explorer File.
This displays a dialog for selecting the Ticker file (*.tik) to import. By default, the dialog
points to the Data folder where the ticker (or explorer) files are stored. Choose a file from
this folder, or navigate to another folder where the ticker (or explorer) files are stored.
3BUF001094-610 A 371
5 Using Desktop Trends
5.6 Tag Explorer
3BUF001094-610 A 372
5 Using Desktop Trends
5.6 Tag Explorer
Details - Default
Columns
This tab is used to select which columns to show or hide in the list view, Figure 5.84.
The name of any column can also be changed.
3BUF001094-610 A 373
5 Using Desktop Trends
5.6 Tag Explorer
Edit File
Clicking the Ed. Button launches a text editor that is used to change the corresponding
text file. This is a text editor only. The HTML format requires special editing.
3BUF001094-610 A 374
5 Using Desktop Trends
5.6 Tag Explorer
3BUF001094-610 A 375
5 Using Desktop Trends
5.6 Tag Explorer
3BUF001094-610 A 376
5 Using Desktop Trends
5.6 Tag Explorer
3BUF001094-610 A 377
5 Using Desktop Trends
5.7 PDL Browser
3BUF001094-610 A 378
5 Using Desktop Trends
5.7 PDL Browser
Search
Criteria
Search
Results
PDL
Data
To set up and use the PDL Browser, follow the instructions in:
• Opening the PDL Browser on page 379.
• Setting Up the PDL Browser Interface on page 379.
• Using the PDL Browser on page 386.
3BUF001094-610 A 379
5 Using Desktop Trends
5.7 PDL Browser
Refer to the following to specify date and time options as well as other miscellaneous
options.
• Type of PDL on page 381.
• Configuring 800xA Batch Management on page 381.
• Convert Task Value to Uppercase on page 383.
• Use Restored Archive on page 383.
• Maximum Values to be Returned on page 384.
• Warn If Exceeded on page 384.
• Default Time Span on page 384.
• Date and Time Format on page 384.
• Data Provider on page 386.
• Query Timeout on page 386.
• Language on page 386.
3BUF001094-610 A 380
5 Using Desktop Trends
5.7 PDL Browser
Type of PDL
Use this pick list to specify the PDL application: Batch 300, Taylor Control Language
(TCL), Produce IT Batch (default), Flexible, or Profile Historian. This determines types
of tasks available in the Task Type list in the PDL Browser. Task types for the various
PDL applications are indicated in Table 5.6.
Table 5.6: Resulting Task Type Options Based on Type of PDL Selected
Type of PDL Task Type Options
Batch 300 Job, Batch, Unit, Phase
TCL TCL Batch
Produce IT Batch (Default) Campaign - Level 0
(for Produce IT Batch version 1.1 and Batch - Level 1
1.2/0) Procedures Level 1 - Level 2,3
Procedures Level 2 - Level 3,12
Phase - Level 12
Profile Profile Events (Reel, Grade, Dayshift) - Level 1
Roll Set Information - Level 2
Generic Returns Level 1, Level 2, Level 3, and Level 4.
Flexible Up to 15 user-configurable task types. Refer to Configuring
(use this option for Produce IT Batch 800xA Batch Management on page 381 for details.
version 1.2/1 and later)
The Produce IT Batch option is only applicable for Produce IT Batch versions 1.1 and
1.2/0. If version 1.2/1 or later is being used, select the Flexible PDL Type.
3BUF001094-610 A 381
5 Using Desktop Trends
5.7 PDL Browser
This button displays the Customize PDL Hierarchy dialog, Figure 5.90. Each level has
a default name. These names can be changed. To choose which levels to include in the
Task Type list in the PDL Browser check the corresponding check box. Any level whose
check box is checked is included in the list.
3BUF001094-610 A 382
5 Using Desktop Trends
5.7 PDL Browser
3BUF001094-610 A 383
5 Using Desktop Trends
5.7 PDL Browser
Warn If Exceeded
This check box is used to choose whether or not to display a message when the specified
query result has more than the specified maximum values. This message is used to
choose whether to disregard the limit and return all values, or impose the limit and discard
the values in excess of the specified limit. For more information, refer to Limiting the
Amount of Data Returned By Your Query on page 388.
If this option is unchecked, the specified maximum number of values to be returned will
always be imposed and no notification is made when the query result has additional
values that are being discarded.
3BUF001094-610 A 384
5 Using Desktop Trends
5.7 PDL Browser
Selecting a different date or time will not affect PDL browser operation. Use this
feature to check how the selected format will look for different dates.
3BUF001094-610 A 385
5 Using Desktop Trends
5.7 PDL Browser
Data Provider
The PDL Browser accesses PDL data through an ADO data provider on the Historian
server. This data provider is configured through the ADSS tool on the Windows Control
Panel. In most cases, the default ADO data provider (named DBA) should be used. If
the application uses more than one ADO data provider for PDL access, or if the ADO
data provider has a different name (not recommended), this field is used to specify the
name of the data provider. For details regarding the ADO data provider refer to the post
installation procedures in System 800xA Post Installation (3BUA000156*).
Query Timeout
This is the maximum time to wait for the selected object to respond to the query before
timing out. The timeout interval may need to be increased for complex queries.
Language
This option specifies the language used for displaying message-type PDL data. Currently
only English language is supported.
ProduceIT Messages
This specifies the method for retrieval of Produce IT Batch messages based on the
version:
• PDL Messages retrieves messages for Produce IT Batch v1.1 and 1.2 - For these
versions, PDL messages and events are stored in the PDL (level 15 task).
• Messages Log retrieves messages for Produce IT Batch v1.2/1 - For this version
PDL messages and events are stored in an OPC message log.
Trend File
This is used to specify which html file to open when the Trend Display is launched from
the History tab (Refer to History on page 393). The corresponding button launches a file
browser dialog for specifying a different html file.
3BUF001094-610 A 386
5 Using Desktop Trends
5.7 PDL Browser
Task Type
This specifies the level of the PDL hierarchy to be searched. The choices in the Task
Type list are based on the Type of PDL selected in the Configure PDL Browser dialog.
Refer to Type of PDL on page 381.
When the Task Type specification is changed, any previous results in the PDL Browser
are cleared.
For this release of the software, Batch 300 and TCL-specific criteria are automatically
applied to the search to prevent the retrieval of Batch records which do not belong
to the selected PDL type. If Batch 300 is the current PDL type, then TCL Batch records
will not be retrieved when a search for Batch records is executed. If TCL is the current
PDL type, then Batch 300 batch records will not be retrieved during a Batch search.
Task Value
This specifies the name of the task to query. If a name is not specified, all tasks are
returned. Enter the complete name, or just a partial name. The wildcard character% can
be used to search for a particular pattern or format. Leading and trailing blanks are
removed before the search is executed.
The Convert Task Value to Uppercase option in the Configure PDL Browser dialog
determines whether or not to convert the task name to uppercase characters. This is a
convenience option for those systems in which all names are stored as uppercase.
3BUF001094-610 A 387
5 Using Desktop Trends
5.7 PDL Browser
Time Span
The Time Span fields is used to specify a time range for the query for which data will be
retrieved. These fields can be enabled or disabled through their respective check boxes
as follows.
• To restrict the query to a time range, check both boxes, and enter both the Start
and End date/times.
• To make a query for all tasks starting before a specific date/time, check just the End
check box, and enter the End date/time.
• To make a query for all tasks starting after a specific date/time, check just the Start
check box, and enter the Start date/time.
By default, the End date/time are set to the current date and time when the PDL
Browser is opened. The Start date/time are set based on the Default Time Span
option on the Configure PDL Browser dialog (Start date/time = End date/time minus
Default Time Span).
Any part of the date and time can be modified by clicking directly on the unit to be changed
and entering the new value. For time, use the up/down arrows to change the selected
unit. For date, click the down arrow to display the Microsoft Date and Time Picker dialog.
Entering an end time that precedes or equals the start time causes an error message
to be displayed when the query is executed. Click OK to clear the message, then
enter a valid start (or end) time.
Do not use either of the following options for short date style in the Regional Settings
dialog (Windows Control Panel function): yy-dd-mm or yyyy-dd-mm. This causes the
month and date values to be reversed in the DT Picker.
3BUF001094-610 A 388
5 Using Desktop Trends
5.7 PDL Browser
3BUF001094-610 A 389
5 Using Desktop Trends
5.7 PDL Browser
The first row in the Search Results listing is automatically selected (highlighted), and the
associated data for the selected item are available for viewing in the Associated Data
Listing section of the dialog. When a different row is selected, the contents of the
Associated Data Listing changes accordingly.
Some column values may be truncated in the display due to the fixed widths of the
columns. Horizontal and vertical scroll bars are provided when the number of rows or
columns exceeds the limits of the Search Results window.
The main search result count is displayed above the result listing. The associated data
search count is displayed below the listing. If a query does not return any results, a row
with the text No Data is displayed underneath the header row. Additionally, the search
count displays No rows returned.
Drilling
The Drill buttons are used to move up and down the PDL hierarchy for a selected task
in order to view the data at all levels of the task hierarchy. Drilling down displays data
for the selected task at the next level down in the hierarchy. Drilling up displays data for
the selected task at the next level up in the hierarchy. For example, clicking the drill down
button for job-level task - Thur314Bat_job in Figure 5.95, displays the batch-level search
results for Thur314Bat, Figure 5.96.
3BUF001094-610 A 390
5 Using Desktop Trends
5.7 PDL Browser
The Task Type value indicates the current level. The Task Value is reset to a blank value,
and the time values retain their previous values.
The task that was selected before the drill function was performed will be highlighted
even when drilling in the opposite direction later. For example, if an initial search is
performed for a batch, the drill down function will display data at the unit level for the
selected batch. If drill down is executed again, data at the phase level for the selected
unit will be displayed. For Drill Up, data at the unit level will be displayed for the unit that
was originally selected.
The drill buttons are automatically enabled and disabled as follows:
• If the Search Results listing indicates ‘No Data’, the Drill Down and Drill Up buttons
are disabled.
• If the current Task Type value is at the bottom of the hierarchy for a PDL type, the
Drill Down button is disabled.
• If the current Task Type value is at the top of the hierarchy for a PDL type, the Drill
Up button is disabled.
• After each new search is completed, the Drill Up button is disabled. To drill Down,
perform a new search.
Variables
This tab displays: variable name, value, time, occurrence number, result value and result
time. The rows are sorted by Time, then by Variable Name, then by Occurrence, Figure
5.97.
3BUF001094-610 A 391
5 Using Desktop Trends
5.7 PDL Browser
Resources
This tab displays: Resource Type, Name, Value, Time and Occurrence. The rows are
sorted by Type, then by Name, then by Occurrence, Figure 5.98.
Messages
This tab displays the following message data for the selected task: Message Type,
Message and Local Time. The rows are sorted by Local Time, Figure 5.99.
When the PDL type is specified as Produce IT Batch, the time is displayed in UTC
time rather than local time.
3BUF001094-610 A 392
5 Using Desktop Trends
5.7 PDL Browser
History
The History tab displays Log Name, Start Time, End Time, Phase and Occurrence. The
rows are sorted by Log Name then by Start Time, Figure 5.100. Clicking the Trend button
to launch the Trend Display view of the selected log. Results can also be dragged from
this tab to the Trend display.
The History association tables track the start and end times for which history values were
collected for a particular object. The PDL tables do NOT store the actual history values,
just the initial and final times of the collection period.
History Log associations can be retrieved at two levels — owner and individual task
level. Each history association record has a taskid for the level at which the history log
was started. Because the history log may span multiple tasks within a level of the
hierarchy, each history association record also has an “owner” task.
3BUF001094-610 A 393
5 Using Desktop Trends
5.8 Batch Batch Display
For example, consider a Batch application where history collection began during Batch
123. Batch 123 had four Phases through which the history collection spanned. Batch
123 is the owner for each of the four phases. When a search is executed for Batch 123,
a record is displayed in the History listing. Additionally, when a search is done for each
of the four phases, a record is also displayed for each of the phases, even though the
history collection spanned across all four. The Phase value will be displayed if the owner
task is the currently displayed item.
Next-Level Listing
Usually, the last tab in the Associated Data listings contains data from the history.task
table for the next level down in the hierarchy. The actual name of the tab is based on
the level in the hierarchy for the data. For example, if the current Task Type is a Unit in
a Batch 300 system, then the tab name will be Phase List. The header for the first column
of data changes to reflect the ‘child’ level name.
If the current Task Type is the last level in the hierarchy, this tab will not be displayed.
The following data are displayed: Task Name, Start Time and End Time. The rows are
sorted by Start Time, Figure 5.101.
3BUF001094-610 A 394
5 Using Desktop Trends
5.8 Batch Batch Display
3BUF001094-610 A 395
5 Using Desktop Trends
5.9 Event Browser
3BUF001094-610 A 396
5 Using Desktop Trends
5.9 Event Browser
To set up and use the Event Browser, follow the instructions in:
• Opening the Event Browser on page 397.
• Setting Up the Event Browser Interface on page 398.
• Retrieving Events on page 399.
• Viewing Trend Data Related to Events on page 399.
3BUF001094-610 A 397
5 Using Desktop Trends
5.9 Event Browser
Clicking Use Defaults resets all parameters to their respective default settings.
3BUF001094-610 A 398
5 Using Desktop Trends
5.9 Event Browser
Log Name
This pull-down list contains all message logs configured on the currently connected
server (Refer to Connecting to the Data Server on page 282).
Time Span
These fields are used to specify the time range for retrieval of message log entries.
Default Start and End times are automatically set according to the default time span
specified in the Event Browser Configuration dialog.
The time controls are Microsoft's DateTime Picker controls. Selecting the date drop-down
list displays a calendar for selecting days, months, and years. To modify a time value,
place the cursor in the portion to be changed and enter the new value, or click on the
up/down arrows to change the selected value. The Start Time must be set to a value
earlier in time to the End Time.
The check boxes in front of the time controls are used to select whether or not to use
the corresponding time as query criteria.
3BUF001094-610 A 399
5 Using Desktop Trends
5.10 SQL Browser
To set up and use the SQL Browser, follow the instructions in:
• Opening the SQL Browser on page 401.
• Setting Up the SQL Browser Interface on page 401.
• Using the SQL Browser on page 402.
3BUF001094-610 A 400
5 Using Desktop Trends
5.10 SQL Browser
3BUF001094-610 A 401
5 Using Desktop Trends
5.10 SQL Browser
Grid No Grid
Column Colors
Add column colors to make them more distinguishable when configuring columns for
dragging tags and time stamps to the Trend Display, for the tag, start time, and end time.
Use the color boxes in the Display section of the SQL Browser Configuration dialog.
White text indicates which box is currently selected. For example, in Figure 5.107, the
box for Tag Column Color is currently selected. Double-clicking a color box displays the
standard Windows color chooser dialog.
3BUF001094-610 A 402
5 Using Desktop Trends
5.10 SQL Browser
For complex queries, the Timeout interval may need to be increased. Click the Options
button to display the SQL Browser Configuration dialog. For details refer to Query
Timeout on page 386.
SQL access to numeric log data and OPC objects is supported when the ODA Server
software is installed.
3BUF001094-610 A 403
5 Using Desktop Trends
5.10 SQL Browser
Saving a Query
To save a query:
1. Specify and execute the query as described in Specifying and Executing Ad-hoc
SQL Queries on page 402.
2. Right-click inside the query result pane and choose Query>Save from the context
menu.
3. Enter a name to identify the query then click OK.
3BUF001094-610 A 404
5 Using Desktop Trends
5.10 SQL Browser
5.10.6 Dragging Tag Names and Time Stamps to the Desktop Trend Display
For a historical data query, drag the tag names and time stamps returned by the query
to a Desktop Trend display to set up a trend for viewing. One useful application for this
is to query for log names from the numericlog table, and then select up to eight logs to
display on the trend display.
3BUF001094-610 A 405
5 Using Desktop Trends
5.10 SQL Browser
To do this, specify which columns from the query result will be used for tag name, trend
start time, and trend end time.
If a start or end time is not specified, the trend display’s default scope will be used.
3BUF001094-610 A 406
5 Using Desktop Trends
5.11 OPC Browser
When right-clicking on a column in the query result, the context menu shows the column
name, for example, in Figure 5.115 the LocalTimeStamp column is selected. The context
menu can then be used to specify that column as the tag name, start timestamp, or end
timestamp for dragging.
When accessing IM SQL Tag Browser during subsequent opening, it retains username
but it fails to retain password. We need to give the password.
3BUF001094-610 A 407
3BUF001094-610 A 408
6 Creating Reports
6.1 Report Building Applications
6 Creating Reports
Reports can be created either with DataDirect, or with various third party report building
applications such as Crystal Reports. These reports can then be scheduled and run
using the Application Scheduler and Report action plug-in.
The Report action is used to direct the report to various output destinations including
printers, e-mail, files such as PDF, html, Excel, and report logs configured with the
Information Management History Server function. completed report files may also be
attached to Completed Report objects in the 800xA System aspect directory. This can
be used to browse for completed report files through the Plant Explorer, and to apply
version control and electronic signatures to report files.
When a report is output to a Completed Report object or report log, the report can then
be archived to a removable media for permanent storage.
Web access can also be configured for reports so a browser can be used to open and
view the reports.
This section describes any set-up that may be required for reports to access data in the
800xA System, and provides instructions for scheduling, running, and managing reports.
Configuring report logs and archiving reports (either through report logs or Completed
Report objects) is an Information Management configuration activity.
3BUF001094-610 A 409
6 Creating Reports
6.2 Implementing Reports
• Microsoft Excel (without DataDirect Add-in) - can access historical and real-time
data from the 800xA System through Open Data Access (requires MS Query).
• Generic Executable - This refers to any report file that is not Microsoft Excel or
Crystal Reports, for example, VBScript.
3BUF001094-610 A 410
6 Creating Reports
6.2 Implementing Reports
Schedule
Triggers
Report Action
Completed
Report
Executes
Output Options:
Aspect System
(File Viewer Aspect) Report Application Completed Report Object
Report Report Log
OR Template DataDirect
Microsoft Excel Printer
Crystal Reports E-mail
Windows File System Windows File
Generic
Data Sources:
Real-time
Batch
History
History Events
Access to process and historical data from earlier Information Manager and Enterprise
Historian systems requires the applicable data providers to be started and selected in
DataDirect. This is described in Setup on page 246.
3BUF001094-610 A 411
6 Creating Reports
6.2 Implementing Reports
3BUF001094-610 A 412
6 Creating Reports
6.2 Implementing Reports
The arguments list as described in the Job Log is not necessarily sent to the report.
It is the list as defined by the Schedule Definition Aspect\Job Arguments tab, or
explicitly passed in to the job by Batch Management. If an Argument is not included
in the Action Aspect Report Parameters definition then it is not sent to the report but
it is listed in the Job Log.
3BUF001094-610 A 413
6 Creating Reports
6.2 Implementing Reports
3BUF001094-610 A 414
6 Creating Reports
6.2 Implementing Reports
3BUF001094-610 A 415
6 Creating Reports
6.2 Implementing Reports
Also, there are six batch reports created with Crystal Reports:
Batch-MM-Report-detailed.rpt
BatchReport-detailed -001.rpt
BatchReport-detailed.rpt
Report1Campaigns.rpt
Report1CampaignsAndBatches.rpt
Report1CampaignsAndBatches-SelectACampaign.rpt
Some example *.rtf output files are available in the output subdirectory
Additional Crystal Report subreports are provided in: C:\Program Files\ABB Industrial
IT\Inform IT\History\ApiDevKit. The reports and the parameters expected to be passed
to the Scheduler are:
AuditMsgs.rpt (StartTime, EndTime)
GenericDa.rpt (ObjectName, PropertyName)
mm_auditEvent.rpt (StartTime, EndTime)
MMFormEvent.rpt (Batchid)
MsgsTypeandTime.rpt (StartTime, EndTime, MessageType) (MessageType =
Category)
3BUF001094-610 A 416
6 Creating Reports
6.2 Implementing Reports
3. Configure the Action aspect to specify how the report will be executed. This is
described in Defining the Report Action on page 419 and includes:
a. Selecting the Report Action aspect.
b. Selecting the report template.
c. Specifying one or more output destinations for the report result.
d. Specifying parameters to pass into the report when it executes.
Login parameters must be specified under the following circumstances:
• If the Crystal Report will include queries for Oracle-based data (message logs
and/or PDL data), then define the DataServerLogin parameter in the report
schedule to connect the report to the ODBC driver for Oracle data.
• For DataDirect, define the DataServerLogin parameter in the Report action to
connect the report to the applicable data server:
4. Configure the Job Description object to specify the scheduling instructions for the
report. This is described in Defining the Schedule on page 450.
5. Before running a report, read the guidelines in Before Running a Report on page
452.
If reports are to be scheduled and executed using the Application Scheduler, the
report file MUST be saved in Manual calculation mode; otherwise, they will run twice
when run through the Scheduler.
The Excel calculation mode is set to the mode of the first file opened (or calculated,
if no previously saved file has been opened). All workbooks that are opened in that
Excel session will be set to that same calculation mode, despite any previous settings.
The calculation mode is always Automatic when Excel is first opened. To check the
mode and change it if necessary, refer to Putting the Workbook in Manual Mode on
page 70.
Troubleshooting
For trouble with a report, refer to Troubleshooting Reports on page 461.
3BUF001094-610 A 417
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
The Report Action of the Action Aspect can also be used to schedule a History backup.
This is done using History Database Maintenance.
1. Start with Creating Objects and Aspects in the Scheduling Structure on page 418.
2. Continue with Defining the Report Action on page 419.
3. Set up the Schedule as described in Defining the Schedule on page 450.
3BUF001094-610 A 418
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
3. Add the Job object as a Job Description object. Assign the object a logical name
(for example BatchReportSchedule).
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. Right-click on the Job Description object (for example BatchReportSchedule) and
choose New Aspect from the context menu.
6. In the New Aspect dialog, select the Action aspect. Use the default aspect name,
or specify a new name (for example BatchReportAction).
7. Click Create to add the Action aspect to the job.
Continue with Defining the Report Action on page 419.
3BUF001094-610 A 419
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
To configure the report action, use the Action aspect to perform the following:
• It is recommended that a time limit be entered, especially for large reports.
• Selecting the Report Action on page 420.
• Selecting the Report Template on page 421.
• Output Options on page 421.
3BUF001094-610 A 420
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
2. Use the browser dialog to find and select the report to be executed. If a File Viewer
aspect is selected, the file attached to the Work Document section is used.
Figure 6.5: Example, Using File Viewer Aspect for Browsing Report Files
3BUF001094-610 A 421
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
Refer to Export Considerations on page 440 for additional information on using each
output method.
3BUF001094-610 A 422
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
3BUF001094-610 A 423
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
To specify a parameter:
1. Click the Report Parameters check box to activate the report parameters function,
Figure 6.6.
2. Click Edit Parameter List. This displays the Report Parameters list, Figure 6.7.
3. To add a parameter to the list, click Add. This displays the Configure a Report
Parameter dialog, Figure 6.8.
3BUF001094-610 A 424
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
4. Enter the parameter name and value as shown in Figure 6.8, then click OK. This
adds the parameter to the parameter list, Figure 6.9.
3BUF001094-610 A 425
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
6. To modify an existing parameter, select the parameter from the list, then click Modify.
This displays the Configure a Report Parameter dialog as shown in Figure 6.8.
Change the name or value or both. To remove a parameter from the list, select the
parameter, then click Remove.
7. When finished adding parameters, click Close. This adds all listed parameters to
the parameter list in the Report Action dialog, Figure 6.10.
3BUF001094-610 A 426
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
CampaignID
BatchID
LotID
ProcedurePath
The following keywords (intrinsic parameters) may be used as arguments:
TimeStamp, LongDate, LongTime, ShortDate, ShortTime, and JobID. JobID is a unique
identifier based on the running job name and the action that is running. These parameters
are used to insert date and time, and job ID information into the report as a string without
having to use a function that is re-calculated when the report is opened.
To substitute an argument for a parameter value, enter the argument name in angle
brackets(< >), Figure 6.8. The argument value may be embedded in other text, Figure
6.11.
3BUF001094-610 A 427
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
Provide the following information in the Parameters dialog box of the Report Action
aspect.
DataServerLogin = ServerName,DatabaseName,UserID,Password
Where:
ServerName = DataSource name in the System DSN tab of the ODBC Data Source
Administrator dialog box that is configured to connect to the remote server. Refer to
Establishing a Connection to a Remote Oracle Server on page 428for more information.
DatabaseName = ADVA
UserID = history
Password = <enter the history account password>
The password is provided during the IM Post Installation or the Database Migration.
For example:
DataServerLogin = RemoteSrv, ADVA, history, history
3BUF001094-610 A 428
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
Perform the following procedure after the Oracle software is installed on the
non-Information Management node in order to configure a connection to the remote
Oracle Server.
1. Open the Oracle Net Configuration Assistant from the Windows tiles All Apps by
name screen.
3BUF001094-610 A 429
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
If more than one option is displayed; open its file location and launch the Oracle client
version as indicated in the screen below.
3. Select the Local Net Service Name configuration option in the Oracle Net
Configuration Assistant Welcome dialog box and click Next.
4. Select the Add option in the Oracle Net Configuration Assistant: Net Service Name
Configuration dialog box and click Next.
3BUF001094-610 A 430
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
5. Enter ADVA in the Service Name field in the Oracle Net Configuration Assistant:
Net Service Name Configuration, Service Name dialog box (Figure 6.14) and click
Next.
6. Select TCP in the Oracle Net Configuration Assistant: Net Service Name
Configuration, Select Protocols dialog box and click Next.
7. Enter the IP address of the remote Oracle Server for the host name field option in
the Oracle Net Configuration Assistant: Net Service Name Configuration, TCP/IP
Protocol dialog box (Figure 6.15).
3BUF001094-610 A 431
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
8. Select the Use the standard port number of 1521 option (Figure 6.15) and click
Next.
9. Select the Yes, Perform a test option in the Oracle Net Configuration Assistant:
Net Service Name Configuration, Text dialog box and click Next.
3BUF001094-610 A 432
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
10. The test will fail with an invalid username and password (Figure 6.16). Click Change
Login to launch the Change Login dialog box.
3BUF001094-610 A 433
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
17. ODBC Data Source Configuration: Enter the windows tile screen and type set up
odbc. Select the Set up ODBC data sources (32-bit). Figure 6.17
18. Click Add to launch the Create a New Data Source dialog box.
19. Select the Oracle in OraDb12c_ADVA driver (Figure 6.18) and click Finish.
3BUF001094-610 A 434
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
20. The Oracle ODBC Driver Configuration dialog box (Figure 6.19) appears.
21. Enter the date source name in the Data Source Name field (for example
OracleSrvConnection).
22. Select the TNS Service Name from TNS Service Name drop-down list.
The TNS Service Name drop-down list shows the Net Service name configured
earlier.
23. Click Test Connection to launch the Oracle ODBC Driver Connect dialog box. This
will verify the connection to the remote Oracle Server.
24. Enter history as the user name.
25. Enter the user defined password and click OK.
26. If the connection is successful, Connection successful appears in the Testing
Connection dialog box. Click OK in the dialog boxes until they are all closed.
3BUF001094-610 A 435
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
As an option, rename the cell in the spreadsheet to give it a more meaningful name. For
example, in Figure 6.21, cell C2 is renamed as batchid.
In the Batch reports using DataDirect for data retrieval, the following parameter should
be defined in the Scheduler Action aspect:
DataServerLogin = computer name, user name, password
This parameter is the login information for connecting the DataDirect report to the
applicable data server. The user name and the password are the ones that are defined
for Display Services (or DataDirect) during IM Post Installation.
Renaming Cell C2
with the batchid
Parameter name
3BUF001094-610 A 436
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
Make sure that the report name entered in the Object Path as well as File Name
should not have a period
3BUF001094-610 A 437
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
3. Click OK when done. The specification is then entered in the Export Paths list, Figure
6.24.
If an export file specification needs to be removed from the Export Path list, select
the specification, then click Remove.
To modify a specification, double-click on it. This opens the Configure Export to a
Completed Report Object dialog.
Figure 6.24: Object and File Names Combined in File Name Field
3BUF001094-610 A 438
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
3. To change the path, click the Path button to display a Windows browser, then browse
to the folder where the file is to be stored. Click OK in the browser once the selection
is made.
3BUF001094-610 A 439
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
4. To change the Max Files Per File Type, Per Directory value, type in the desired
value. This value must be configured on the Information Management node where
the reports are generated (the node where the Application Scheduler is running).
Changing the Max Files Per File Type parameter to a smaller number will result in
the scheduler removing any files in excess of the new configuration the next time a
file is stored. Please save any files you may wish to preserve before reducing the
maximum number of files stored.
5. Click OK when finished with the export specification. The specification is then entered
in the Export Paths list, Figure 6.25.
If an export file specification needs to be removed from the Export Path list, select
the specification, then click Remove. To modify a specification, double-click on it.
This opens the Configure Export to a File dialog.
Export Considerations
• Not all export formats are available in all versions of Crystal Reports. Refer to the
Crystal Reports documentation to see what is available. Regardless of the version
installed, be sure to install ALL dlls related to export file types.
• All exported report instances are saved. Each export file has a unique name so that
existing export files are not overwritten. This may result in a large accumulation of
export files. These files must be managed and periodically purged from the export
directory if necessary.
3BUF001094-610 A 440
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
• If the file is being exported on a remote computer, network file sharing must be used.
If such files must be secured, refer to the guidelines for Securing Windows Files on
Shared Network Drives on page 501.
• Do not export XLS reports as File Viewer aspects. Only do so if Report Archiving
of XLS is required. Export XLS to the file system instead.
• Determine up front the output methods required for a particular report template. The
Excel template for HTML may need different formatting or layout in the template
than one used for XLS output, or output to a printer (font size, hidden cells, multiple
pages or sheets, etc).
3BUF001094-610 A 441
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
3BUF001094-610 A 442
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
• During the PDF export of Excel sheets, the Excel divides each sheet into multiple
print areas and each VALID print area will be exported as a PDF page. If the output
data from the Excel sheets are unevenly getting split into different PDF pages, then
the Report template should be redesigned with appropriate Print area by modifying
the Page Size and Orientation, or the Page width as shown in Figure 6.26 to get
the required PDF output.
3BUF001094-610 A 443
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
6.3.8 Printer
The printer option provides a list of local printers available from the node where the report
will run, Figure 6.28.
Using the XPS Document printer for report printing is not supported as it results an
invisible Save As dialog and this will hang the report execution.
6.3.9 Email
The Email option is used to send a report through email. As an option to ending a finished
report, send the report template (the unprocessed report), or send a notice that the report
was executed.
3BUF001094-610 A 444
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
A SMTP e-mail server must be set up for outgoing e-mail. The SMTP e-mail server can
be on any node that has access to the node where the reports will run. Contact the
network administrator to install a SMTP e-mail server. Detailed instructions are not
provided here since the installation may vary depending on the specific e-mail server
software package being used.
If the node where the e-mail server will be set up is protected by a firewall, ensure
that the firewall does not close the SMTP e-mail port (port 25 is standard).
2. Click the Set button to launch the Email Information dialog box, Figure 6.30.
• The fields with asterisks (*) in the Email Information dialog box are mandatory.
• The fields with red borders in Figure 6.30 must be populated in the format
specified.
3. Enter the e-mail address of the sender account in the From: field. This field is
mandatory and must be in the format specified in the Email Information dialog box
(it must include the @ symbol).
4. Enter the e-mail addresses of the receiver accounts in the To: field. This field is
mandatory.
3BUF001094-610 A 445
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
5. Enter the e-mail addresses of the desired accounts in the cc: and bcc: fields. These
fields are optional.
6. Enter the SMTP server IP address or SMTP server node name in the SMTP Server:
field. This field is mandatory and must be in the format shown in the following
examples:
• IP address example: 12.14.352.190
• Node name example: yoursmtpserver.yourcompany.com
3BUF001094-610 A 446
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
7. Use the Attachment Format: drop-down list box to select the format for the report
output file. The choices for finished report files are described in Table 6.6.
To send an unprocessed report template, select as is. To send a notification message
with no attachment, select None.
When a report is eported as an HTML file, the number of files that are output can be
controlled. Refer to Output Options for HTML Files on page 423.
8. Enter the report output name in the Attachment Name: field. This is not required to
match the report name. An extension may be included; however, the extension will
not determine the file format. The format must be selected through the Attachment
Format list. This field is disabled if None is selected for the Attachment Format.
Report parameters can be dynamically substituted in the output file name. Refer to
Using Parameters to Modify an Output File Path on page 422.
3BUF001094-610 A 447
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
To use this option, click the Save To History check box. This activates both the report
log selector, and the Format selector, Figure 6.32.
To select the report log, click Set, then use the browser to select the report log, Figure
6.33.
Use the Format selector to specify the format for storing the report in the log. The choices
are the same as the export formats for each report type as described in Table 6.5, plus
Without Processing which saves just the report template without data that would be
gathered by processing the report.
As an option, save the report to history under a different file name. To do this, click in
front of the format extension in the Format field (for example in Figure 6.32, click to the
left of .html), then enter the new name. This name will completely replace the original
report output file name.
3BUF001094-610 A 448
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
As a further option report parameters can be dynamically substituted in the output file
name. Refer to Using Parameters to Modify an Output File Path on page 422.
Reports stored in the report log can be viewed through the View Report Logs aspect for
the Report Logs container in the Node Administration structure. Instructions for using
this aspect are provided in View Report Logs Aspect on page 459.
3BUF001094-610 A 449
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
3BUF001094-610 A 450
6 Creating Reports
6.3 Setting Up the Report Action and Scheduling Definition
The Scheduler supports several scheduling methods, for example: cyclic, periodic,
weekly, and monthly as described in Section 7 Scheduling. The schedule type is presented
as a plug-in dialog on the Schedule tab. The top section of this tab has a set of common
controls which are applicable for all schedule types, Figure 6.35.
It contains a field for selecting the following:
• A Schedule pull-down list to select the type of schedule.
• The Enabled check box must be checked in order for the scheduler to use the
selected schedule type for the job.
• The Service Group selection field is used to choose which server will execute a
given job in the case where there are multiple nodes running the Application
Scheduler. The default is the primary service group which is the first service group
created, not necessarily the first one listed in the Service structure. To avoid
unexpected results, specify a server where the report will run.
• A Run Now button to manually run the job.
3BUF001094-610 A 451
6 Creating Reports
6.4 Before Running a Report
In Windows 2016 server, IIS Management Console should be checked and installed.
Directory browsing needs to be enabled in IIS Manager.
3BUF001094-610 A 452
6 Creating Reports
6.5 Viewing Reports Over the Web
3. Navigate to:
Sites > Default Web Site
After the job has successfully run, open Internet Explorer and go to http://localhost/reports
(assuming reports is used as the alias name for the virtual directory). A link to the report
just run should be there. Click on the report link to view the report. An example is shown
in Figure 6.38.
3BUF001094-610 A 453
6 Creating Reports
6.6 Attaching a Report Template to a File Viewer Aspect
Link
3BUF001094-610 A 454
6 Creating Reports
6.6 Attaching a Report Template to a File Viewer Aspect
6. Open the Configuration view of the File Viewer aspect. To do this, either choose
Config View from the aspect’s context menu, or use the corresponding icon on the
tool bar, Figure 6.39.
3BUF001094-610 A 455
6 Creating Reports
6.6 Attaching a Report Template to a File Viewer Aspect
7. Attach the report file as a Work Document. To do this, in the Work Document section
of the Configuration view, click the Attach button, Figure 6.40.
Figure 6.40: Attaching the Report File to the Work Document Section
8. Use the File Browser dialog to select the report file (BatchReport1.rtp for example),
then click Open. The result is shown in Figure 6.41.
3BUF001094-610 A 456
6 Creating Reports
6.7 Report Preferences Aspect
3BUF001094-610 A 457
6 Creating Reports
6.8 Report Printing Aspect
3BUF001094-610 A 458
6 Creating Reports
6.9 View Report Logs Aspect
3BUF001094-610 A 459
6 Creating Reports
6.9 View Report Logs Aspect
• view reports stored in a selected report log. Refer to Viewing Reports Stored in a
Report Log on page 461.
Report Log
Reports stored in
the selected log
3BUF001094-610 A 460
6 Creating Reports
6.10 Troubleshooting Reports
3BUF001094-610 A 461
6 Creating Reports
6.11 Creating a Report with Crystal Reports - Example
During report configuration, filename in the object path should not have .(dot),
otherwise it throws an error "Invalid extension type".
3BUF001094-610 A 462
6 Creating Reports
6.11 Creating a Report with Crystal Reports - Example
Report Schedule
Batch BatchID
Management Report Action
Report Completed
BATCHID Template Report
TIMESTAMP
DATAVALUE
ODBC
Batch Trend View
6.11.1 Connecting the Report to the ODA Table for Historical Data
In order for the reports created with Crystal Reports to access data from the 800xA
System, the reports must be connected to the applicable database. For this tutorial, the
Crystal Report to an Oracle view called Batch_Trend which is specifically designed to
facilitate access to historical data for batches run using the 800xA Batch Management
application will be used. Refer to PDL Tables and Views on page 671.
There are several methods in Crystal reports to make this connection. This procedure
shows how to use the Database Expert.
1. Choose Database > Database Expert from the Crystal Reports menu bar.
2. Verify whether ABBODA datasource is listed under the My Connection tree. If it is
not, expand Create new Connection > ODBC(RDO) to launch the ODBC(RDO)
dialog.
3. Select ABBODA datasource and click Finish.
4. If no tables are visible under ABBODA > SCHEMA, right-click ABBODA and select
Options menu to launch the Options dialog.
5. Select Tables under Data Explorer (Figure 6.46) and click OK.
3BUF001094-610 A 463
6 Creating Reports
6.11 Creating a Report with Crystal Reports - Example
6. Click -/+ of the ABBODA connection to refresh and display the Tables.
3BUF001094-610 A 464
6 Creating Reports
6.11 Creating a Report with Crystal Reports - Example
7. Select and add the BATCHTRENDs table to Selected Tables as shown in Figure
6.47.
3BUF001094-610 A 465
6 Creating Reports
6.11 Creating a Report with Crystal Reports - Example
3BUF001094-610 A 466
6 Creating Reports
6.11 Creating a Report with Crystal Reports - Example
3. Repeat Step 1. and Step 2. for the second parameter (also String value type). The
report definition so far is shown in Figure 6.9.
3BUF001094-610 A 467
6 Creating Reports
6.11 Creating a Report with Crystal Reports - Example
Passing in batchid
The batchid must be passed in as a parameter through the Report Action. This procedure
is described later in this tutorial.
Make a placeholder for the batchid in the Excel spreadsheet. To do this, select a cell in
the spreadsheet, and rename the cell literally as batchid. For example, in Figure 6.48,
cell C2 is renamed batchid.
Renaming Cell C2
with the batchid
Parameter name
3BUF001094-610 A 468
6 Creating Reports
6.11 Creating a Report with Crystal Reports - Example
3BUF001094-610 A 469
6 Creating Reports
6.11 Creating a Report with Crystal Reports - Example
3. Use the Batch Data dialog, Figure 6.50, to configure a query against the
BATCH_TRENDS view for BATCHID, DATAVALUE, TIMESTAMP, and
LOGICALNAME. Use the filter on the LOGICALNAME column to specify a value,
for example tankTemp. Be sure to select the DataDirect formula option in the Output
section.
3BUF001094-610 A 470
6 Creating Reports
6.11 Creating a Report with Crystal Reports - Example
3. Configure the Report Action. Refer to Defining the Report Action on page 419.
Be sure to add the batchID and logicalname to the parameter list. Specify the batch
ID value as an argument, and specify logicalname as a static value (the logicalname
value must be known before configuring the Report Action).
Login parameters for connecting the DataDirect report to the applicable data server
must be specified. To do this, define the following parameter:
DataServerLogin = computer name,user name, password
For example: DataServerLogin = roc74,aid,aid
4. Configure the schedule. Refer to Defining the Schedule on page 450.
This concludes the tutorial for DataDirect.
3BUF001094-610 A 471
3BUF001094-610 A 472
7 Scheduling
7.1 Using Scheduling
7 Scheduling
The 800xA System allows jobs to be scheduled, executed, and maintained. Supported
jobs include reports, historical data archiving, event-driven data collection, calculations,
consolidation of PDLs and message logs, and back-ups.
Installing the Application Scheduler on an Information Management server,
automatically creates the required Service Group and Service Provider objects in the
Service structure as part of the Information Management post-installation procedure.
Installing the Application Scheduler to run on a node that is NOT an Information
Management server requires that these objects be manually created under the
Scheduling Service group in the Service structure as part of Information Management
configuration.
Figure 7.1: Scheduling Structure with Job Descriptions and Running Jobs
Action aspects are added to the Job Description object to specify the activity to be
performed by the job. For example, a Report Action aspect is added to schedule and
execute a report job.
3BUF001094-610 A 473
7 Scheduling
7.2 Adding a Job Description Object
Start condition aspects may be added to impose further conditions by which to execute
the job.
The procedure for creating a job follows these basic steps. Detailed instructions are
provided in the referenced sections:
1. Create a Job Description object. A Schedule Definition aspect, through which the
schedule will be set up, is provided with this object when it is created. To create the
Job Description object and corresponding Schedule Definition aspect, refer to Adding
a Job Description Object on page 474.
2. As an option, add and configure one or more start condition aspects to specify any
conditions that must be met before the job will be allowed to run. Refer to Specifying
Start Conditions on page 483.
3. Add and configure an action aspect. This aspect defines the function that the job
will perform. Refer to Actions on page 489 to add an action aspect.
Five standard actions are supported. With the exception of reports, the section specified
below in System 800xA Information Management Configuration (3BUF001092*) describes
how to configure these actions:
• Reports - This user manual, refer to Section 6 Creating Reports.
• Archive - refer to Configuring the Archive Function.
• Event-driven data collection - refer to Historical Process Data Collection.
• Consolidation of PDLs and message logs - refer to Consolidating Historical Data.
• Calculations - refer to Configuring Calculations.
3BUF001094-610 A 474
7 Scheduling
7.2 Adding a Job Description Object
4. Click Create. This creates the new job under the Job Descriptions group. This
object’s aspect list contains a Schedule Definition aspect.
5. Click on the Scheduling Definition aspect to display the configuration view, Figure
7.2.
3BUF001094-610 A 475
7 Scheduling
7.2 Adding a Job Description Object
• The Enabled check box must be checked in order for the scheduler to use the
selected plug-in for scheduling jobs.
• The Run Now button supports manual execution of a job independent of any
schedule type plug-in.
Use the Schedule pull-down list to select the type of schedule, then refer to the applicable
instructions below to learn how to use the plug-in dialog:
• To run a job at cyclic intervals specified in seconds, refer to Cyclic Scheduling on
page 477.
• To run a job periodically at daily, hourly, minute, or second intervals, refer to Periodic
Scheduling on page 477.
• To run a job on a specified weekday during the month (for example first Monday,
third Wednesday, last Sunday, or every Tuesday), refer to Weekly Scheduling on
page 478.
• To run a job on a specific day of the month (for example 1st, 12th, 31st, or every
day), refer to Monthly Scheduling on page 480.
3BUF001094-610 A 476
7 Scheduling
7.2 Adding a Job Description Object
• To run a job according to a list of scheduled dates and times, refer to Creating a
Scheduling List on page 481.
• To run a job based on the evaluation of an expression, refer to Expression-based
Scheduling on page 482.
3BUF001094-610 A 477
7 Scheduling
7.2 Adding a Job Description Object
As an option, specify a definite start and/or end time. To do this, click either the
Scheduling time-window begins or ends, or both check boxes and specify the
respective start and end times.
3BUF001094-610 A 478
7 Scheduling
7.2 Adding a Job Description Object
Frequency
Use this pull-down list to select whether to run the job on every specified weekday, or
one specific weekday (first, second, third, fourth, or last), Figure 7.7.
Day of week
Use this pull-down list to select the weekday (Monday, Tuesday, Wednesday, Thursday,
Friday, Saturday, or Sunday), Figure 7.8.
Time of day
Use this control to select the time of day, Figure 7.9.
3BUF001094-610 A 479
7 Scheduling
7.2 Adding a Job Description Object
Days
Use this list to select one or more days of the month. Select one or more days as required
by clicking the corresponding number. All selects every day of the month. Clear List
clears all selections.
3BUF001094-610 A 480
7 Scheduling
7.2 Adding a Job Description Object
Daily
Use the Daily tab to specify a time of day at which to run the job, Figure 7.11.
Hourly
Use the Hourly tab to specify one or more hours in the day at which to run the job, Figure
7.12. All selects every hour of the day. Clear List clears all selections.
3BUF001094-610 A 481
7 Scheduling
7.2 Adding a Job Description Object
3BUF001094-610 A 482
7 Scheduling
7.3 Specifying Start Conditions
Enter the expression in the edit window. Refer to the Expression Rules and Examples
section of System 800xA Configuration (3BDS011222*).Typically, the expression will
include a reference to an aspect object in a structure in the Plant Explorer. The syntax
is:
$’[Structure]/RootBranch/Branch/Branch/Object:Aspect:Property’
An example is shown in Figure 7.14.
Use the pull-down list in the lower right corner of the dialog, Figure 7.15, to specify
whether to run the job whenever the expression value changes (Start when value
changes), or only when a boolean expression changes from false to true (Start when
TRUE).
3BUF001094-610 A 483
7 Scheduling
7.3 Specifying Start Conditions
To add a start condition aspect to the Job Description object in the Scheduling Structure:
1. Right-click the Job object (for example DayShiftReport) and choose New Aspect
from the context menu.
2. In the New Aspect dialog, browse to the Scheduler category and select the Start
Condition aspect (path is: Scheduler>Start Condition>Start Condition). Use the
default aspect name, or specify a new name.
3. Click Create to add the Start Condition aspect to the job.
4. Click the Start Condition aspect to display the configuration view, Figure 7.16.
Refer to the applicable section to learn how to configure the selected start condition:
• The Expression Start Condition on page 485.
• The Yes/No Start Condition on page 485.
3BUF001094-610 A 484
7 Scheduling
7.3 Specifying Start Conditions
3BUF001094-610 A 485
7 Scheduling
7.4 Arguments
7.4 Arguments
Jobs whose actions support arguments can reference user-defined arguments to establish
values for certain settings. For example, parameters in the Report action can reference
arguments to set parameter values.
Argument lists are created on a per-job basis. This is done through the Arguments tab
of the Scheduling Definition aspect of the Job Description object, Figure 7.20.
3BUF001094-610 A 486
7 Scheduling
7.4 Arguments
To create a list of arguments manually (reference Figure 7.20 for steps 1 & 2):
1. In the Scheduling structure, select the Job Description object for the job whose
argument list needs to be edited.
2. Select the Scheduling Definition aspect, then click on the Arguments tab.
3. Click in an empty field, then click Modify. This displays the Modify Arguments dialog.
4. Enter the Argument name and value, Figure 7.21, then click OK.
This adds the new argument to the argument list, Figure 7.22.
3BUF001094-610 A 487
7 Scheduling
7.5 Viewing a Job Log
Remove an argument from the list by selecting the argument and then clicking Remove.
The log holds the last ten instances of the job's execution plus any instances that have
failed if they have not been deleted. To get information regarding a job that has failed,
use the Scheduled Job aspect for the Running Job object as described in The Running
Job on page 493.
The number of status entries for SUCCESSFUL runs of a job is limited to 10. The
status of failed jobs is not limited.
3BUF001094-610 A 488
7 Scheduling
7.6 Actions
7.6 Actions
Actions are implemented as aspects on an object which is on or under a job description
in the scheduling structure.
To add an action:
1. Right-click on the Job object (for example DayShiftReport) and choose New Aspect
from the context menu.
2. In the New Aspect dialog, browse to the Scheduler category and select the Action
aspect (path is: Scheduler>Action Aspect>Action Aspect). Use the default aspect
name, or specify a new name (for example RunXyzReport).
3. Click Create to add the Action aspect to the job.
4. Click on the Action aspect to display the corresponding view, Figure 7.24.
3BUF001094-610 A 489
7 Scheduling
7.6 Actions
3BUF001094-610 A 490
7 Scheduling
7.6 Actions
3BUF001094-610 A 491
7 Scheduling
7.6 Actions
For the Batch report template to execute successfully, we need to provide valid
parameters through Edit Parameter List. The parameters are as follows:
1. BatchID:There are two places from which we can get the value to this variable as
follows:
a. Arguments tab of Scheduling Definition Aspect as explained in Arguments on
page 486.
b. Schedule Job BMA (Batch Manager Action)of Production Management System.
2. DataServerLogin: Login parameters for connecting the DataDirect report to the
applicable data server must be specified. The user name and the password are by
default configured as DataServerLogin = localhost, aid, aid. If the user name and
the password defined for Display Services(or DataDirect) during IM Post Installation
is not “aid, aid”, then it should be modified by clicking Edit Parameter List.
3. LogicalNameList: It represents the names of History associations specified in
DataCollection BMA of Produce IT. An example is shown in Figure 7.27. This
parameter is compulsory for Batch Trends Data retrieval. Parameter Intervals is
also used for Batch Trends data. For more information on Schedule BMA, refer to
the Batch Management documentation.
3BUF001094-610 A 492
7 Scheduling
7.7 Job Hierarchies
3BUF001094-610 A 493
7 Scheduling
7.8 The Running Job
3BUF001094-610 A 494
7 Scheduling
7.8 The Running Job
If a job fails it is left in an uncompleted state and must be manually completed (or deleted).
A system message is generated when a job fails and its status (S_STATUS) is marked
as bad. This allows the system status function to flag the condition in its viewer.
When a job is completed the Running Job object is removed from the Running Job
Branch, and the status information collected for the job is transferred to its associated
job description. This information is available through the Job Log tab of the Scheduling
aspect. Refer to Viewing a Job Log on page 488.
3BUF001094-610 A 495
7 Scheduling
7.8 The Running Job
3BUF001094-610 A 496
7 Scheduling
7.8 The Running Job
3BUF001094-610 A 497
7 Scheduling
7.9 Security
7.9 Security
Operations related to Application Scheduler aspects are secured by restricting access
to certain users. Restrict access based on permissions, or a combination of user role
and permissions. When restricted solely on permissions, any user having the specified
permissions can perform the operation. Binding a user role to an operation means only
that user type can perform the operation, and that user must be assigned the applicable
permissions.
The default security configuration allows:
• Any user to read scheduling aspects.
• Operators to configure (modify) the scheduling definition and run (manage) the
scheduled jobs.
• Application Engineers to create and configure action and start condition aspects
which specify what a job will do.
3BUF001094-610 A 498
7 Scheduling
7.9 Security
The following procedure describes how to change permissions and user roles for
scheduling aspect operations. Report templates and report output stored as Windows
files on shared network drives may also be secured. Refer to Securing Windows Files
on Shared Network Drives on page 501.
Before applying any changes to the Security settings, read Industrial IT 800xA System
Security and understand the concepts presented.
Permissions and user role bindings for aspects are configured in the Aspect System
structure in the Plant Explorer. To do this: (reference Figure 7.33):
1. Go to the Aspect System structure in the Plant Explorer and select the Scheduler
Aspect System.
2. Expand the branch to show the four Scheduler aspect types (Action, Job Description,
Scheduled Job, and Start Condition). Then further expand the branch for the aspect
whose permissions need to be modified. For example, in Figure 7.33 the Job
Description branch is expanded to show the Scheduling Definition aspect category.
3. Click on the Aspect Category Definition in the aspect list, and then click the
Permissions tab.
For each operation listed, select the appropriate permission, Figure 7.34. Refer to Table
7.2 for details.
3BUF001094-610 A 499
7 Scheduling
7.9 Security
1. To further restrict access based on user role, click the User Role Bindings tab. For
each operation listed, select the appropriate user role, Figure 7.35.
3BUF001094-610 A 500
7 Scheduling
7.9 Security
3BUF001094-610 A 501
3BUF001094-610 A 502
8 Tag Management
8.1 User Tag Management (UTM)
8 Tag Management
This section describes two tag management tools: User Tag Management (UTM) and
Information Management Browser on page 514).
3BUF001094-610 A 503
8 Tag Management
8.1 User Tag Management (UTM)
When opened from the Start menu, the utility will open but will not be connected to any
host. To log in to a host,
1. Select:
File > Connect
2. Enter the User Name, Password, and Host Name for the DBA Data Provider in the
Login dialog.
3. Click OK.
Default groups are provided. The display will update to list the tags for the groups selected.
3BUF001094-610 A 504
8 Tag Management
8.1 User Tag Management (UTM)
3BUF001094-610 A 505
8 Tag Management
8.1 User Tag Management (UTM)
3BUF001094-610 A 506
8 Tag Management
8.1 User Tag Management (UTM)
The behavior is as follows when the Match Group Names check box is enabled. This
behavior is independent of the status (enabled/disabled) of the Match Tag Names check
box.
The tags that appear in the right pane of the search window are those found within the
group entered into the search string. If the search string has no wild card and matches
the group name text exactly, it displays all tags within that group. If a wildcard is used,
it returns all tags found within any group that match the wildcard search string. Expanding
the full path of a returned tag reveals the source of the tag.
3BUF001094-610 A 507
8 Tag Management
8.1 User Tag Management (UTM)
3BUF001094-610 A 508
8 Tag Management
8.1 User Tag Management (UTM)
The System Groups hierarchy does not allow changes to the groups and tags. Only
public and private groups allow groups and tags to be added, deleted, and modified.
3BUF001094-610 A 509
8 Tag Management
8.1 User Tag Management (UTM)
Go To Group
Select the Go To Group context menu item to find a group or find the next group when
in the hierarchical view.
3BUF001094-610 A 510
8 Tag Management
8.1 User Tag Management (UTM)
3BUF001094-610 A 511
8 Tag Management
8.2 Using UTM from Desktop Tools
Figure 8.2: DataDirect’s Inform IT History Values User Tag Management Tab
3BUF001094-610 A 512
8 Tag Management
8.3 User Tag Management Status
The Browse button accesses the UTM utility. Find and select tags to add directly to the
spreadsheet or trend using the Add Tags button. The Clear List and Remove Selected
buttons aid in managing the list.
Update is typically a one-time operation to build system groups. It must be run to get
new system groups when new tags are added to the system.
The Clear button is used to clear the database of user tags. When clicked, a warning
dialog is displayed if there is information saved in the database. Click No in the warning
dialog to close it without loss of data. Click Yes in the warning dialog to close it and clear
the group and client tag tables of data.
3BUF001094-610 A 513
8 Tag Management
8.4 Information Management Browser
When using the browser with DataDirect or Desktop Trends dialogs, the selected tags
are automatically entered into the applicable tag selection field or list in the dialog. When
using the browser for ODA (or for DataDirect function calls), the browser is used to copy
the selected tag names to paste in a data query application, for example Microsoft Query
or Crystal Reports.
3BUF001094-610 A 514
8 Tag Management
8.4 Information Management Browser
This section describes how to use the browser when launched from the Windows Taskbar.
Instructions for DataDirect and Desktop Trend applications are provided in the respective
sections. The basic steps for using the browser are described below. Details are provided
in the referenced sections.
1. Launch the browser from the Windows Taskbar. Select:
ABB Start Menu > ABB System 800xA > Information Mgmt > Utilities > IM
Structure Browser
2. By default, the Information Management Browser connects to the server specified
in the ACC Setup dialog. The connected server is indicated in the Connected To:
field. To specify a different server, click the Connect/Change Connection button
(Figure 8.6) and then specify the IP address or host name for the new server in the
Connection dialog.
The browser uses the AIPHDA data provider (for History log access) by default. The
Data Provider specification determines the type of tags that can be accessed through
the browser:
• AIPOPC is used to browse for real-time (process or softpoint) tags.
• AIPHDA connects to the 800xA OPC HDA server and is used to browse the Aspect
Directory for numeric property logs. This supports seamless access to trend logs
and history logs. It also is used to access log attributes.
• IMHDA connects to an alternative OPC HDA server. For further information, refer
to Appendix C.
The mode of operation for the browser differs slightly depending on whether AIPHDA
or IMHDA is being used. For further information, refer to Considerations for History
Access on page 517.
The data provider specification defaults to AIPHDA. To change the specification,
click inside the Data Provider field, enter the data provider name, then click Change
(Figure 8.6).
1. Use the browser according to the guidelines in Navigation Methods on page 516 and
Filtering on page 516. Also, for history access applications, refer to Considerations
for History Access on page 517.
2. Copy one or more tags to paste in the client application. Refer to Copying Items on
page 516.
3BUF001094-610 A 515
8 Tag Management
8.4 Information Management Browser
8.4.2 Filtering
Specify a filter to narrow the scope of items returned by the Get Entire List method. This
helps keep the list at a manageable size. For example:
• IM - gets all items whose name includes the text string IM.
• *IM - gets all items whose name ends with the text string IM.
• IM* - gets all items whose name starts with the text string IM.
Enabling the Exclude Filtered Items check box retrieves all items whose names DO
NOT meet the filter criteria. For example, enabling this check box with the filter text IM
will get all items whose names do not include the IM text string.
3BUF001094-610 A 516
8 Tag Management
8.4 Information Management Browser
AIPHDA Access
For AIPHDA, the browser, Figure 8.3, provides a directory structure similar to the Plant
Explorer and includes all structures and directories where log aspects reside.
With the AIPHDA server, the Seamless retrieval option can be used when it is uncertain
which log in a property log hierarchy will provide the best coverage for the required time
range. When the Seamless option is not used, the browser passes the query application
the name of a specific component log in the property log hierarchy. This limits the query
to the time range covered by that log. With Seamless retrieval, the browser passes the
query application the base name of the property log. This lets the query retrieve data
from any component log within the property log. To use seamless retrieval rather than
select a specific log, enable the Seamless check box.
3BUF001094-610 A 517
8 Tag Management
8.4 Information Management Browser
IMHDA Access
For IMHDA, the left pane is used to choose one of three paths or categories by which
to conduct a search, Figure 8.3 (LOGMAN is not applicable):
• EH is used to access logs that are local to the connected data provider. This is the
fastest method and is recommended when querying a log that resides on the local
server. It supports the ability to modify existing log entries, but it does not support
adding new entries.
• EH_NET is used to access logs on all servers on the network. This requires OMF
access to be extended on the TCP/IP network. It supports the ability to modify
existing log entries, and add new entries.
• EH_PUBL is used to access archived log data that is published. Publishing archived
data is described in Publishing an Archive Volume on page 562.
3BUF001094-610 A 518
9 Reading and Managing Archive Data
The archive function supports permanent offline storage for historical data collected in
property (numeric), message, PDL, and report logs as well as reports stored as Completed
Report objects. Archiving is set up during Information Management configuration. This
section describes how to make archive data available for desktop applications such as
DataDirect, how to perform manual archives, and how to maintain archive data. This
includes:
• Maintaining archive media - When an archive media becomes full it will require
maintenance to permit archive operations to continue. For MO media, periodically
remove and replace platters. For hard disks, ensure that archive entries are saved
to a removable media (CD or DVD). After entries have been saved to a removable
media, the hard disk must be periodically purged of old entries to provide space for
new entries.
• Formatting and initializing archive media - The archive media must be formatted
and initialized before data can be stored on it. For MO drives, use the Windows disk
formatting tool to format each new platter before initializing it. Select the NTFS
format. Both sides of the platter need to be formatted.
For timed archiving, the media are re-initialized automatically as long as the device
behavior is set to either Wrap When Full or Advance When Full. For manual
archiving, manually initialize the media.
• Manual archiving.
• Publishing archive volumes for access by external applications - Archive
volumes can be published to let client applications such as DataDirect access the
archived data. This saves from having to restore individual logs from the archive
volumes. Publishing applies to propertyand profile and message logs only.
• Restoring archived logs for access by external applications - To access archived
log data that has not, or cannot be published, restore the archived logs from the
archive media to the restored History database. Restored logs may also be deleted
when they are no longer needed.
• Importing archive data from other 800xA Systems and from earlier historian
platforms - This is done using the Archive Import tool.
3BUF001094-610 A 519
9 Reading and Managing Archive Data
9.1 User Interface
3BUF001094-610 A 520
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
3BUF001094-610 A 521
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
The aspect view is displayed by selecting the archive device aspect in the archive device
object’s aspect list. Toggle between the config and main views by right clicking the aspect
and choosing config view or main view from the context menu. The view selector icon,
Figure 9.1, is used to display the selected view in a separate window.
Node
Archive
Service
Object
View
Selector
The functions supported by this aspect are listed in Supported Functions on page 522.
The information provided on this aspect is described in Archive Device Information on
page 523.
Supported Functions
The archive functions supported by this aspect are described in Table 9.1. These functions
are available through the context menu and Actions button, Figure 9.2.
Table 9.1: Archive Functions Supported by the Archive Device Aspect - Main View
Function Description
Opening an Archive Volume from the Alternative to accessing a volume directly from the browser.
Archive Device Aspect. To do this, select the volume, then right click and choose
Open from the context menu. This opens the aspect in a
separate window.
Remounting a Volume on page 540 Volumes should be remounted prior to initializing. Also,
remount a volume to refresh the volume information on the
archive device aspect.
3BUF001094-610 A 522
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
Table 9.1: Archive Functions Supported by the Archive Device Aspect - Main View
(Continued)
Function Description
Initializing an Archive Volume on page Each new archive volume must be initialized prior to
540 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.
Archiving Logs Manually on page 547 Alternative to scheduled archives.
Mark Volume Full Marks a volume full to prevent any additional timed archives
from writing to the volume.
Publishing an Archive Volume on page Recommended method for making archived numeric data
562 available for data access.
Overriding Volume Backup on page 546 There are certain situations when a volume may need to
be marked as backed up, even though the volume has not
been backed up.
Activating/Deactivating an Archive Device Device must be active to perform archive operations. MO
on page 539. devices must be deactivated to change platters.
Showing Volume Information on page 575.
Actions
B
Button
OR
Context
Menu
3BUF001094-610 A 523
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
3BUF001094-610 A 524
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
Archive Volume objects are located under their respective archive device object which
is typically under an Industrial IT Archive service provider object in the Node Administration
structure.
The aspect view is displayed by selecting the archive volume aspect in the aspect list.
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.
The functions supported by this aspect are listed in Supported Functions on page 525.
The information provided on this aspect is described in Archive Volume Aspect Information
on page 527.
Supported Functions
The archive functions supported by this aspect are described in Table 9.3.
3BUF001094-610 A 525
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
All functions are through the Actions button, Figure 9.4. Some may also be invoked
through the context menu (Restore Archive, Restore Logs, and Platform Info).
3BUF001094-610 A 526
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
3BUF001094-610 A 527
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
3BUF001094-610 A 528
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
3BUF001094-610 A 529
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
Supported Functions
The runtime functions supported by this aspect are described in Table 9.7. Some functions
are related to archive group configuration. These are described in System 800xA
Information Management Configuration (3BUF001092*). All functions are available
through the Action button and context menu, Figure 9.6.
3BUF001094-610 A 530
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
3BUF001094-610 A 531
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
3BUF001094-610 A 532
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
3BUF001094-610 A 533
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
3BUF001094-610 A 534
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
• delete restored report logs from the restored History database. Refer to Deleting
Restored Logs on page 572.
3BUF001094-610 A 535
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
3BUF001094-610 A 536
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
This window displays the following information for PDLs and their corresponding tasks,
Table 9.10.
3BUF001094-610 A 537
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
MO Media
For MO archive media, the platter must be removed and replaced when it becomes full.
The new platter must then be initialized. Refer to:
• Removing/Replacing Platters on page 539.
• Initializing an Archive Volume on page 540.
3BUF001094-610 A 538
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
3BUF001094-610 A 539
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
Or use the
Actions button
For MO drives, before the archive volume is initialized, make sure the media has
been formatted as described in Removing/Replacing Platters on page 539.
3BUF001094-610 A 540
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
Initialization of archive volumes may be done using the archive device aspect for the
archive device whose volume needs to be initialized, or the Archive Volume Aspectmay
be used.
To initialize a volume:
1. Install the archive media in the disk drive.
2. Navigate to and select either the archive device aspect whose volume is being
initialized, or select the applicable Archive Volume Aspect.
3. If the archive volume aspect is being used, invoke the Initialize command from the
Action button or context menu, Figure 9.13.
Then skip steps 4 and 5 which pertain only when using the archive device aspect.
Resume the procedure at Step 6..
4. If the archive device aspect is being used, select and remount the volume. This is
not required when using the archive volume aspect.
Always remount a volume BEFORE initializing it from the archive device aspect.
The information in the archive device aspect is not automatically updated when a
new archive media is inserted, and so may not accurately indicate the current
contents of the archive device. Remounting the volume will ensure that the selected
volume is actually installed in the archive device. To do this, select the volume, right
click and choose Remount from the context menu (Remounting a Volume on page
540).
3BUF001094-610 A 541
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
5. If the archive device aspect is being used, once the volume has been remounted,
re-select the volume, right click and choose Initialize from the context menu, Figure
9.14.
3BUF001094-610 A 542
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
6. Whether the archive volume aspect or the archive device aspect is being used,
invoking the Initialize command displays the Initialize Volume dialog, Figure 9.15.
The Volume ID and Overwrite Timeout default to the values specified for all volumes
on the archive device config view. Use this dialog to change these values if
necessary. As an option, enter a Volume Label. For further details regarding these
initialization parameters refer to Table 9.11.
3BUF001094-610 A 543
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
7. Click OK to initialize the media. If the initialization parameters are specified correctly,
a message indicating the initialization was successful will be displayed in the
message box, and the Volume State will go to Valid, Figure 9.16. If one or more
parameters were defined incorrectly, an error message will be displayed. If the
Overwrite Timeout has not expired on the media being initialized, then verify whether
or not to overwrite it.
3BUF001094-610 A 544
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
Volumes backed up this way are not automatically marked as backed up. Use the
procedure in Overriding Volume Backup on page 546 to do this if necessary.
3BUF001094-610 A 545
9 Reading and Managing Archive Data
9.3 User Interface for Managing Archive Data
3BUF001094-610 A 546
9 Reading and Managing Archive Data
9.4 Archiving Logs Manually
3BUF001094-610 A 547
9 Reading and Managing Archive Data
9.4 Archiving Logs Manually
3BUF001094-610 A 548
9 Reading and Managing Archive Data
9.4 Archiving Logs Manually
Parameter Description
Device Archive device to process the archive entry.
Volume Volume on selected archive device where archive entry will
be written
Start and End Times Time span for data to be archived.
Description Optional description to label the archive entry
3BUF001094-610 A 549
9 Reading and Managing Archive Data
9.4 Archiving Logs Manually
The window is empty when it is first opened. For the logs that will be archived, first retrieve
the log information. This procedure varies depending on the log type. For numeric,
message, and report logs continue with this procedure as described in Retrieving Log
Information. For PDLs, refer to View Production Data Logs Aspect on page 536.
3BUF001094-610 A 550
9 Reading and Managing Archive Data
9.4 Archiving Logs Manually
The retrieved logs and corresponding information are displayed in the View Logs window
based on the specified location or archive group. An example is shown in Figure 9.22.
The retrieved log list may be too large to manage. For example, the list in Figure 9.22
has 9000 logs. The Search tab is used to apply a filter to reduce the retrieved log list.
This is described in Filtering the Retrieved Logs List on page 552. Apply a filter to reduce
the log list if needed, then select the logs to be archived and complete the archive as
described in Completing the Archive Request on page 553.
3BUF001094-610 A 551
9 Reading and Managing Archive Data
9.4 Archiving Logs Manually
Parameter Description
Log Name List logs whose name has the specified text string.
Archive Group List logs that belong to the specified archive group.
Log Status List logs that have the specified log status. When Not Used is
selected, both active and inactive logs are displayed.
Match All Conditions These option buttons are used to choose whether the search
Match Any Condition will include logs that match ANY one or more of the three
conditions described above, or only those logs that match ALL
three conditions.
3BUF001094-610 A 552
9 Reading and Managing Archive Data
9.4 Archiving Logs Manually
3BUF001094-610 A 553
9 Reading and Managing Archive Data
9.4 Archiving Logs Manually
Field/Button Description
Archive Device Enter the name of the archive device where the logs will be copied.
Surface (volume) This pick list is populated with the list of surfaces corresponding to
the selected archive device. The default choice is the active surface.
Volume State This is a read-only field that indicates the status of the selected
volume.
Usage This is a read-only field that indicates the amount of space already
occupied on the selected volume.
Active Volume This is a read-only field that indicates the current volume where
timed archiving is writing data.
Start & End Time As an option, enter a time range for the archive. If a time range is
not specified, the entire log is archived.
Description Enter an optional description to identify this archive entry.
3BUF001094-610 A 554
9 Reading and Managing Archive Data
9.4 Archiving Logs Manually
3BUF001094-610 A 555
9 Reading and Managing Archive Data
9.4 Archiving Logs Manually
3BUF001094-610 A 556
9 Reading and Managing Archive Data
9.4 Archiving Logs Manually
1. 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.
2. Click Apply. This will display all PDLs for the selected log type.
3. Select one PDL from the list to retrieve its corresponding tasks.
This may take some time depending on the number of tasks. The message bar at
the bottom of the window will indicate that History Services is retrieving the information.
DO NOT click again. Doing this would put another request in the queue and delay
the information retrieval process.
The tasks are displayed in the lower pane beneath the log list.
The retrieved Log or Task list may be too large to manage. The Filter Tasks tab is used
to apply a filter to reduce the retrieved Task list. To do this, follow the guidelines in
Filtering the Task List on page 558.
3BUF001094-610 A 557
9 Reading and Managing Archive Data
9.4 Archiving Logs Manually
• specify a start time range. This will exclude any tasks whose start time does not not
fall within the specified range. To do this, check both Start Time fields and specify
a from and to start time. Uncheck the End Time fields.
• specify an end time range. This will exclude any tasks whose end time does not not
fall within the specified range. To do this, check both End Time fields and specify a
from and to end time. Uncheck the Start Time fields.
• specify both a start time range and an end time range. To do this, check and specify
all time fields.
Click Update Filter to apply the new filter specification.
3BUF001094-610 A 558
9 Reading and Managing Archive Data
9.4 Archiving Logs Manually
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 as described
in Table 9.16, then click Archive.
Field/Button Description
Archive Device Enter the name of the archive device where the logs will be copied.
Surface This pick list is populated with the list of surfaces corresponding to
the selected archive device. The default choice is the active surface.
Volume State This is a read-only field that indicates the status of the selected
volume.
Usage This is a read-only field that indicates the amount of space already
occupied on the selected volume.
Active Volume This is a read-only field that indicates the current volume where
timed archiving is writing data.
Description Enter an optional description to identify this archive entry.
3BUF001094-610 A 559
9 Reading and Managing Archive Data
9.5 Verifying Archive Data
3BUF001094-610 A 560
9 Reading and Managing Archive Data
9.6 Making Archived Data Available to Client Applications
3BUF001094-610 A 561
9 Reading and Managing Archive Data
9.6 Making Archived Data Available to Client Applications
3BUF001094-610 A 562
9 Reading and Managing Archive Data
9.6 Making Archived Data Available to Client Applications
Archive entries written to the volume after publishing will not be in the media database.
Access to this data would require the volume to be unpublished and then republished.
At this point the archive data are available for client applications. Refer to Accessing
Published Logs on page 565.
3BUF001094-610 A 563
9 Reading and Managing Archive Data
9.6 Making Archived Data Available to Client Applications
3BUF001094-610 A 564
9 Reading and Managing Archive Data
9.6 Making Archived Data Available to Client Applications
3BUF001094-610 A 565
9 Reading and Managing Archive Data
9.6 Making Archived Data Available to Client Applications
For property logs, publish rather than restore the archive data. Refer to Publishing
an Archive Volume on page 562.
3BUF001094-610 A 566
9 Reading and Managing Archive Data
9.6 Making Archived Data Available to Client Applications
Restoring is performed through the Archive Volume Aspect. Archive volumes are typically
located in the Node Administration structure under their respective archive devices.
Either restore an entire archive entry, or select a subset of logs to restore from the entry.
Also, the procedure for restoring an entry with Platform Objects is slightly different.
• Restoring an Archive Entry on page 567.
• Restoring Selected Logs in an Entry on page 568.
• Restoring an Entry With Platform Objects on page 569.
Guidelines for referencing restored logs are provided in Accessing Restored Logs on
page 572.
3BUF001094-610 A 567
9 Reading and Managing Archive Data
9.6 Making Archived Data Available to Client Applications
3BUF001094-610 A 568
9 Reading and Managing Archive Data
9.6 Making Archived Data Available to Client Applications
3BUF001094-610 A 569
9 Reading and Managing Archive Data
9.6 Making Archived Data Available to Client Applications
Set Filter
for Entries List
This displays the Filter Entries dialog. This dialog is used to filter the entries list
based archive type (Manual or Scheduled), archive group, and archive group
description.
2. Enter the filtering criteria. Use one, two, or all three criteria. Figure 9.39 shows a
filter for Scheduled archives for the group named IMlog1.
Leading and trailing wildcard characters are present by default (but not shown). Do
not enter wildcard characters in this dialog.
3. Click OK when done. The result for this filter is shown in Figure 9.40.
Reset Filter restores all archive entries to the list.
3BUF001094-610 A 570
9 Reading and Managing Archive Data
9.6 Making Archived Data Available to Client Applications
Filtering Logs
When an archive entry is selected, the log list initially displays all logs for the selected
archive entry. Reduce the number of logs in the list by applying a filter based on log
name and/or log type.
To do this:
1. Click Set Filter for the log list, Figure 9.41.
Set Filter
for Log List
This displays the Filter Logs dialog. This dialog is used to filter the log list based log
type, and log name. Log type options are: Object (for example, Completed Report),
Numeric, Message, Profile, Generic, PDL, and SPC.
2. Enter the filtering criteria. Use one or both criteria. Figure 9.42 shows a filter for
Numeric logs whose name contains the string HSSIN.
Leading and trailing wildcard characters are present by default (but not shown). Do
not enter wildcard characters in this dialog.
3. Click OK when done. The result for this filter is shown in Figure 9.42.
3BUF001094-610 A 571
9 Reading and Managing Archive Data
9.6 Making Archived Data Available to Client Applications
3BUF001094-610 A 572
9 Reading and Managing Archive Data
9.6 Making Archived Data Available to Client Applications
3BUF001094-610 A 573
9 Reading and Managing Archive Data
9.7 Miscellaneous Archive Operations
To delete a batch task from the View Production Data Logs window:
1. Select the PDL whose batch tasks will be deleted. Only one PDL can be selected.
2. Select one or more batch tasks to delete.
3. Go to the Delete tab and click Delete Runtime Tasks. This displays a confirmation
message.
4. Click on Yes to confirm or No to cancel.
3BUF001094-610 A 574
9 Reading and Managing Archive Data
9.7 Miscellaneous Archive Operations
3BUF001094-610 A 575
9 Reading and Managing Archive Data
9.7 Miscellaneous Archive Operations
Aspect List
for selected
log
3BUF001094-610 A 576
9 Reading and Managing Archive Data
9.7 Miscellaneous Archive Operations
The function is available on the archive volume aspect. To use this function (reference
Figure 9.47):
1. Select the archive volume aspect.
2. Select an archive entry from list of entries in the upper pane.
3. Select one or more logs from the list in the lower pane.
4. Click Actions then choose Platform Info (or use context menu).
To display the log configuration aspect for a log, select the log in the upper log list, then
click the log configuration aspect icon in the lower pane.
Select an
entry
Then select
one or more
logs
3BUF001094-610 A 577
9 Reading and Managing Archive Data
9.8 Importing Archive Data
9.8.1 Overview
The Archive Import tool, Figure 9.48, is accessible through the Config view on an Archive
Volume aspect. It is based on an Excel workbook with embedded buttons and functions
designed specifically for importing archives from other platforms.
3BUF001094-610 A 578
9 Reading and Managing Archive Data
9.8 Importing Archive Data
The Process
1. Start by selecting an archive volume from which to import the archive data. The
volume must be mounted in a drive on the Information Management Application
Server or a mapped drive, and the drive must have an archive volume aspect that
supports reading from the volume.
2. Select one or more archive groups that have entries on the volume. This is used to
if it is desired to limit the number of logs that will be imported in one session.
The Archive Import Tool creates new log configuration aspects to hold the imported
archive data. If the system has objects where these new log configuration aspects
can be added, then those objects may be used. If no object exists for the data from
the archive, the Archive Import tool creates an Object Structure to provide navigation
for the restored data. The tool also creates new log templates from which to
instantiate the new log configuration aspects.
3BUF001094-610 A 579
9 Reading and Managing Archive Data
9.8 Importing Archive Data
The Workbook
The workbook has three sheets. The first sheet shown in Figure 9.48 is named Log List.
The top of this sheet, Figure 9.49, contains a row of command buttons arranged so the
import operation can proceed in stepwise fashion from left to right. The two rows below
the buttons provide feedback for the button commands.
The remaining rows provide log information. Colored headings indicate the source of
the data. For example, blue indicates information extracted from the archive files. Yellow
indicates information for which the tool has provided a default value, but which may be
modified by the user. Purple indicates information created by the tool in the 800xA
System.
The second sheet is named Log Templates, Figure 9.50. As the import progresses, this
sheet is populated with the information needed to create the log templates that will be
used to instantiate the archive log configurations. This sheet uses the same color coding
as the Log List sheet. Certain parameters on this sheet can be modified if necessary,
for example, log names and log template names.
3BUF001094-610 A 580
9 Reading and Managing Archive Data
9.8 Importing Archive Data
3BUF001094-610 A 581
9 Reading and Managing Archive Data
9.8 Importing Archive Data
This sheet provides more detailed feedback, status and error reporting. If something
unexpected happens, this sheet may show why. Each message is time stamped, and
operations that may take time include a time duration report. This will help when
determining how long certain operations may take with the particular combination of
archives, media, and hardware.
3BUF001094-610 A 582
9 Reading and Managing Archive Data
9.8 Importing Archive Data
The first time the Archive Import Tool is started, ABB Inc. must be added to the Trusted
Publishers in Microsoft Excel.
3BUF001094-610 A 583
9 Reading and Managing Archive Data
9.8 Importing Archive Data
To select an archive volume and start the Archive Import Tool (Reference Figure 9.52):
1. Go to the Node Administration structure and select the Archive Volume object for
the media where the archive volume is mounted. For example, in Figure 9.52 the
Archive Volume object for Drive F is selected.
2. Select the Archive Volume aspect from the object’s aspect list.
3. Use the View Selector to change the view to the Config View. This displays a dialog
that is used to start a new workbook or open an existing workbook. Continue with
this dialog as described in Generating an Aspect Reference Data Source on page
585.
3BUF001094-610 A 584
9 Reading and Managing Archive Data
9.8 Importing Archive Data
This opens a new workbook. The system and archive volume path specifications are
already defined, Figure 9.54. Therefore, it is not necessary to use the first two command
buttons corresponding to those steps. Start with the third button for Setting the Archive
Group Filter.
3BUF001094-610 A 585
9 Reading and Managing Archive Data
9.8 Importing Archive Data
3BUF001094-610 A 586
9 Reading and Managing Archive Data
9.8 Importing Archive Data
Select one or more groups (and/or manual archive instances) on the Archive Volume
whose archive files will be imported. Perform the following:
3BUF001094-610 A 587
9 Reading and Managing Archive Data
9.8 Importing Archive Data
This dialog lists the names of the archive groups represented on the Archive Volume.
Manual archive instances are represented by the common name: Custom. The
number of logs contained in each group is indicated by the first number in
parentheses following the group name. The second number indicates the number
of occurrences of the group on the archive volume.
3BUF001094-610 A 588
9 Reading and Managing Archive Data
9.8 Importing Archive Data
Since group definitions may change between one archive event and the next, the
number in parentheses indicates the maximum log count over all instances of the
archives of that group in this Volume. The number in parentheses indicates the total
number of logs recorded in the Archive Header files as belonging to that particular
group. The number of numeric logs may be considerably less than this number. The
total log number is just a guide.
2. Select one or more groups. Hold down the Ctrl key to select multiple groups or to
deselect already selected groups. Selecting no groups is equivalent to selecting all
groups.
3. Click OK once the selections are made.
The selected group names will be indicated in the report area under Archive Group
Filter. Each name will be separated by the character (:), Figure 9.57. Log counts
are not indicated. As a result of this operation, a message will be created on the
Message sheet (sheet 3). An example is shown in Figure 9.58.
3BUF001094-610 A 589
9 Reading and Managing Archive Data
9.8 Importing Archive Data
Figure 9.59:
3BUF001094-610 A 590
9 Reading and Managing Archive Data
9.8 Importing Archive Data
2. Select the Start button. This will initiate a read of Archive information which can not
be interrupted (a progress bar will appear). The time to read this information may
be significant, depending on the size of the archive and other factors. During this
operation, information for the logs in the selected groups is read from the archive
volume.
The tool will create a new log template for each unique combination of Aggregate
and Storage Rate found. This information is entered on the Log Templates sheet,
along with the default names for the property log templates and log configurations.
An example is shown in Figure 9.19.
The Template value in the Logs / Templates report cell on the first sheet is incremented
when a new Template row is added to the second (Log Template) sheet.
After the information has been read into memory, the Archive Log Names, Data Sources,
Aggregates, and Storage Rates for each log are entered into the four left columns of the
Log List sheet, one row per log, Figure 9.20.
3BUF001094-610 A 591
9 Reading and Managing Archive Data
9.8 Importing Archive Data
In addition to data extracted from the Archive, default Template Row Numbers (pointing
to a Property Log Template configuration on the Log Template sheet) is also entered for
each log, along with default values for the 800xA Object Names, Property Names, and
Data Types.
Once the Log rows have been created, duplicate rows are purged automatically. Duplicate
rows will occur if the same log information is read in more than once, or if the same log
occurs in multiple groups. In order to remove duplicate entries from the workbook, the
Log list is sorted. If a duplication is found, the most recent entry is preferred, unless the
older entry already contains an Object Path. As duplicate rows are removed, the progress
bar advances backwards (right-to-left), indicating which spreadsheet row is being
processed.
As a result of this operation, a message will be created on the Message sheet (sheet 3).
An example is shown in Figure 9.60.
At this point, the workbook has rows representing archived logs on Sheet 1. Filter these
rows, if desired, to process only a subset of logs. The remaining buttons will operate
only on the rows left unfiltered (visible).
Each header column on the Log List sheet already has an Excel Filter defined, Figure
9.61. Filtering on multiple columns, especially using the built in Custom filtering feature,
is an effective way to isolate a set of log rows that need to be processed identically.
After executing the Load Data From Archived Volume command, the results may be
modified. For example, object names can be modified. For details, refer to Overriding
The Defaults on page 603.
3BUF001094-610 A 592
9 Reading and Managing Archive Data
9.8 Importing Archive Data
This displays an Object Browser for selecting a single parent (root) object in the 800xA
System, Figure 9.22. The default parent object is based on the volume name. Another
object may be selected.
3BUF001094-610 A 593
9 Reading and Managing Archive Data
9.8 Importing Archive Data
When a parent object is selected, the object browser is replaced by a progress bar which
monitors the progress of creating new objects having properties with the specified data
types as immediate children of the chosen Parent Object.
The process of creating objects can be stopped by clicking on the Stop button of the
progress bar.
As rows are processed, the Create New Objects report cell keeps track of successes
and attempts. Success is marked by entering information in the next three columns of
the Log row: Object Path, Object GUID, and Property Aspect GUID. This information is
stored (persisted) in the workbook as it is needed for subsequent operations, which may
not occur in the same Excel session.
If an existing object with the same name as the proposed new object is found (as a child
of the parent object), the tool will not create a duplicate object, but will use the existing
object. Otherwise, the tool will create a new object, with object type = Archive Import
Object.
If an existing property with the same name as the proposed new property is found, the
tool will not create a duplicate property, but will use the existing property. Otherwise, the
tool will create (or expand) a General Properties aspect, adding a new property with the
specified name and data type.
Messages on the Messages Sheet indicate final success/attempts status, whether the
operation was stopped, and reasons for failures. An example is shown in Figure 9.23.
3BUF001094-610 A 594
9 Reading and Managing Archive Data
9.8 Importing Archive Data
This displays an Object Browser for selecting a set (one or more) of parent (root) objects
in the 800xA System, Figure 9.25. These parent objects must have already been created
in the 800xA System.
3BUF001094-610 A 595
9 Reading and Managing Archive Data
9.8 Importing Archive Data
The label of the Object Browser window keeps track of the number of root objects selected
so far, as does the Success / Attempts / #Roots report cell beneath the Match Existing
Objects command button.
After selecting the first object, the Select prompt on the Object Browser changes to Add
Another Parent. Click Done when finished adding Parent Objects.
In the current Archive Import Tool session, if a set of root objects were previously
specified for matching, the Done button will read Use Previous. Clicking Use
Previous without selecting any objects will use the previous root object set. This
feature only works during a single session, since the set of matching object roots is
not persisted in the workbook between sessions.
Close the window to cancel at any time.
When parent objects are selected, the tool creates an internal list of all objects that are
descendents of those parent objects. The tool then matches the object names in the log
rows of the worksheet against that internal list. If a match is found, the tool looks for a
matching property name.
The Object Browser is replaced by a progress bar that monitors the progress of matching
existing objects and properties. The process of matching objects can be stopped by
clicking on the Stop button of the progress bar.
The Match Existing Objects functionality does not create either Objects or Properties.
3BUF001094-610 A 596
9 Reading and Managing Archive Data
9.8 Importing Archive Data
Messages on the Messages Sheet indicate final success/attempts status, whether the
operation was stopped, and reasons for failures.
The following is a typical Message Sheet entry:
This displays an Object Browser for selecting a parent object for the Property Log
Templates whose configurations are defined on the Log Templates sheet. The default
is the Archive Import Template Library Object under the History Log Templates object
in the Library Structure, Figure 9.27. A different parent object may be selected.
For each unfiltered (visible) row on the Log List sheet, the tool locates the object specified
in the Object Path column and creates a log configuration aspect for that object. If a log
configuration aspect already exists, that aspect is used. The tool then creates a new
property log in that aspect, using the property, data type and log template indicated by
the information (names and GUIDs) stored for that row in the workbook.
3BUF001094-610 A 597
9 Reading and Managing Archive Data
9.8 Importing Archive Data
This command only operates on unfiltered visible rows of the Log Template sheet and
will not create duplicate templates if the templates already exist.
Upon selecting the parent template library, the object browser is replaced by a progress
bar with a Stop button. However, the number of Property Log Templates is usually very
small, compared to the number of Property Logs, and the progress bar may not be
noticed.
The Aspect Reference column of the Template rows on the Log Template sheet are filled
in by the tool, for use in subsequent commands.
As a result of this operation, a message will be created on the Message Sheet (Sheet
3). An example is shown in Figure 9.28.
3BUF001094-610 A 598
9 Reading and Managing Archive Data
9.8 Importing Archive Data
This displays the progress bar. Clicking Start initiates the process. Clicking Stop
terminates the process.
The Success / Attempts report cell beneath the Match Existing Archived Logs command
button shows how many archived log matches were successful out of those attempted.
Close the window to cancel at any time.
A log template will be created if a log template is not available for an archived log.
The Log Config Aspect GUID and Log ID GUID columns of the log rows on the Log List
sheet are filled in by the tool, for use in subsequent commands.
As a result of this operation, a message will be created on the Message sheet (sheet 3).
An example is shown in Figure 9.30.
Skip the Specify New Aspect Reference Data File step, since this information is
already specified and should not be changed.
3BUF001094-610 A 599
9 Reading and Managing Archive Data
9.8 Importing Archive Data
2. Click on the Start button of the progress bar. The tool creates an internal list of the
unfiltered (visible) log rows on the Log List sheet. The file path is indicated under
the Specify a New Aspect Reference Data File button.
3. When prompted to continue building the file (Building Aspect Reference File),
click OK.
The tool creates or locates the specified new AIP_INFO file. 800xA information for
each Log in the workbook is written to a new file using information stored in the
workbook. If an AIP_INFO file was included in the original Archive Volume, any
digital signature information for each log is copied from the old AIP_INFO file to the
new. The tool also updates the alternate AIP_INFO file path of the Volume
Configuration aspect.
A record of entries and log rows is kept in the report cell beneath the Create/Update
New Aspect Reference File button, Figure 9.31.
4. When the Operation Complete message appears, acknowledge the prompt by
clicking OK.
5. Once the AIP_INFO file is created, apply the changes by clicking Apply on the
Archive Volume config view, Figure 9.53.
6. When prompted to update the version on the server with the local copy (Update
Server?), click Yes. This will copy the new file to the correct location and set the
user available flag to TRUE (represented in Archive volume information).
3BUF001094-610 A 600
9 Reading and Managing Archive Data
9.8 Importing Archive Data
3BUF001094-610 A 601
9 Reading and Managing Archive Data
9.8 Importing Archive Data
2. View the archive data, Figure 9.33, from the log configuration aspect Status tab.
3BUF001094-610 A 602
9 Reading and Managing Archive Data
9.8 Importing Archive Data
When new entries are created on the second sheet, then retarget the template row
number of any logs on the first sheet that will be used.
Do not sort or rearrange the rows on the second sheet, unless care is taken to retarget
the template row numbers of all the logs on the first sheet that reference templates
that have new row numbers.
3BUF001094-610 A 603
9 Reading and Managing Archive Data
9.8 Importing Archive Data
3. The Object Names and Property Names on the Log List sheet may be modified.
The workbook has filled in default values based on a few simple patterns it can
recognize. If the workbook cannot recognize a pattern, it will fill in names that
incorporate the line number on the worksheet of the Log as it was loaded, just to
have unique Object Names.
If there is a better way to construct Object and Property Names from Archive Log
Names and Data Sources, then create an Excel formula and fill the Object Name
and Property Name cells with it (Table 9.35).
3BUF001094-610 A 604
9 Reading and Managing Archive Data
9.8 Importing Archive Data
=MID(A9,4,SEARCH(":",A9,4)-4)
and
=
MID(A9,SEARCH(":",A9,1)+1,SEARCH(":",A9,SEARCH(":",A9,1)+1)-SEARCH(":",A9,1)-1)
3BUF001094-610 A 605
3BUF001094-610 A 606
10 Reading Message Logs
10.1 Message Log Tables
When the system is equipped with the Information Management History Server function,
and the IMMSGLOG is configured, all system alarm/event messages will be forwarded
to the IMMSGLOG. The messages can be read through interactive dialogs in DataDirect
and Desktop Trends. Data can also be accessed using SQL queries. This section provides
guidelines for using SQL queries to read messages from this log.
3BUF001094-610 A 607
10 Reading Message Logs
10.1 Message Log Tables
MSGLOG
IDX LOCALTIME MESSAGE ETC...
17
18
19
20
MSGATTRS
IDX VALUE ETC... ATTRID
17 4
17 5
17 6
18 4
19 4
19 5
19 6
20 6
MSGVENDORS
6
7
Figure 10.1: Relationship Between Oracle Tables for Storing OPC Message Information
Vendor-specific attribute names are defined in the MSGVENDORS table, Table 10.3.
There is one such table on each Information Management server where the message
logs reside. The attribute names in this table are associated with their corresponding
attributes in the MSGATTRS table by an Attribute ID.
Attribute names for Batch Management are described in Table 10.4.
3BUF001094-610 A 608
10 Reading Message Logs
10.1 Message Log Tables
Attribute names for Audit Trail messages are described in Table 10.5.
3BUF001094-610 A 609
10 Reading Message Logs
10.1 Message Log Tables
3BUF001094-610 A 610
10 Reading Message Logs
10.1 Message Log Tables
3BUF001094-610 A 611
10 Reading Message Logs
10.2 Example Queries
10.2.1 Query for MSGLOG Table Name for PDL Message Logs
select o.object_name,m.table_name from object_table o,log_map_table m, numeric_attrib
n where o.object_type in (2,26) and o.object_id = n.log_id and o.object_name =
m.log_name and n.attrib_id = 108 and n.attrib_value in (2) order by o.object_id
NOTES:
object_type 2 = Runtime message logs
object_type 26 = Restored message logs
attrib_id 108 = message log type attribute in the numeric_attrib table
attrib_value 2 = OPC message log
3BUF001094-610 A 612
10 Reading Message Logs
10.3 System 800xA ATTVAL Oracle Function for IM Message Log
This query provides a listing of all OPC message logs and their respective MSGLOG
table names. Use the applicable table name(s) in the query below to get message text
and vendor-specific data for a specified time range.
3BUF001094-610 A 613
10 Reading Message Logs
10.3 System 800xA ATTVAL Oracle Function for IM Message Log
The value 49 in the preceding query comes from the LOGIDX index query.
3BUF001094-610 A 614
A Using Open Data Access
A.1 ODA for Real-time Data
This section provides guidelines and reference information for using Open Data Access
(ODA) to support real-time and historical data access for third-party applications such
as Crystal Reports.
ODA does not support the concept of transactions, commits, or rollbacks. The following
statements specifically CANNOT be used:
BEGIN TRANSACTION
COMMIT TRANSACTION
ROLLBACK TRANSACTION
The following topics are covered:
• ODA for Real-time Data on page 615.
• ODA for Historical Data Access on page 623.
• Accessing ODA Programmatically using ADO on page 647.
An Information Management Browser tool is provided to facilitate locating and selecting
OPC data points on the connected OPC server. The operation of this tool is described
in Information Management Browser on page 514.
3BUF001094-610 A 615
A Using Open Data Access
A.1 ODA for Real-time Data
If multiple properties are to be read from a group of objects of the same type, it will be
more efficient to use a custom table. Also, for security reasons, the generic_DA table is
read-only; configured tables must be used in order to modify any property values.
Configuring Open Data Access is an Information Management configuration topic.
3BUF001094-610 A 616
A Using Open Data Access
A.1 ODA for Real-time Data
3BUF001094-610 A 617
A Using Open Data Access
A.1 ODA for Real-time Data
• To get all configured properties from all objects of the type, and sort them
alphabetically.
SELECT * FROM ai
ORDER BY name
• To get all properties from several objects with related names, using LIKE and
wildcards.
SELECT * FROM ai
WHERE name LIKE ’ai%’
• To get a property from each child of a given object that has a given type (complex
query using join).
This assumes there is a table named Group defined for an object type whose
instances have AnalogInCC objects as children in the Control structure.
SELECT c.name, c.value FROM group AS p, ai AS c
WHERE p.name=’group1’
AND c.parent=p.id
• To set the value of one property in an object.
This requires the column to be configured as writable.
UPDATE ai SET value = 5 WHERE name = ‘ai1’
3BUF001094-610 A 618
A Using Open Data Access
A.1 ODA for Real-time Data
The Variant value is available from the Value column in the table. For ODBC, which does
not support Variants, the value is presented as a FLOAT, INTEGER, and VARCHAR in
the Value_Flt, Value_Int, and Value_Str columns respectively. The Value_Type column
indicates which of these best matches the actual data. For example, a real value 1.23
will appear in the three data types as 1.23, 1, and "1.23" respectively, but the first of
these is most accurate. Some values can not be converted, but will result in NULL in
one or more columns; for example, a string value of "12", or a numeric value of 12, will
appear correctly in all three types, but a string value of "A" or "" will produce nulls in the
two numeric types. A timestamp such as "2002-08-16 12:00:00.000" will appear as the
float 37484.5 (the way times are actually stored in the system, as a fractional number of
days), as the integer 37484 (just the number of days), and as the string "8/16/2002
12:00:00 AM" (the date string as converted within the server, following different rules
than those used by the SQL client).
Sample queries are demonstrated in Sample Queries for Generic_DA on page 620.
3BUF001094-610 A 619
A Using Open Data Access
A.1 ODA for Real-time Data
3BUF001094-610 A 620
A Using Open Data Access
A.1 ODA for Real-time Data
All keys (Name, Path, ID, and Object_Type, as well as Property) are case-insensitive,
so they need not be capitalized correctly in a WHERE clause as they are in these
examples.
• To get one property from one object.
SELECT value FROM generic_da
WHERE path='/My Objects/Object 1'
AND property='GENERAL PROPERTIES:PROPERTY1'
NOTE: This is an incomplete path.
SELECT value FROM generic_da
WHERE path='[Direct]Root/My Objects/Object 1'
AND property='GENERAL PROPERTIES:PROPERTY1'
NOTE[direct] ensures that the path is complete)
SELECT value FROM generic_da
WHERE name=' Object 1'
AND property='GENERAL PROPERTIES:PROPERTY1'
SELECT value FROM generic_da
WHERE id='{E8A75B02-E95E-4943-999D-2C4E266CE17C}'
AND property='GENERAL PROPERTIES:PROPERTY1'
SELECT value FROM generic_da
WHERE name=' Object 1'
AND property LIKE '%:property1'
NOTE: In order to omit the aspect name, wildcards are required.
• To get one property (and object name) from all objects of a type.
SELECT name, value FROM generic_da
WHERE object_type='My Object Type'
AND property='GENERAL PROPERTIES:PROPERTY1'
• To get value of all properties from one object.
SELECT property, value FROM generic_da
WHERE path='/My Objects/Object 1'
SELECT property, value FROM generic_da
WHERE name=' Object 1'
SELECT property, value FROM generic_da
WHERE id='{E8A75B02-E95E-4943-999D-2C4E266CE17C}'
3BUF001094-610 A 621
A Using Open Data Access
A.1 ODA for Real-time Data
3BUF001094-610 A 622
A Using Open Data Access
A.2 ODA for Historical Data Access
3BUF001094-610 A 623
A Using Open Data Access
A.2 ODA for Historical Data Access
Basics
ODA supports the SELECT statement including all its clauses (INTO, FROM, WHERE,
GROUP BY, HAVING, and ORDER BY).
It also supports INSERT and UPDATE statements.
Example
SELECT DataValue, Quality FROM NumericLog
WHERE LogName = 'TC100:VALUE,Log1'
AND Timestamp > '2000-10-15 08:00:00'
AND Timestamp <= '2000-10-15 09:00:00'
SQL queries are not case-sensitive, except for text in single quotes. SQL keywords
(for example select) can be written in uppercase or lowercase. The same is true for
table and attribute names. Object (log) names must be entered exactly as they were
configured.
The basic clauses are briefly described below.
3BUF001094-610 A 624
A Using Open Data Access
A.2 ODA for Historical Data Access
3BUF001094-610 A 625
A Using Open Data Access
A.2 ODA for Historical Data Access
Review the guidelines in this section, and then refer to the example queries shown in:
• Basic Query for Numeric Data on page 627.
• Query for Numeric Data from a Secondary Log on page 628.
• Query for a Specific Time Range on page 628.
• Query for Interpolative Data on page 628.
Aggregate
Either raw or interpolative data can be requested. If an aggregate is not specified, raw
data will be retrieved by default. The AIPHDA and IMHDA servers support different
aggregates. The AIPHDA aggregates are:
The aggregate lists for AIPHDA and IMHDA are subject to change. Obtain a definitive
list of aggregates currently supported on the system by executing the following query:
3BUF001094-610 A 626
A Using Open Data Access
A.2 ODA for Historical Data Access
Intervals
When the retrieval type is interpolated, the intervals variable establishes the time interval
between data values. The default interpolation interval is 1 second. Specify a different
interval as required. The interval unit is seconds. Enter the quantity as an integer. For
example to make the interpolation interval 5 seconds, set the Intervals attribute to 5.
Time Range
While a time range is not required in the query, it is recommended. If a complete time
range (with start and end time) is not specified, all data occurring within that time range
will be returned.
If a time range is not specified, or if an open-ended time range (just start time, or just
end time) is specified, all qualified data will be returned. It is not limited.
Timestamp Format
All timestamps must conform to the ANSI SQL-92 specification. This format is yyyy-mm-dd
hh:mm:ss[.fffffffff], where f is an optional up-to-nine digit parameter representing
nanoseconds.
In the following queries SQL keywords are shown in UPPERCASE for emphasis,
however, they can also be written in lowercase.
3BUF001094-610 A 627
A Using Open Data Access
A.2 ODA for Historical Data Access
Query:
SELECT LogName, Timestamp, DataValue, Quality
FROM NumericLog
WHERE LogName = ‘TC100:MEASURE,Log1’
Query:
SELECT LogName, Timestamp, DataValue, Quality
FROM NumericLog
WHERE LogName = ‘TC100:MEASURE,Log3’
Query:
SELECT Timestamp, DataValue
FROM NumericLog
WHERE LogName = ‘TC100:MEASURE,Log1’
AND Timestamp >=‘2001-02-15 13:34:00’
AND Timestamp <= ‘2001-02-15 13:37:00’
3BUF001094-610 A 628
A Using Open Data Access
A.2 ODA for Historical Data Access
The following example shows how to read interpolated values from a numeric log with
a one-minute time interval, and a time span of 12 hours. Note that the Aggregate and
Intervals in the where clause must be specified.
Query
SELECT Timestamp, DataValue
FROM NumericLog
WHERE LogName = ‘tc100:value,Log1’
AND Aggregate = ‘interpolative‘
AND Intervals = 60
AND Timestamp >=‘2001-02-15 8:00:00’
AND Timestamp <= ‘2001-02-15 20:00:00’
The INSERT and UPDATE functions only accept data quality in decimal format.
3BUF001094-610 A 629
A Using Open Data Access
A.2 ODA for Historical Data Access
These methods are only applicable for queries against the NumericLog table.
PPA Naming
With out any prefix, the IM HDA server supports any valid PPA OPC/HDA item ID for a
IM numeric log defined in system. If the item ID works for PPA OPC/HDA and item ID
points to a IM numeric log, it should work for IMHDA.
Examples:
[Control Structure]Root/Object1:Property1,Log1
Object1:Property1,Log1
{Object GUID}{Aspect GUID}:Property1,Log1
LOGMAN
LOGMAN uses the local log manager to access logs on any server with which the local
log manager can communicate. This is the only method that is used to use access name.
Use this method when the location of the log is not known or it is unimportant where the
log is located. This is the default if no prefix is specified.
Examples:
3BUF001094-610 A 630
A Using Open Data Access
A.2 ODA for Historical Data Access
'LOGMAN.$HSTC100,MEASURE-1-o'
'LOGMAN.TC100,MEASURE
'$HSTC100,MEASURE-1-o'
'TC100,MEASURE'
This method does not support UPDATE or INSERT statements in SQL queries.
EH
EH communicates with the local History server only. This is the fastest method and is
recommended when querying a log that resides on the local History server. The log
name must be used in conjunction with this prefix.
Example:
'EH.$HSTC100,MEASURE-1-o'
This method supports UPDATE statements in SQL queries. It does not support
INSERT statements.
EH_NET
EH_NET connects directly to a specified History server. This requires specifying the
node name or IP address. Use this method to query a log on a specific History server.
For example, use this when the system uses duplicate log names.
The log name must be used in conjunction with this prefix. The IP address is specified
by string IP followed by four sets of numbers separated by underscores (_).
Examples:
'EH_NET.eng130.$HSTC100,MEASURE-1-o'
'EH_NET.IP130_110_66_130.$HSTC100,MEASURE-1-o'
This method supports both UPDATE and INSERT statements in SQL queries.
3BUF001094-610 A 631
A Using Open Data Access
A.2 ODA for Historical Data Access
3BUF001094-610 A 632
A Using Open Data Access
A.3 ODA for Profile Data Access
3BUF001094-610 A 633
A Using Open Data Access
A.3 ODA for Profile Data Access
• Table A.5 - ProfileLogData Table - This table supports access to all data box values
for a given scan array.
– ODA supports SQL SELECT statements only for profile data access.
– Profile data access is via the IM HDA server. The ODA server must reside on
the same node as the IM HDA server.
3BUF001094-610 A 634
A Using Open Data Access
A.3 ODA for Profile Data Access
Queries
This query returns the valid range of indices for data boxes, as well as other information
stored in the ProfileLog table.
3BUF001094-610 A 635
A Using Open Data Access
A.4 Connecting Client Applications to an ODA Database
3BUF001094-610 A 636
A Using Open Data Access
A.4 Connecting Client Applications to an ODA Database
If creating the new report as a blank report, the Data Explorer is launched directly upon
making that selection.
3BUF001094-610 A 637
A Using Open Data Access
A.4 Connecting Client Applications to an ODA Database
3. If no tables are visible under ABBODA > SCHEMA, right-click ABBODA and select
Options menu to launch the Options dialog.
4. Select Tables under Data Explorer and click OK.
5. Click -/+ of the ABBODA connection to refresh and display the Tables.
6. Select one or more schemas that the report will access (the example in Figure A.6
shows BATCHTRENDs added):
a. Select a schema, then click Add. This adds the schema to the
Tables available for report list in the Report Expert, Figure A.6.
b. Repeat Step 6a for as many schemas as required, then click Close.
3BUF001094-610 A 638
A Using Open Data Access
A.4 Connecting Client Applications to an ODA Database
Use the Data Explorer to connect the subreport to LocalHost. Perform the following:
1. Click the +/- button next to ODBC, Figure A.7. This shows all ODBC DataSources
available on this computer.
3BUF001094-610 A 639
A Using Open Data Access
A.4 Connecting Client Applications to an ODA Database
2. Select the ODBC DataSource that supports the ADO data provider for Oracle access.
In this example, this datasource is named Localhost. Click Finish. This displays the
associated tables, views, and synonyms of the selected driver according to the
specified viewing options, Figure A.2. Filter this list to simplify the search for the
applicable synonym.
3. Right-click the localhost connection and select Options menu to display the Options
dialog.
4. Clear all Show options except Tables, Views and Synonyms , Figure A.8.
3BUF001094-610 A 640
A Using Open Data Access
A.4 Connecting Client Applications to an ODA Database
6. To apply these new explorer options, toggle (hide/show) the driver’s list. To do this,
go back to the -/+ button for the driver, click - to hide the view, and then click + to
re-show it. Now only Synonyms with the specified like string are listed under the
driver’s expanded view.
3BUF001094-610 A 641
A Using Open Data Access
A.4 Connecting Client Applications to an ODA Database
7. Expand History and select the PDL_TASK_VIEW, Figure A.3, then click >. This
adds the selected synonym to the list of tables (views and synonyms) available for
the report.
3BUF001094-610 A 642
A Using Open Data Access
A.4 Connecting Client Applications to an ODA Database
9. Click Finish to fetch the all available TaskID and TaskName Oracle database of a
particular node. An example of this result is shown in Figure A.5.
3BUF001094-610 A 643
A Using Open Data Access
A.4 Connecting Client Applications to an ODA Database
3BUF001094-610 A 644
A Using Open Data Access
A.4 Connecting Client Applications to an ODA Database
2. This launches the Create New Parameter dialog to create a variable. vartaskID is
the variable of type Number used in this example (Figure A.7).
3BUF001094-610 A 645
A Using Open Data Access
A.4 Connecting Client Applications to an ODA Database
3. Use the Select Expert > Record to set the TASKID field (from PDL_TASK_VIEW)
equal to the vartaskID parameter, Figure A.8. This directs the query to retrieve
batch data for a given TASK_ID specified via vartaskID. Click OK to close the
dialog.
4. To fetch the report data, Click F5 or Report > Refresh Report Data. This launches
the Enter Values dialog where a value for the parameter vartaskID is provided, as
shown in Figure A.9.
3BUF001094-610 A 646
A Using Open Data Access
A.5 Accessing ODA Programmatically using ADO
ODA does not support record-level locking of data, nor does it support transaction
handling such as Commits and Rollbacks.
The Provider is set to ABBOpenDataAccess. The Data Source is set to the ODA
database name, in this case: Database1.
Private Sub Command1_Click()
Dim adoconn As New ADODB.Connection
Dim i As Long
Dim query As String
Dim temp As String
On Error Resume Next
adoconn.ConnectionString = "DSN=ABBODA;Data Source=ABBODA"
adoconn.Mode = adModeRead
adoconn.Open , , , adOpenUnspecified
If Err.Number = 0 Then
Set rs = New Recordset
query = "select datavalue from numericlog where logname =
'SIN-000000:MEASURE,PPA'"
rs.CursorLocation = adUseClient
rs.CacheSize = 1000
rs.Open query, adoconn, adOpenForwardOnly, adLockOptimistic, adCmdText
If Not rs Is Nothing Then
If rs.RecordCount > 0 Then
formPopup.SetMax rs.RecordCount
i = 0
While Not rs.EOF
temp = rs("DataValue").Value
rs.MoveNext
Wend
End If
End If
End If
End Sub
3BUF001094-610 A 647
3BUF001094-610 A 648
B PDL for Batch Management
B.1 PDL Extractor
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 following sections provide guidelines and reference information for accessing PDL
and OPC message data for Batch Management.
3BUF001094-610 A 649
B PDL for Batch Management
B.3 Launching the PDL Extractor
1. Follow the installation procedures given in the installation wizard and install the PDL
Extractor.
PDL Extractor utility can be launched through: Program>ABB Industrial IT 800xA>
Production Mgmt - Batch> Utilities >PDL Batch Procedure Extractor
3BUF001094-610 A 650
B PDL for Batch Management
B.3 Launching the PDL Extractor
Select the ABB Batch Procedure Extractor to launch the PDL extractor.
3BUF001094-610 A 651
B PDL for Batch Management
B.4 Using PDL Extractor
3BUF001094-610 A 652
B PDL for Batch Management
B.4 Using PDL Extractor
2. Drill down to the last level until two recipes are listed as in Figure B.4.
3BUF001094-610 A 653
B PDL for Batch Management
B.4 Using PDL Extractor
3BUF001094-610 A 654
B PDL for Batch Management
B.5 Setting up PDL Extractor
3BUF001094-610 A 655
B PDL for Batch Management
B.5 Setting up PDL Extractor
3BUF001094-610 A 656
B PDL for Batch Management
B.6 Configuration Requirements for Batch Management
5. At the IM server side, set up a shared directory as well. For more information refer
to Setting Up Storage of Batch Procedures in PDL.
3BUF001094-610 A 657
B PDL for Batch Management
B.6 Configuration Requirements for Batch Management
3BUF001094-610 A 658
B PDL for Batch Management
B.6 Configuration Requirements for Batch Management
This policy is established as part of the Information Manager Archive server. To ensure
that the system has been configured properly, make sure to specifically define the
Batch/PDL archive configuration policy. Refer to the Configuring the Archive Function
Information (specifically PDL Archive Configuration) section in System 800xA Information
Management Configuration (3BUF001092*).
3BUF001094-610 A 659
B PDL for Batch Management
B.6 Configuration Requirements for Batch Management
The Information Management Browser is launched through the Windows Taskbar. Choose
ABB Start Menu > ABB System 800xA > Information Management > Utilities > and
select either IM User Tag Management or IM Structure Browser. For further information,
refer to Section 8 Tag Management.
3BUF001094-610 A 660
B PDL for Batch Management
B.6 Configuration Requirements for Batch Management
Figure B.12: Obtaining Log Name through the Information Management Browser
Logical Name and Item ID get mapped into the batch tables/views and the PDL Browser
as follows.
Logical Name is ASSOCIATIONNAME in the pdl_history_view, NAME in the
HISTORY_ASSOCIATIONS table and the HISTORY_ASSOC_OCC_xx tables, and
Access Name in the PDL Browser.
Item ID gets translated to the HDA item for the DA item. For example:
[Control Structure]root/object:property
3BUF001094-610 A 661
B PDL for Batch Management
B.6 Configuration Requirements for Batch Management
becomes:
[Control Structure]root/object :property,1s1d
where 1s1d is the IM log name on the property. This HDA item id then gets stored
as LOGNAME (not Logical Name) in the PDL view / tables and the PDL Browser.
The HDA Item ID stored in LOGNAME must be used to retrieve Numeric Data.
3BUF001094-610 A 662
B PDL for Batch Management
B.6 Configuration Requirements for Batch Management
3BUF001094-610 A 663
B PDL for Batch Management
B.6 Configuration Requirements for Batch Management
5. Check the check box Allow for Full control, Change and Read options.
The PDL Extractor can only be used for recipes from PDL that have not been restored.
3BUF001094-610 A 664
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 665
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
0 Campaign 10
1 Batch 11 12
A query can be written to access one or more tasks on one or more levels. Since only
campaigns and batches exist at fixed levels, the task type should generally be used as
the criteria for querying against different levels in the PDL hierarchy (for example, all
phases).
3BUF001094-610 A 666
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
The START WITH clause specifies the starting point for the query. In this case, the task
whose taskid = 16 will be the starting point. The CONNECT BY clause narrows the scope
of tasks to be returned by the query to those whose parentid = the prior taskid. The prior
taskid is set to the starting taskid. Thus the query will return data for all tasks in the
hierarchy of the task whose taskid = 16.
3BUF001094-610 A 667
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
parentid
history.pdl_task_view Batch Data
3BUF001094-610 A 668
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 669
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
In the SELECT clause, any attribute that occurs in only one view can be specified
using just the attribute name (for example variablevalue and variablename only occur
in the history,pdl_variable_view). Since taskname, occurrence, and taskname occur
in more than one view, they must be identified using the complete specification.
3BUF001094-610 A 670
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 671
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 672
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 673
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
The object name is the name of the 800xA object the log configuration aspect is on.
This view is a composite of the presrangemin, presrangemax, and engunit views.
These views are filled in from the attribute tables based on the information entered
on the log configuration presentation tab.
These Oracle views cannot be added to and are not available from ODA databases
such as Database1.
The numericlog2 table has one additional column named ObjectName. This allows the
object name to be returned in queries for history data when the object name is more
meaningful (easier to recognize) than the log name. The log name is still required in the
WHERE clause. For example: SELECT DataValue, ObjectName from NumericLog2
WHERE Logname = ‘$HSBrewkettle1:F1Level,tar188im’;
3BUF001094-610 A 674
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
The new oracle views need to be manually added to the oracle user. To do this:
1. Use Windows Explorer to find the oda_views.sql file.
a. Open an explorer window and enter %HS_SQL% in the address bar. This opens
the sql folder specified in the %HS_SQL% environment variable (c:\Program
Files (x86)\ABB Industrial IT\Inform IT\History\sql).
b. Find the oda_views.sql file in the sql folder.
2. Run the oda_views.sql file (reference Figure B.18):
a. From the 800xA Install User, Open a command prompt and enter:
sqlplus /@localhost
This starts an sqlplus session.
b. At the sql command prompt, enter @ then drag the oda_views.sql file onto the
command line and press Enter.
c. When the command prompt returns after creating the views, quit sqlplus.
Message Views
Three message views, the IMMSGLOGBYCAT, AUDIT_EVENT and the
MM_AUDITEVENTS views, are provided to make message reporting simpler.
The IMMSGLOGBYCAT view was created to easily get category name information. A
sample query would be:
Select message from immsglogbycat where eventcategory = 'category name';
3BUF001094-610 A 675
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 676
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 677
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 678
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 679
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 680
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 681
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 682
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 683
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 684
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 685
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 686
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 687
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 688
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 689
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 690
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 691
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 692
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 693
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 694
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 695
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 696
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 697
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 698
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 699
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 700
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 701
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 702
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
Unique trend AssociationNames (BMA Data Collect Logical Names) within a batch
will be enforced. If not unique, a second occurrence will be created. In this case, the
first stop trend will set the endtime for the first occurrence, the second stop trend will
set the endtime for the second occurrence etc. which may not be the matched pairs
of start and stop trend intended.
3BUF001094-610 A 703
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 704
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 705
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 706
B PDL for Batch Management
B.7 Accessing PDL Data (Using PDL Task ID)
3BUF001094-610 A 707
3BUF001094-610 A 708
C Using the IM OPC HDA Server
C.1 Accessing History Servers in Other Aspect Systems
The IM OPC HDA server is installed with the Information Management History Server
option and provides an alternative to the 800xA OPC HDA server for history access. It
is generally recommended that the 800xA OPC HDA server be used for historical data
access; however, it may be advantageous to use the IM OPC HDA server under some
circumstances. This section describes the potential benefits and limitations when using
the IM OPC HDA server.
To connect to the IM OPC HDA server, use the IMHDA data provider.
3BUF001094-610 A 709
C Using the IM OPC HDA Server
C.4 Direct Access to Trend Logs
3BUF001094-610 A 710
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 System 6.1 release October 2018
3BUF001094-610 A 711
3BUF001094-610 A 712
Index
Index
A Area Zoom, 319
A/E Linked Server Configuration, 129 Aspect
ABBArray, 274 A/E Linked Server Configuration, 129
ABBGetAttributes, 271 Action, Report, 419
ABBGetAttributeValue, 271 Action, Scheduler, 489
ABBGetHistory, 265 Archive Device, 521
ABBGetObj, 262 Archive Group, 529
ABBSql, 273 Archive Volume, 524
about button, 58 File Viewer, Report Template, 454
access name, 33 Inform IT History Control, 513
ACC Setup, 282 Inform IT History View Logs, 532
Action Aspect Inform IT History View PDL, 556
Report, 419 Inform IT History View Report Logs, 459, 534
Scheduler, 489 Report Preferences, 457
Active Zoom, 289, 291 Report Printing, 457
add-ins, 49, 53 Scheduled Job, 494
alarms/events Scheduling Definition, 475
Industrial IT dialog, 104 Start Condition, 484
aliases, 257, 259 Start Condition Expression, 485
Archive attribute, 343
delete restored logs, 572 attributes text file, 257, 284
device delay, 524 audit trail, 42
initialize media, 540 auto create, 252
Initialize Media, 540 autofit columns, 111, 238
Location, 536
Log Class, 460, 536 B
Log Name, 460, 536 Backward Scope, 321
Log Type, 536 batch to batch, 395
Number of Logs, 460, 536 Browser, 335
publishing, 561
Status, 460, 536 C
Archive Device, 521 calculation, 92, 169
Archive Group, 529 cell reference, 208
Archive Volume, 524 color, 299, 351
archiving communication settings
manual (on demand), 547 channel, 114, 246
restoring archived logs, 561, 566 port, 114, 246
3BUF001094-610 A 713
Index
3BUF001094-610 A 714
Index
3BUF001094-610 A 715
Index
3BUF001094-610 A 716
Index
3BUF001094-610 A 717
3BUF001094-610 A 718
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
3BUF001094-610 A