You are on page 1of 66

Aspen InfoPlus.

21

Database User's Manual

Version: 2006.5
October 2007
Copyright (c) 1999-2007 by Aspen Technology, Inc. All rights reserved.
InfoPlus.21, Aspen Process Explorer, Setcim, GCS, Scan.21, the aspen leaf logo and Plantelligence & Enterprise
Optimization are trademarks or registered trademarks of Aspen Technology, Inc., Cambridge, MA.
All other brand and product names are trademarks or registered trademarks of their respective companies.
This manual is intended as a guide to using AspenTech's software. This documentation contains AspenTech
proprietary and confidential information and may not be disclosed, used, or copied without the prior consent of
AspenTech or as set forth in the applicable license agreement. Users are solely responsible for the proper use of
the software and the application of the results obtained.
Although AspenTech has tested the software and reviewed the documentation, the sole warranty for the software
may be found in the applicable license agreement between AspenTech and the user. ASPENTECH MAKES NO
WARRANTY OR REPRESENTATION, EITHER EXPRESSED OR IMPLIED, WITH RESPECT TO THIS
DOCUMENTATION, ITS QUALITY, PERFORMANCE, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR
PURPOSE.
Aspen Technology, Inc.
200 Wheeler Road
Burlington, MA 01803-5501
USA
Phone: +(781) 221-4300
Toll Free: (1) (888) 996-7100

http://www.aspentech.com

Contents
1 Introduction .........................................................................................................1
The Manual ................................................................................................... 1
Organization........................................................................................ 1
Related Documentation ................................................................................... 2
Technical Support .......................................................................................... 2
2 Overview ..............................................................................................................3
InfoPlus.21 Setup Considerations ..................................................................... 3
Using the InfoPlus.21 Administrator to Manage InfoPlus.21 .................................. 4
Starting and Stopping InfoPlus.21 .................................................................... 4
InfoPlus.21 Classes ........................................................................................ 4
The Role of the System Administrator ............................................................... 5
Working with AspenTech Customer Support ....................................................... 5
Working with the AspenTech Engineering Services Group..................................... 6
Design Expertise .................................................................................. 6
Relational Database Development........................................................... 7
User Interface Design ........................................................................... 7
Configuration Services .......................................................................... 7
Connectivity ........................................................................................ 7
Installation and Upgrades ...................................................................... 7
Project Management ............................................................................. 7
3 The Standard InfoPlus.21 Tag Set ........................................................................9
Defining Custom Tag Types ............................................................................. 9
InfoPlus.21 Tag Types Overview....................................................................... 9
InfoPlus.21 Tag Fields Overview ......................................................................10
Basic Tag Fields ............................................................................................21
NAME ................................................................................................21
IP_DESCRIPTION ................................................................................21
IP_PLANT_AREA..................................................................................21
IP_VALUE_FORMAT .............................................................................21
Valid Input Limits ................................................................................22
Alarm Limits .......................................................................................22
Display Setup Tag Fields ................................................................................22
IP_GRAPH_ MAXIMUM and IP_GRAPH_MINIMUM .....................................22
IP_TREND_VIEW_TIME ........................................................................22
IP_ENG_UNITS ...................................................................................22
IP_STEPPED .......................................................................................23
Collected Data Display Fields ..........................................................................23
IP_VALUE, IP_VALUE_QUALITY, and IP_VALUE_TIME ...............................23
IP_ALARM_STATE................................................................................23
IP_ACKNOWLEDGE-MENT .....................................................................24

Contents

iii

IP_INPUT_VALUE, IP_INPUT_QUALITY, and IP_INPUT_TIME ......................24


History Repository Tag Fields ..........................................................................24
IP_ARCHIVING....................................................................................24
IP_HISTORY_STATUS ..........................................................................24
IP_REPOSITORY..................................................................................25
IP_DC_SIGNIFICANCE .........................................................................25
IP_DC_MAX_TIME_INT.........................................................................25
Data State Tag Fields.....................................................................................26
IP_HIGH_LIMIT and IP_LOW_LIMIT .......................................................26
IP_ALARM_FORMAT .............................................................................26
IP_LIMIT_DEADBAND ..........................................................................26
IP_MESSAGE_SWITCH .........................................................................27
SQLA Tag Fields ............................................................................................27
Configuring an SQLA Tag Record ...........................................................27
Configuring a Relational Database Table .................................................29
Configuring an SQLA Connection Record .................................................30
Upgrading to Aspen Process Explorer 2004 .............................................36
Upgrading to Aspen InfoPlus.21 2004.....................................................36
Repeat Area Tag Fields ..................................................................................37
IP_#_OF_TREND_VALUES ....................................................................37
IP_TREND_VALUE, IP_TREND_QLEVEL, IP_TREND_SEQ_#, IP_TREND_TIME,
and IP_TREND_QSTATUS .....................................................................37
4 InfoPlus.21 History Repository ..........................................................................39
About the InfoPlus.21 History Repository ..........................................................39
Using Multiple Repositories .............................................................................40
How Data Compression Works ........................................................................40
Modified Boxcar-Backslope Algorithm .....................................................40
Stepped Compression ..........................................................................42
Text Compression................................................................................42
How Tag Data is Processed by InfoPlus.21 ........................................................43
Information Collection..........................................................................43
Data Compression for Storage...............................................................43
Data Decompression for Trend Displays ..................................................44
Understanding InfoPlus.21 History Repository File Sets.......................................45
Understanding InfoPlus.21 Quality Status Codes and Quality Levels......................46
5 Glossary .............................................................................................................51
Index ....................................................................................................................59

iv

Contents

1 Introduction

The purpose of this manual is to provide a guide to working with the


InfoPlus.21 database and the standard InfoPlus.21 tag set.
Note: For more general information on how to set up and administer
InfoPlus.21, see the InfoPlus.21 Administration Help file, the InfoPlus.21
Database Developers Manual, and the InfoPlus.21 Installation Manual.

The Manual
Organization
This manual contains the following:
Chapter 1 Introduction provides a brief overview of the manual and a list
of related documentation.
Chapter 2 Overview presents a broad overview of the different aspects of
working with the InfoPlus.21 database.
Chapter 3 The Standard InfoPlus.21 Tag Set describes the standard
InfoPlus.21 tag set, which provides 5 pre-defined tag definition records for
setting up an InfoPlus.21 database.
Chapter 4 InfoPlus.21 History Repository provides background
information on how the InfoPlus.21 History Repository is organized and how
data is stored and retrieved.
Glossary provides a brief explanation of terms used throughout this
manual.

1 Introduction

Related Documentation
In addition to this manual, a number of other manuals are provided to help
users learn and use InfoPlus.21. The documentation set consists of the
following manuals:
InfoPlus.21 Installation Manual
InfoPlus.21 Database API Manual
InfoPlus.21 Database Developer's Manual
InfoPlus.21 Administration Help
InfoPlus.21 Administrator Help
InfoPlus.21 Definition Editor Help
DBC.21 Users Manual

Technical Support
AspenTech customers with a valid license and software maintenance
agreement can register to access the online AspenTech Support Center at:
http://support.aspentech.com
This Web support site allows you to:

Access current product documentation

Search for tech tips, solutions and frequently asked questions (FAQs)

Search for and download application examples

Search for and download service packs and product updates

Submit and track technical issues

Send suggestions

Report product defects

Review lists of known deficiencies and defects

Registered users can also subscribe to our Technical Support e-Bulletins.


These e-Bulletins are used to alert users to important technical support
information such as:

Technical advisories

Product updates and releases

Customer support is also available by phone, fax, and email. The most up-todate contact information is available at the AspenTech Support Center at
http://support.aspentech.com.

1 Introduction

2 Overview

The InfoPlus.21 database resides in memory and consists of a number of


different types of records and associated structures that are used to locate
and process the records. The database gathers process data from Cim-IO
interfaces and stores history in the InfoPlus.21 history repository.
Note: The maximum size limits for an InfoPlus.21 database are determined
by your license agreement.

In general, the maximum size for an InfoPlus.21 database is 128 million


words or 256MB. It can contain a maximum of 65,535 records.
Alternatively, starting with version 2006, a single InfoPlus.21 database
can now hold more than half a million database records, far more than the
previous limit of 65,535. This new capacity is a licensed feature. Aspen
InfoPlus.21 will allow the creation of a record id that exceeds 65,535 if the
license manager confirms the corresponding Enterprise Aspen InfoPlus.21
license key.

InfoPlus.21 offers you a spectrum of functionality in choosing how to set up


the database. InfoPlus.21 provides the standard InfoPlus.21 tag set, which is
a full set of record definitions for capturing and recording tag data.
InfoPlus.21 also supports custom record definitions.

InfoPlus.21 Setup
Considerations
The InfoPlus.21 Installation Manual provides step-by-step information on
installing and configuring InfoPlus.21. It describes how to install the
InfoPlus.21 software and covers important information on configuring
Windows NT or 2000 to run InfoPlus.21 efficiently.
Note: For more information on how to install, configure, and use your
system, see the InfoPlus.21 Installation Manual and the InfoPlus.21
Administration Help file.

2 Overview

Using the InfoPlus.21


Administrator to Manage
InfoPlus.21
The InfoPlus.21 Administrator allows users to explore and interact with local
and remote InfoPlus.21 systems. The InfoPlus.21 Administrator allows you to:

Search InfoPlus.21 databases for specific records

Retrieve database properties

Create new folders

Create and modify records

Add history repositories

Set history parameters

Add archives through the Windows Explorer application

Manage database and record access control lists

Set security

Activate audit trail generation

Note: For more information on using the InfoPlus.21 Administrator, see the
InfoPlus.21 Administration Help file and the InfoPlus.21 Administrator Help
file.

Starting and Stopping


InfoPlus.21
For information on starting and stopping an InfoPlus.21 database, see the
InfoPlus.21 Administration Help file.
Note: You cannot start InfoPlus.21 until you have set up a database group as
described in the InfoPlus.21 Installation Manual.

InfoPlus.21 Classes
AspenTech offers a wide variety of training on the InfoPlus.21 product family.
We provide system administrator, application developer, or end-user/operator
training either in one of our training facilities worldwide, or at your site.
Please check out our training offering at http://www.aspentech.com/ on the
Training web page.

2 Overview

The Role of the System


Administrator
The responsibilities of the system administrator vary from site to site
depending on the way InfoPlus.21 is used and the management resources
available.
In every case, there should always be a designated InfoPlus.21 system
administrator who has adequate training in Windows NT/2000 and InfoPlus.21
to perform this job. AspenTech requires that at least one person from your
organization take the InfoPlus.21 System Administrator Training class before
your system is installed.
Typical tasks for the system administrator include:

Managing computer system resources, security, and users

Assisting the AspenTech engineer during the installation of InfoPlus.21

Setting up and maintaining the InfoPlus.21 modules for the system

Installing InfoPlus.21 updates

Setting up and training new users

Answering user questions

Resolving problems that occur relating to InfoPlus.21

Protecting the security of the InfoPlus.21 data by making daily backups of


the active history file set and archival backups of completed file sets

Protecting the security of the InfoPlus.21 data by checking the file


systems for the history file sets to ensure that sufficient storage space is
always available

The InfoPlus.21 documentation set, together with AspenTech's System


Administrator's Training class, provides the foundation for accomplishing
those important tasks.

Working with AspenTech


Customer Support
AspenTech considers the system administrator a key person to the success of
InfoPlus.21. AspenTech Customer Support is committed to working with the
InfoPlus.21 system administrator as a partner from the initial installation to
day-to-day problem solving.
Customer Support engineers are available to answer questions and solve
problems. AspenTech is also willing to send an engineer to your site on a
time-and-cost basis if the need arises.
To assist Customer Support in giving you the best service, AspenTech has
developed the following guidelines for system administration:

2 Overview

Take the InfoPlus.21 Foundation class. This class teaches valuable


concepts and procedures that are needed to effectively administer an
InfoPlus.21 system.

Be sure to keep adequate software backups. At a minimum, make sure


that you take nightly backups of the active InfoPlus.21 history repository
file set and any files that have changed. Also, make archival backups of
each completed InfoPlus.21 history repository file set.
Note: For more information on creating backups, see the InfoPlus.21
Administration Help file.

Always check the documentation before doing a new procedure or one


that is not familiar.

Set up a procedure to have InfoPlus.21 users come to you with questions


and concerns.

Make sure that you have available a high-speed modem and internet
access in case you need to send files to Customer Support or a Customer
Support engineer needs to log onto your system.

Never delete an InfoPlus.21 file without first consulting AspenTech


Customer Support to make sure that it is not needed by the system.

If you become aware of a problem, when you start investigating it on your


own, be sure to write down each action you take and its result. If you
need help, call AspenTech Customer Support and give them all the
information that you have collected thus far.

If you have a problem with third-party software or hardware (for example,


Windows or a modem), that is not directly related to InfoPlus.21, call
Customer Support for the vendor of the software or hardware causing the
problem, not AspenTech Customer Support.

Working with the AspenTech


Engineering Services Group
The AspenTech Engineering Services Group is available to help you on a
contract basis with consulting that is beyond the scope of AspenTech
Customer Support. As described below, the Engineering Services Group can
offer your organization support in design expertise, relational database
development, user interface design, configuration services, connectivity,
installation and upgrades, and project management services.

Design Expertise
The Engineering Services Group has a great deal of experience in
requirements definition, functional design specification, detailed design
specification, and detailed interface specification. They are comfortable with
standard design methodologies, such as structured analysis, object-oriented
analysis, and RDBMS data modeling. Typical applications could be based on
Visual Basic, Delphi, C or C++.
In addition, they are capable of developing detailed FAT (Factory Acceptance
Test) and SAT (Site Acceptance Test) procedures that will ensure design
criteria are met.

2 Overview

Relational Database Development


The Engineering Services Group has developed many applications based on
relational databases, including lab systems, fault monitoring systems, batch
tracking systems, tank strapping charts, and quality monitoring and reporting
systems.
They have experience with the MS SQL Server tool kit, data analysis,
generation of entity-relationship diagrams, data modeling, schema design and
implementation, 3GL and 4GL design and development, Oracle, RDB and
database administration functions.
Additionally, the Engineering Services Group has developed many tools and
applications for the purpose of integrating our products with RDBMS data
stores used by many third-party products (LIMS, MRP, and Maintenance
Management Systems).

User Interface Design


The Engineering Services Group has experience in the development of custom
user interfaces and applications for cell-level supervisory control.

Configuration Services
The Engineering Services Group can provide configuration services such as
the creation of process graphics, trend pages, tag definition and generation,
and the establishment of SQC/SPC monitoring.

Connectivity
The Engineering Services Group can assist you in passing information to or
receiving information from other computers within your organization including
site-wide Intranet reporting applications. They can also assist in the
generation of web-based report applications as well. The Engineering Services
Group is skilled in using tools to construct low-cost interfaces to other
computer systems and in providing complete network and system consulting.

Installation and Upgrades


The Engineering Services Group can provide non-standard product
installations and upgrades for InfoPlus.21 and related layered products,
including interface installation.

Project Management
The Engineering Services Group can provide complete project management
services to ensure the delivery of a well controlled and on-schedule system.

2 Overview

2 Overview

3 The Standard InfoPlus.21


Tag Set

The standard InfoPlus.21 tag set provides 5 pre-defined tag definition records
for setting up an InfoPlus.21 database for process information management
and analysis. These are used with the Cim-IO interfaces.

Defining Custom Tag Types


The standard InfoPlus.21 tag set is intended to provide all the tag types that
are needed to perform process information retrieval and analysis. If the
requirements for your system cannot be met by the standard InfoPlus.21 tag
set, see the InfoPlus.21 Database Developers Manual for information on how
to define custom tag types.
When you set up the InfoPlus.21 database using the standard InfoPlus.21 tag
set, you must set up a tag for the following:

Every data point that you want InfoPlus.21 to collect from the process
equipment.

Every value that you want InfoPlus.21 to send to the process equipment.

Every value that you want InfoPlus.21 to calculate automatically.

Thus, you must set up a tag for each pressure, temperature, lab test, and
flow in the process before it can be collected, trended, controlled, or
analyzed.

InfoPlus.21 Tag Types


Overview
The next table lists each of the tag definition records in the standard
InfoPlus.21 tag set and the type of tag it can be used to create.

3 The Standard InfoPlus.21 Tag Set

Tags for Use Cim-IO Interfaces


Type

Description

Definition Record

SET

Values that are either manually


set or set by a client application

IP_SETDef

SQLA

A tag residing in a relational


database associated with
InfoPlus.21

IP_SQLADef

ANALOG

Analog values

IP_AnalogDef

DISCRETE

Discrete values

IP_DiscreteDef

TEXT
Text values
IP_TextDef
Tag Definition Records in the Standard InfoPlus.21 Tag Set

InfoPlus.21 Tag Fields


Overview
Each InfoPlus.21 tag type is based on a specific tag definition record in the
ip21tags.rld file. Many of the fields in the tag definition records are common
to two or more of the tag types. The next table contains a summary of the
InfoPlus.21 tag fields.
When you modify tags using the InfoPlus.21 Administrator, any change you
make does not take effect until you press Enter. Also note that until you
define the field IP_VALUE_FORMAT, you will not be able to define any of the
tag's numeric entry fields since IP_VALUE_ FORMAT defines numeric field
display format for the tag record.
Note: For information on how to add additional individual tags and make
changes to the tag fields, see the InfoPlus.21 Administration Help file.
Tag Field

Description

Tag Types

IP_#_OF_TREND_VALUES

Specifies the number of


occurrences of history that
should be kept in the
InfoPlus.21 database
memory-resident history
repeat area.

All tag types except


SQLA

This value must be a


positive integer.
If you want to save values
to history, it must be set to
at least 1.
If you want to save values
to history and you are using
COMPRESSION, this field
must be set to at least 2.
For more information, see
Repeat Area Tag Fields.

10

3 The Standard InfoPlus.21 Tag Set

Tag Field

Description

Tag Types

IP_ACKNOWLEDGEMENT

Records whether an alarm


state is acknowledged or
unacknowledged.

All tag types except


TEXT

This field does not require a


value at the time that the
tag is defined.
For more information, see
Collected Data Display
Fields.
IP_ALARM_FORMAT

Specifies the record


containing the alarm state
messages to be used by
IP_ALARM_ STATE.

All tag types except


SQLA and TEXT

For more information, see


Data State Tag Fields.
IP_ALARM_STATE

The state message that is


associated with the value
most recently received from
the process equipment.

All tag types except


SQLA and TEXT

This field does not require a


value at the time that the
tag is defined. It is filled in
and updates automatically
as the tag is used to gather
data.
The choices for
IP_ALARM_STATE are
defined by the selector
record specified by the field
IP_ALARM_FORMAT.
For more information, see
Collected Data Display
Fields.
IP_ARCHIVING

Turns on/off recording tag


data in the InfoPlus.21
history repository.

All tag types except


SQLA

For more information, see


History Repository Tag
Fields.
IP_COLUMN_NAME

Specifies the database


column where the SQLA
tag's name resides.

SQLA

IP_COLUMN_NAME is
optional. It may be up to 16
characters long and must
match the case of the
column name in the
relational database it
references.
For more information, see
SQLA Tag Fields.

3 The Standard InfoPlus.21 Tag Set

11

Tag Field

Description

Tag Types

IP_COLUMN_STATUS

Specifies the database


column where the SQLA
tag's status resides.

SQLA

IP_COLUMN_STATUS is
optional. It may be up to 16
characters long and must
match the case of the
column name in the
relational database it
references.
For more information, see
SQLA Tag Fields.
IP_COLUMN_TIME

Specifies the database


column where the SQLA
tag's timestamp resides.

SQLA

IP_COLUMN_TIME may be
up to 16 characters long
and must match the case of
the column name in the
relational database it
references.
For more information, see
SQLA Tag Fields.
IP_COLUMN_VALUE

Specifies the database


column where the SQLA
tag's values reside.

SQLA

IP_COLUMN_VALUE may be
up to 16 characters long
and must match the case of
the column name in the
relational database it
references.
For more information, see
SQLA Tag Fields.
IP_DBNAME

Specifies the database


name where an SQLA tag's
data resides.

SQLA

IP_DBNAME may be up to
30 characters long and
must match the case of the
name for the relational
database it references.
For more information, see
SQLA Tag Fields.
IP_DC_MAX_TIME_INT

The tag field


IP_DC_MAX_TIME_INT
specifies a maximum time
interval parameter that is
considered by the data
compression processing.

All tag types except


SQLA and TEXT

For more information, see


History Repository Tag
Fields.
12

3 The Standard InfoPlus.21 Tag Set

Tag Field

Description

Tag Types

IP_DC_SIGNIFICANCE

Specifies the minimum


amount that data for the
tag must change in order
for the change to pass the
compression software and
be recorded in the
InfoPlus.21 history
repository.

All tag types except


SQLA and TEXT

For analog tag values,


IP_DC_SIGNIFICANCE is a
4-byte real number that is
displayed using an F12.7
format.
For discrete tag values,
IP_DC_SIGNIFICANCE is a
32-bit signed integer that is
displayed using an I6
format.
For more information, see
History Repository Tag
Fields.
IP_DC_STATUS

Indicates the current state


of the boxcar/ backward
slope compression
calculation.

All tag types except


SQLA and TEXT

This field does not require a


value at the time that the
tag is defined. It is filled in
and updates automatically
as the tag is used to gather
data.
For more information, see
Collected Data Display
Fields.
IP_DESCRIPTION

Describes the tag.

All tag types

IP_DESCRIPTION may have


up to 32 characters.
For more information, see
Basic Tag Fields.
IP_ENG_UNITS

Specifies the label to use in


displays to define the units
for the tag (for example,
kg/sec).

All tag types


except TEXT

IP_ENG_UNITS is formatted
by a selector record called
ENG-UNITS.
For more information, see
Display Setup Tag Fields.

3 The Standard InfoPlus.21 Tag Set

13

Tag Field

Description

Tag Types

IP_GRAPH_MAXIMUM

Specifies the upper limit for


the normal value range for
the tag.
IP_GRAPH_MAXIMUM is
used for Process Explorer
and GCS trend display
default scaling and
exception deviation limit
calculations.

All tag types except


TEXT

IP_GRAPH_MAXIMUM
should be the normal high
value for the tag.
For more information, see
Display Setup Tag Fields.
IP_GRAPH_MINIMUM

Specifies the lower limit for


the normal value range for
the tag.
IP_GRAPH_MINIMUM is
used for Process Explorer
and GCS trend display
default scaling and
exception deviation limit
calculations.

All tag types except


TEXT

IP_GRAPH_MINIMUM should
be the normal low value for
the tag.
For more information, see
Display Setup Tag Fields.
IP_HIGH_ENTRY_LIMIT

Is used to set the highest


valid value for the tag. You
will not be able to input a
value for the tag that is
above
IP_HIGH_ENTRY_LIMIT.

SET

For more information, see


Basic Tag Fields.
IP_HIGH_HIGH_LIMIT

IP_HIGH_HIGH_LIMIT is
used to set the HIGH HIGH
alarm limit.

All tag types except


SQLA and TEXT

For more information, see


Basic Tag Fields.
IP_HIGH_LIMIT

Specifies the boundary


between the mid state and
high state for alarm state
monitoring.

All tag types except


SQLA and TEXT

IP_HIGH_LIMIT is used to
set the HIGH alarm limit.
For more information, see
Data State Tag Fields.

14

3 The Standard InfoPlus.21 Tag Set

Tag Field

Description

Tag Types

IP_HISTORY_STATUS

Displays the history storage


status for the tag.

All tag types except


SQLA

If IP_ARCHIVING is set to
ON, this field displays OK
when values can be written
to the InfoPlus.21 history
archive. It displays an error
message when values
cannot be written to the
InfoPlus.21 history archive.
If IP_ARCHIVING is set to
OFF, this field is blank.
This field does not require a
value at the time that the
tag is defined. It is filled in
and updates automatically
as the tag is used to gather
data.
For more information, see
History Repository Tag
Fields.
IP_INPUT_QUALITY

Displays the status for the


most recent value received
from the process
equipment.

All tag types except


TEXT

This field does not require a


value at the time that the
tag is defined. It is filled in
and updates automatically
as the tag is used to gather
data.
For more information, see
Collected Data Display
Fields.
IP_INPUT_TIME

Displays the timestamp for


the most recent value
received from the process
equipment.

All tag types except


SQLA

This field does not require a


value at the time that the
tag is defined. It is filled in
and updates automatically
as the tag is used to gather
data.
For more information, see
Collected Data Display
Fields.

3 The Standard InfoPlus.21 Tag Set

15

Tag Field

Description

Tag Types

IP_INPUT_VALUE

Displays the most recent


value received from the
process equipment.

All tag types except


SQLA

This field does not require a


value at the time that the
tag is defined. It is filled in
and updates automatically
as the tag is used to gather
data.
For more information, see
Collected Data Display
Fields.
IP_LIMIT_DEADBAND

Specifies the minimum


amount that data for the
tag must vary before
creating another alarm. This
field is intended to be used
to eliminate nuisance
alarms when a tag's value
is staying close to its upper
or lower alarm level.

All tag types except


SQLA and TEXT

For more information, see


Data State Tag Fields.
IP_LOW_ENTRY_LIMIT

Is used to set the lowest


valid value for the tag. You
will not be able to input a
value for the tag that is
below
IP_LOW_ENTRY_LIMIT.

SET

For more information, see


Basic Tag Fields.
IP_LOW_LIMIT

Specifies the boundary


between the mid state and
low state for alarm state
monitoring.

All tag types except


SQLA and TEXT

Used to set the LOW alarm


limit.
For more information, see
Data State Tag Fields.
IP_LOW_LOW_LIMIT

Used to set the LOW LOW


alarm limit.

All tag types except


SQLA and TEXT

For more information, see


Basic Tag Fields.

16

3 The Standard InfoPlus.21 Tag Set

Tag Field

Description

Tag Types

IP_MESSAGE_SWITCH

Turns on/off writing the


alarm state and alarm state
acknowledgment messages
to the log file.

All tag types except


TEXT

Setting
IP_MESSAGE_SWITCH to
ON causes all
IP_ALARM_STATE and
IP_ACKNOWLEDGEMENT
changes to be logged to the
log records specified in
IP_AlarmLogCntrl and
IP_AlarmAckCntrl. By
default both of these
records point to the log
record IP_LOG_RECORD.
For more information, see
Data State Tag Fields.
IP_PLANT_AREA

Identifies the plant area or


unit operation where the
tag is located.

All tag types

The choices for


IP_PLANT_AREA are defined
by the selector record
PLANT-AREAS.
For more information, see
Basic Tag Fields.
IP_REPOSITORY

Identifies the specific


InfoPlus.21 history
repository to use for storing
the tag's data.

All tag types except


SQLA

The choices for


IP_REPOSITORY are limited
to the repository or
repositories that you set up
for storing InfoPlus.21 data.
For more information, see
History Repository Tag
Fields.
IP_STEPPED

3 The Standard InfoPlus.21 Tag Set

Specifies the type of


compression used to record
incoming values.

All tag types except


TEXT

17

Tag Field

Description

Tag Types

IP_TREND_QLEVEL

Displays the quality level for


a tag value in the history
repeat area for a tag.

All tag types except


SQLA

This field does not require a


value at the time that the
tag is defined. It is filled in
and updates automatically
as the tag is used to gather
data.
Use the field
IP_#_OF_TREND_VALUES
to specify the number of
tag values that you want to
retain in the repeat area of
the InfoPlus.21 database.
For more information, see
Repeat Tag Area Fields.
IP_TREND_QSTATUS

Displays the quality status


for a tag value in the
history repeat area for a
tag.

All tag types except


SQLA and TEXT

This field does not require a


value at the time that the
tag is defined. It is filled in
and updates automatically
as the tag is used to gather
data. The source field from
the fixed area is
IP_VALUE_QUALITY.
Use the field
IP_#_OF_TREND_VALUES
to specify the number of
tag values that you want to
retain in the repeat area of
the InfoPlus.21 database.
For more information, see
Repeat Tag Area Fields.
IP_TREND_SEQ_#

Displays the sequence


number for the selected tag
value in the history repeat
area for a tag.

All tag types except


SQLA

This field does not require a


value at the time that the
tag is defined. It is filled in
and updates automatically
as the tag is used to gather
data.
For more information, see
Repeat Tag Area Fields.

18

3 The Standard InfoPlus.21 Tag Set

Tag Field

Description

Tag Types

IP_TREND_TIME

Displays the timestamp for


a tag value in the history
repeat area for a tag.

All tag types except


SQLA

This field does not require a


value at the time that the
tag is defined. It is filled in
and updates automatically
as the tag is used to gather
data.
Use the field
IP_#_OF_TREND_VALUES
to specify the number of
tag values that you want to
retain in the repeat area of
the InfoPlus.21 database.
For more information, see
Repeat Tag Area Fields.
IP_TREND_VALUE

Displays the tag value in


the history repeat area for a
tag.

All tag types except


SQLA

This field does not require a


value at the time that the
tag is defined. It is filled in
and updates automatically
as the tag is used to gather
data.
Use the field
IP_#_OF_TREND_VALUES
to specify the number of
tag values that you want to
retain in the repeat area of
the InfoPlus.21 real time
database.
For more information, see
Repeat Area Tag Fields.
IP_TREND_VIEW_TIME

Specifies the initial time


span from the beginning
time to the ending time for
GCS trend displays of the
tags values.

All tag types

For more information, see


Display Setup Tag Fields.
IP_VALUE

Specifies the value most


recently saved for the tag.

All tag types except


TEXT

This field does not require a


value at the time that the
tag is defined. It is filled in
and updates automatically
as the tag is used to gather
data.
For more information, see
Collected Data Display
Fields.

3 The Standard InfoPlus.21 Tag Set

19

Tag Field

Description

Tag Types

IP_VALUE_FORMAT

Defines the display format


to be used for the tag's
numeric fields.

All tag types except


TEXT

For analog tags the choices


for IP_VALUE_FORMAT are
limited to floating point
display formats.
For discrete tags, the
choices for
IP_VALUE_FORMAT are
limited to integer display
formats.
Until you enter a value for
this field, the numeric fields
for the tag show a line of
asterisks (*) and do not
allow you to enter a value.
For more information, see
Basic Tag Fields.
IP_VALUE_QUALITY

Indicates the status


associated with the most
recently saved value for the
tag.

All tag types except


TEXT

This field does not require a


value at the time that the
tag is defined. It is filled in
and updates automatically
as the tag is used to gather
data.
For more information, see
Collected Data Display
Fields.
IP_VALUE_TIME

Specifies the timestamp


associated with the most
recently saved value.

All tag types except


and TEXT

This field does not require a


value at the time that the
tag is defined. It is filled in
and updates automatically
as the tag is used to gather
data.
For more information, see
Collected Data Display
Fields.
NAME

Defines the tag name within


the InfoPlus.21 database.

All tag types

Each tag name must be


unique within any one
InfoPlus.21 database.
For more information, see
Basic Tag Fields.

20

3 The Standard InfoPlus.21 Tag Set

The rest of this chapter further describes each of the tag fields and how they
are related to other tag fields.

Basic Tag Fields


The basic tag fields are ones that are common to all or most of the tag types.
They fall into several general areas: tag name, tag description, value format,
type, plant area, and validity limits. Each of these areas is discussed in the
following sections.

NAME
NAME is the primary key to the tags data. Every tag must have a tag name.
Tag names may be up to 24 characters long and each must be unique within
each InfoPlus.21 database. Whenever you specify a tag name, you may type
the characters in upper or lower case. Tag names are not case sensitive.

IP_DESCRIPTION
The tag field IP_DESCRIPTION can be up to 32 uppercase or lowercase
characters. IP_DESCRIPTION is an informational field for tag displays and
should be set up for every tag in the InfoPlus.21 database.

IP_PLANT_AREA
The tag field IP_PLANT_AREA is intended to be used to classify tags by the
plant area or unit of operation where they are located. You are not required to
use IP_PLANT_AREA in this way, however. You may use it to group tags in
any way you choose.
IP_PLANT_AREA can be left undefined. It is not required. The choices for
IP_PLANT_AREA are set up in the selector record PLANT-AREAS.

IP_VALUE_FORMAT
The tag field IP_VALUE_FORMAT specifies the numeric display format to use
for the tag's numeric fields. For analog tags, the value format must be of the
form Fnnn.xxx where nnn is one plus the total number of digits in the display
and xxx is the maximum number of digits to the right of the decimal place in
the display.
For records defined by DiscreteDef types, you can set the value format to use
any of the integer format or selector records you choose. For example, setting
the value format to I6 will cause all values to be displayed in six-digit integer
format. Alternatively, setting the value format to OFF/ON will cause a value of
0 to be represented as OFF, and all values of 1 to be represented as ON.

3 The Standard InfoPlus.21 Tag Set

21

Valid Input Limits


The tag fields IP_HIGH_ENTRY_LIMIT and IP_LOW_ENTRY_LIMIT define
the range of valid values for SET tags. When entering data for a SET tag, you
will not be able to enter a value that is higher than IP_HIGH_ENTRY_LIMIT or
lower than IP_LOW_ENTRY_LIMIT.

Alarm Limits
Whenever a tag exceeds either the IP_HIGH_HIGH_LIMIT or the
IP_LOW_LOW_LIMIT, by definition, it enters the HIGHHIGH or LOWLOW
alarm state. When this happens, InfoPlus.21 indicates the alarm in the tags
IP_ALARM_STATE field and, if IP_MESSAGE_SWITCH is set to ON, it writes a
record of it to the alarm log.
You may set up the IP_HIGH_HIGH_LIMIT and IP_LOW_LOW_LIMIT values
for the all the tag types except SQLA and TEXT tags.

Display Setup Tag Fields


The display setup tag fields provide defaults for displaying the tags in client
programs.

IP_GRAPH_
MAXIMUM and IP_GRAPH_MINIMUM
InfoPlus.21 uses IP_GRAPH_MAXIMUM and IP_GRAPH_ MINIMUM to
define the default scaling values for plotting tag data on GCS trend displays.

IP_TREND_VIEW_TIME
The tag field IP_TREND_VIEW_TIME allows you to set up a default time span
for tags on GCS trend displays. For example, for a tag with
IP_TREND_VIEW_TIME set to 0002:00:00, the initial span of time for the tag
on a GCS display would be two hours worth of data.

IP_ENG_UNITS
IP_ENG_UNITS specifies the label to use in displays and reports to define the
units for the tag, e.g., kg/sec. IP_ENG_UNITS is used by all tag types except
TEXT tags. It is for display purposes only. It is not used for calculations in the
InfoPlus.21 database.
The choices for IP_ENG_UNITS are set up in the selector record ENG-UNITS.

22

3 The Standard InfoPlus.21 Tag Set

IP_STEPPED
IP_Stepped specifies the type of compression used to record incoming values.
By default, IP_STEPPED is set to Interpolated. When set to Stepped, the
stepped compression logic is enabled.
For more information, see How Data Compression Works, in the InfoPlus.21
History Repository chapter.

Collected Data Display Fields


The collected data display tag fields do not need to be filled in when you
define a tag. These fields are automatically filled in and updated as
InfoPlus.21 receives data from the Cim IO interface.

IP_VALUE, IP_VALUE_QUALITY, and


IP_VALUE_TIME

The tag field IP_VALUE displays the last value recorded for the tag in the
InfoPlus.21 history repository. IP_VALUE_TIME displays the timestamp for
the value and IP_VALUE_QUALITY displays its status. For a tag value to be
reported to the InfoPlus.21 history repository:
It must either exceed the compression limits set for it by
IP_DC_SIGNIFICANCE.

OR

The time that has elapsed since the last value was stored in the
InfoPlus.21 history repository must be more than the number of seconds
specified by IP_DC_MAX_TIME_INT.
The IP_VALUE, IP_VALUE_QUALITY, and IP_VALUE_TIME fields do not
require a value at the time that the tag is defined. They will be filled in
and updated automatically as the tag is used to gather data.

IP_ALARM_STATE
IP_ALARM_STATE displays the alarm state message when a tag goes into the
high, low, or mid state. The next table shows the possible values for
IP_ALARM_STATE for the tags in the standard InfoPlus.21 tag set. The
choices for IP_ALARM_STATE are defined by the selector record specified by
the field IP_ALARM_FORMAT.
Displayed
Value

Internal
Value

Description

HIGH HIGH

+2

VALUE above IP_HIGH_HIGH_LIMIT

HIGH

+1

VALUE above IP_HIGH_LIMIT

OK
LOW

3 The Standard InfoPlus.21 Tag Set

0
-1

VALUE between IP_HIGH_LIMIT and


IP_LOW_LIMIT
VALUE below IP_LOW_LIMIT

23

Displayed
Value

Internal
Value

Description

LOW LOW
-2
VALUE below IP_LOW_LOW_LIMIT
Possible values for IP_ALARM_STATE

IP_ACKNOWLEDGE-MENT
IP_ACKNOWLEDGEMENT allows an operator to acknowledge that a tag is in
an alarm state. It does not require a value at the time that the tag is defined.

IP_INPUT_VALUE, IP_INPUT_QUALITY,
and IP_INPUT_TIME
The tag field IP_INPUT_VALUE displays the last value reported by the
scanner system to the InfoPlus.21 database. IP_INPUT_TIME displays the
timestamp for the value and IP_INPUT_QUALITY displays its status.
The IP_INPUT_VALUE, IP_INPUT_QUALITY, and IP_INPUT_ TIME fields do not
require a value at the time that the tag is defined. They will be filled in and
update automatically as the tag is used to gather data.

History Repository Tag Fields


The history repository tag fields determine the repository to which the tag
data is sent and how much to allow data to change or how long to wait
between storing data points for the tags.

IP_ARCHIVING
IP_ARCHIVING turns on and off the recording of tag data in the InfoPlus.21
history repository. You must set up IP_ARCHIVING for all tag types except
SQLA tags.
If IP_ARCHIVING is set to OFF, the InfoPlus.21 database does not pass the
data to the history repository and does not read data from the history
repository.
If IP_ARCHIVING is set to ON, the InfoPlus.21 database passes the data to
the history repository.
If IP_ARCHIVING is set to PAUSE, the InfoPlus.21 database does not pass the
data to the history repository but does read previously stored data from the
history repository.

IP_HISTORY_STATUS
IP_HISTORY_STATUS displays the history storage status for the tag.

24

3 The Standard InfoPlus.21 Tag Set

If IP_ARCHIVING is set to ON, this field displays OK when values can be


written to the InfoPlus.21 history archive. It displays an error message when
values cannot be written to the InfoPlus.21 history archive.
If IP_ARCHIVING is set to OFF, this field is blank.
If IP_ARCHIVING is set to PAUSE, this field displays Paused when values
could be written to the InfoPlus.21 history archive (if IP_ARCHIVING was set
to ON).
This field does not require a value at the time that the tag is defined. It is
filled in and updates automatically as the tag is used to gather data.

IP_REPOSITORY
IP_REPOSITORY specifies the InfoPlus.21 history repository in which to store
the tag data. You may set up multiple history repositories. For more
information, see the InfoPlus.21 Administration Help file.

IP_DC_SIGNIFICANCE
IP_DC_SIGNIFICANCE specifies how much change to tolerate in the incoming
values. When an incoming value for a tag changes by more than
IP_DC_SIGNIFICANCE from the last value saved, it is stored in the
InfoPlus.21 history repository.
IP_DC_SIGNIFICANCE may be set up for all tag types except TEXT and SQLA.

IP_DC_MAX_TIME_INT
The tag field IP_DC_MAX_TIME_INT specifies a maximum time interval
parameter that is considered by the data compression processing.

3 The Standard InfoPlus.21 Tag Set

25

Data State Tag Fields


The data state tag fields set up the high and low boundary limits for tags and
display the tags state as data is gathered for it.

IP_HIGH_LIMIT and IP_LOW_LIMIT


The tag fields IP_HIGH_HIGH_LIMIT, IP_HIGH_LIMIT, IP_LOW_LIMIT, and
IP_LOW_LOW_LIMIT set boundary limits for tag alarming. The relationship
between the tag fields is specified as IP_HIGH_HIGH > IP_HIGH > IP_LOW >
IP_LOW_LOW.
Field Value

Alarm State

Value > HIGH_HIGH

Invalid high state

HIGH_HIGH > Value > HIGH

High state

HIGH > Value > LOW

mid state

LOW > Value > LOW_LOW

Low state

LOW_LOW > Value

Invalid Low state

When a tag enters the HIGH or LOW alarm state, InfoPlus.21 indicates the
alarm state in the tags IP_ALARM_STATE field and, if IP_MESSAGE_SWITCH
is set to ON, it writes a record of it to the alarm log.
InfoPlus.21 will change the state of an acknowledged alarm to UNACK when
the tag enters a more severe alarm state. When the transition from ACK to
UNACK occurs, the InfoPlus.21 database writes a summary line record to the
record specified by the IP_PIMSAckLine. The default record for
IP_PIMSAckLine is IP_UnackAlarmSummary.

IP_ALARM_FORMAT
IP_ALARM_FORMAT specifies the selector record to use for the alarm state
messages. All of the tags in the standard InfoPlus.21 tag set use the selector
record IP-ALARM_MESGS for the alarm state messages.
If you want to create different alarm states, you must do so by setting up a
custom selector record and a custom tag definition record to use it as
described in the InfoPlus.21 Database Developers Manual.

IP_LIMIT_DEADBAND
IP_LIMIT_DEADBAND specifies the minimum amount that data for a tag in an
alarm state must vary before creating another alarm. This field is useful for
eliminating nuisance alarms when a tags value is staying close to its upper or
lower alarm level.

26

3 The Standard InfoPlus.21 Tag Set

IP_MESSAGE_SWITCH
IP_MESSAGE_SWITCH turns on or off logging alarm state and
acknowledgment messages for a tag. The record IP_AlarmLogCntrl specifies
the log file to write to for alarm state records. The record IP_AlarmAckCntrl
specifies the log file to write to for acknowledgment records. The default
record for both IP_AlarmAckCntrl and IP_AlarmLogCntrl is IP_LOG_RECORD.

SQLA Tag Fields


Configuring an SQLA Tag Record
An SQLA tag is a special kind of record that contains references to process
history in a relational database (MS SQL Server or Oracle). An Aspen Process
Explorer user can view that process history by simply inserting a trend plot
for the desired SQLA tag.

Figure 1 - Example SQLA Tag Record

3 The Standard InfoPlus.21 Tag Set

27

SQLA tag records are defined by IP_SQLADef. An SQLA tag record contains
the following fields:
Field Name

Field Description

NAME

Name of this SQLA tag record.

IP_DESCRIPTION

Description of this SQLA tag record. Displayed on


Aspen Process Explorer legend.

IP_PLANT_AREA

Associates this SQLA tag record with a plant area.


Displayed on Aspen Process Explorer legend.

IP_ENG_UNITS

Engineering units of this SQLA tag record. Displayed


on Aspen Process Explorer legend.

IP_VALUE_FORMAT

Numeric display format used for


IP_GRAPH_MAXIMUM and IP_GRAPH_MINIMUM
fields.

IP_GRAPH_MAXIMUM

Default trend plot graph maximum used by Aspen


Process Explorer.

IP_GRAPH_MINIMUM

Default trend plot graph minimum used by Aspen


Process Explorer.

IP_STEPPED

Default trending mode used by Aspen Process


Explorer.

IP_COLUMN_NAME

Must either be blank or the name of a relational


database table column containing character string
data where each character string holds the name of
an SQLA tag record.

IP_COLUMN_STATUS

Must either be blank or the name of a relational


database table column containing integer numeric
data where each number represents a process
history quality status.

IP_COLUMN_TIME

Must specify a relational database table column


containing date/time data where each date/time
specifies the timestamp of a historical process value.

IP_COLUMN_VALUE

Must specify a relational database table column


containing numeric data where each number is a
historical process value.

IP_COLUMN_LEVEL

Must either be blank or the name of a relational


database table column containing integer numeric
data where each number represents a process
history quality level. (0 = Good; 1 = Suspect; 2 =
Bad)

IP_TABLE

Must specify a relational database table containing


the columns specified by IP_COLUMN_NAME,
IP_COLUMN_STATUS, IP_COLUMN_TIME, and
IP_COLUMN_VALUE.

IP_SQLA_CONNECTION

Must specify an SQLA connection record defined by


SQLConnectionDef.

IP_TAG_TYPE,

These fields should be left alone. They may be


removed in a future release.

IP_DBNAME,
IP_LOW_LOW_LIMIT,
IP_HIGH_HIGH_LIMIT,
IP_TYPE_NUMBER,

28

3 The Standard InfoPlus.21 Tag Set

Field Name

Field Description

IP_COLUMN_VALID

Configuring a Relational Database Table


An SQLA tag record contains an IP_DBNAME field that specifies a relational
database and an IP_TABLE field that specifies a table within that relational
database. Please consult appropriate Microsoft or Oracle documentation for
instructions on creating and configuring relational databases.
The relational database table referenced by an SQLA tag record could be
configured in several different ways.

SQLA tags sharing same data columns

SQLA tags having their own data columns

SQLA tags having their own data tables

The first approach is illustrated by a database table that contains the


following three columns:

LabName character string field specifying an SQLA tag record

LabTime datetime field specifying timestamp for the historical process


value specified in the LabValue field

LabValue numeric field specifying a historical process value at time


LabTime for the SQLA tag specified in the LabName field

LabName

LabTime

LabValue

Labdata01

8/13/2004 11:00:00am

63.0

Labdata02

8/13/2004 11:00:00am

75.4

Labdata01

8/13/2004 12:00:00am

47.8

Labdata02
8/13/2004 12:00:00am
Table for Labdata01 and Labdata02

40.35

The second approach is illustrated by a database table that also contains


three columns:

LabTime datetime field specifying timestamp for the historical values


specified in the Labdata01Value and Labdata02Value fields

Labdata01Value numeric field specifying the historical process value at


time LabTime for the Labdata01 SQLA tag

Labdata02Value numeric field specifying a historical process value at


time LabTime for the Labdata02 SQLA tag

LabTime

Labdata01Value

Labdata02Value

8/13/2004
11:00:00am

63.0

75.4

8/13/2004
47.8
40.35
12:00:00am
Table for Labdata01 and Labdata02

3 The Standard InfoPlus.21 Tag Set

29

Finally, the third approach is illustrated by creating a table for each SQLA tag.
LabTime

LabValue

8/13/2004 11:00:00am

63.0

8/13/2004 12:00:00am
Table for Labdata01

47.8

LabTime

LabValue

8/13/2004 11:00:00am

75.4

8/13/2004 12:00:00am
Table for Labdata02

40.35

Configuring an SQLA Connection Record


An SQLA connection record contains information that is used by InfoPlus.21
when establishing a connection to a particular relational database. By default,
an InfoPlus.21 will contain an SQLA connection record named Default SQLA
Connection. You will only need to create additional SQLA connection records
if you want to trend process history from multiple relational databases.
SQLA connection records are defined by SQLConnectionDef. Such a record
contains the following fields.
Field Name

Field Description

NAME

Name of this SQLA connection record.

IP_CONNECTION_STRING

Must contain a connection string generated by


the InfoPlus.21 Administrator.

IP_UTC_TIMESTAMP?

Should be No if timestamps in the relational


database should be considered as local times
(already adjusted for timezone and daylight
savings). Should be Yes if timestamps in the
relational database should be considered as UTC
times (Greenwich mean time).

IP_SCAN_FIRST,

Aspen Process Explorer asks InfoPlus.21 for


process history for a time window specified a
start time (T1) and end time (T2). It also needs
the process value just before T1 and the process
value just after T2. The algorithm for finding the
value just before T1 uses first, last, and factor
parameters as specified in the IP_SCAN_FIRST,
IP_SCAN_LAST, and IP_SCAN_FACTOR fields.
The first parameter specifies the number of
hours of process history prior to T1 that should
be searched to find the first process value prior
to T1 for a given SQLA tag. The factor
parameter specifies a multiplier to be applied to
the first parameter if the pre-T1 value is not
found during the first query. For example, if first
is set to 4 and factor is set to 2, then twice as

IP_SCAN_LAST,
IP_SCAN_FACTOR

30

3 The Standard InfoPlus.21 Tag Set

Field Name

Field Description
much data (8 hours worth) will be retrieved
prior to T1 during the second query. Each
subsequent query will retrieve double the
amount as the previous query until either the
required pre-T1 value is returned or the number
of hours specified by the last parameter has
been searched without successfully finding the
required pre-T1 value. As distributed, the
Default SQLA Connection record has an
IP_SCAN_FIRST of 2, an IP_SCAN_FACTOR of 2,
and an IP_SCAN_LAST of 65.

The IP_CONNECTION_STRING field must be configured with a connection


string generated by the InfoPlus.21 Administrator application.
Select the IP_CONNECTION_STRING field as illustrated in the Figure 2 below.

Figure 2 - Default SQLA Connection Record

Then, click the right mouse button to invoke the context menu. Selecting Edit
connection string from the context menu causes Data Link Properties
dialog box to appear as show below in Figure 3 or Figure 4.

3 The Standard InfoPlus.21 Tag Set

31

Figure 3 - Selecting Microsoft OLE DB Provider for SQL Server

32

3 The Standard InfoPlus.21 Tag Set

Figure 4 - Selecting Oracle Provider for OLE DB

In order to connect to an Oracle database, you should select Oracle provider


for OLE DB. This provider option is only available if you have installed Oracle
client software on your computer.
In order to connect to a Microsoft SQL Server database, you should select
Microsoft OLE DB Provider for SQL Server.
Then, click Next to configure connection information required by the selected
provider. For example, Figure 5 shows the connection information required for
Microsoft SQL Server. Note that its generally a good idea to test the
connection.

3 The Standard InfoPlus.21 Tag Set

33

Figure 5 - Connection Tab for Microsoft SQL Server

34

3 The Standard InfoPlus.21 Tag Set

Figure 6 - Connection Tab for Oracle RDBMS

Consult your database administrator when selecting a proper authentication


scheme. In Figure 5 above, the user has selected Use Windows NT
Integrated security. Be sure to select the Allow saving password check
box if you select the Use a specific user name and password instead as
shown in Figure 6.
Finally, click OK to dismiss the dialog after testing the connection. The
InfoPlus.21 Administrator will automatically write the generated connection
string to the IP_CONNECTION_STRING field of the SQLA connection record.

3 The Standard InfoPlus.21 Tag Set

35

Figure 7 - Configured SQLA Connection Record

Upgrading to Aspen Process Explorer 2004


Aspen InfoPlus.21 2004 can provide Aspen Process Explorer 2004, but not
earlier versions of Process Explorer, with requested SQLA tag process history.
So, if you use SQLA tags, you should upgrade your Aspen Process Explorer
client applications before upgrading your InfoPlus.21 server system.

Upgrading to Aspen InfoPlus.21 2004


SQLA connection records were introduced with Aspen InfoPlus.21 2004.
Earlier versions of Aspen InfoPlus.21 did not have SQLA connection records.
Furthermore, additional fields were added to the SQLA tag records in Aspen
InfoPlus.21 2004.
Therefore, you will need to upgrade your database snapshot before you can
use SQLA tags. You can invoke the Upgrade Database wizard from the Actions
menu of the InfoPlus.21 Manager application.
After converting your old database, the Upgrade Database wizard will assign
the Default SQLA Connection record to any existing SQLA tag records. It will
also configure the Default SQLA Connection record based on information it
finds in the now-obsolete c21_config.dat file.
Note: SQLA tags have been tested with Microsoft SQL Server 2000 (SP3) and
Oracle 9i (9.0.1).

36

3 The Standard InfoPlus.21 Tag Set

Repeat Area Tag Fields


The repeat area tag fields set up the display of data that has already been
stored in the InfoPlus.21 history repository (or that will be stored when
IP_ARCHIVING is set to ON).
Note: For more information on working with repeat areas, see the InfoPlus.21
Administration Help file.

IP_#_OF_TREND_VALUES
The tag field IP_#_OF_TREND_VALUES specifies the number of occurrences
of history that should be kept in the memory-resident history repeat area.
If you want to save values to history, it must be set to at least 1.
If you want to save values to history and you are using COMPRESSION, this
field must be set to at least 2.
The repeat area list of values remains blank if you do not specify a number
for IP_#_OF_TREND_VALUES.
The fields in the repeat area do not require a value at the time that the tag is
defined. They will be filled in and update automatically as the tag is used to
gather data.

IP_TREND_VALUE, IP_TREND_QLEVEL,
IP_TREND_SEQ_#, IP_TREND_TIME, and
IP_TREND_QSTATUS
The repeat area contains multiple occurrences of IP_TREND_VALUE,
IP_TREND_QSTATUS, IP_TREND_QLEVEL, and IP_TREND_TIME.
When you click on a specific value in the repeat area, the field
IP_TREND_SEQ_# displays the history sequence number assigned to it by the
InfoPlus.21 history repository. The field IP_TREND_QSTATUS corresponds to
the field IP_VALUE_QUALITY. It displays the status for the value. The field
IP_TREND_QLEVEL is derived from IP_VALUE_ QUALITY.
The table InfoPlus.21 quality statuses, quality level, and quality code, in the
InfoPlus.21 History Repository chapter of this manual, lists the possible
values for IP_TREND_QLEVEL and IP_TREND_QSTATUS.

3 The Standard InfoPlus.21 Tag Set

37

38

3 The Standard InfoPlus.21 Tag Set

4 InfoPlus.21 History
Repository

This chapter provides background information on the way that the InfoPlus.21
history repository is organized and how data is stored and retrieved. Its
purpose is to provide you with a conceptual framework to assist you in
determining how to set up the repositories and file sets for InfoPlus.21.

About the InfoPlus.21 History


Repository
Note: The InfoPlus.21 history repository is not a relational database.
As you read this chapter, keep in mind that each InfoPlus.21 history
repository is set up as a number of directories, which are usually referred to
as the file sets and sometimes referred to as the archives. Each file set has
three files:

key file

data file

long-record data file

The key file, which is called arc.key, is an index to the data records keyed by
the system-assigned tag ID numbers and the time.
The data file, which is called arc.dat, is a file of history records. Each history
record contains multiple history samples saved for the same tag. Each history
sample contains a timestamp having microsecond resolution, a key level, and
the other fields defined for the historical occurrence.

4 InfoPlus.21 History Repository

39

The long-record data file, which is called arc.byte, is a file that contains the
records for any data samples that are larger than 2048 bytes. For example, if
you have a text tag data sample that is 2056 bytes long, it will be written to
the arc.byte file.

Using Multiple Repositories


Note: The tag field IP_REPOSITORY determines which InfoPlus.21 repository
stores the data.
InfoPlus.21, as it is installed, provides a single history repository for storing
tag data. You may set up additional history repositories if you want to
separate the storage of InfoPlus.21 history data. For example, you may find it
useful to store the data for actively changing tags on a monthly basis and
store the data for slowly changing tags on a quarterly or annual basis. Or, you
may want to store the data required for government regulatory reporting in
one repository and the rest of the data in another.

How Data Compression Works


InfoPlus.21 represents the original samples sent to history with a reduced
number of timestamped events connected by straight lines. Samples that fall
within the specified limits you set on a tag-by-tag basis are not recorded. This
saves storage space without a loss of information.
There are 3 types of data compression logic used by the InfoPlus.21 history:

Modified Boxcar-Backslope algorithm

Stepped compression

Text compression

Modified Boxcar-Backslope Algorithm


The Modified Boxcar-Backslope algorithm checks each new event against four
criteria to determine whether or not data should be stored. The next figure
shows how the Modified Boxcar-Backslope algorithm works.

40

4 InfoPlus.21 History Repository

Modified Boxcar-Backslope Algorithm

IP21 obtains the maximum time interval from IP_DC_MAX_TIME_INT.

IP21 obtains the last recorded time from the first occurrence of
IP_TREND_TIME.

IP21 obtains the previous input value, previous input quality status, and
previous input time from IP_INPUT_VALUE. IP_INPUT_QUALITY, and
IP_INPUT_TIME.

IP21 obtains current compression status from IP_DC_STATUS.

IP21 obtains the user-specified recording limit parameter from


IP_SIGNIFICANCE.

IP21 updates IP_INPUT_VALUE, IP_INPUT_TIME, and IP_INPUT_QUALITY


with new data.

IP21 obtains the new input value, new input quality status, and new input
time from IP_INPUT_VALUE, IP_INPUT_QUALITY, and IP_INPUT_TIME

Data compression is disabled if the record limit parameter


(IP_SIGNIFICANCE) is undefined (displays questions marks). In that case,
IP21 historizes the new input value immediately; that is, it updates
IP_VALUE, IP_VALUE_QUALITY, and IP_VALUE_TIME with the new input
value, input quality status, and input time. This causes another occurrence to
shift into history
On the other hand, data compression is enabled if the recording limit
(IP_SIGNIFICANCE) is defined. In that case, IP21 may historize the previous
input value and possibly the new input value depending on the results of the
Quality Status Test, the Elapsed Time Test, and the Boxcar/Slope Test
described below.

Quality Status Test:


If the new input quality status differs from the previous input quality status,
then IP21 historizes the previous input value, input quality status, and input

4 InfoPlus.21 History Repository

41

time. Then IP21 historizes the new input value, input quality status, and
input time.

Elapsed Time Test:


The Elapsed Time Test is performed if the Quality Status Test did not result in
a recording.
IP21 calculates the difference between the new input time and the last
recorded time. If the maximum time interval exceeds zero but is less than
the calculated time difference, then IP21 historizes the previous input value,
input quality status, and input time.
Then IP21 calculates the difference between the new input time and the
previous input time. If the maximum time interval exceeds zero but is less
than the calculated time difference, then IP21 historizes the new input value,
input quality status, and input time.

Modified Boxcar/Slope Test:


The Boxcar/Slope Test is a variation of the boxcar with backward slope
compression method enhanced with spike detection. IP21 historizes the
previous input value, input quality status, and input time if it determines that
both the boxcar and back slope violations have occurred since the last
historization.
A boxcar test violation occurs when the difference between a new input value
and the last recorded value exceeds the user-specified recording limit
parameter.
In contrast, a backward slope violation occurs when the difference between a
new input value and the expected value exceeds the user-specified
recording limit parameter. The expected value is calculated by
extrapolating along a line drawn through previous values.
The proper selection of a recording limit parameter (IP_SIGNIFICANCE) is
important. If the parameter is too small, extraneous recordings are made. If
the parameter is too large, the compressed history may inadequately
represent the raw data stream.

Stepped Compression
Stepped compression is enabled by changing the IP_STEPPED field value from
Interpolated to Stepped. When this type of compression is used, whenever
a new incoming value exceeds the deviation limit or it exceeds the maximum
time interval, the system records the new value with the new timestamp.
That is, instead of creating a slope between points, Stepped compression
creates a stair step pattern between values.

Text Compression
With Text compression, the system will not record new incoming text data if
the current value is the same as the incoming data. If, however, the new
incoming text data is the same as the current value, but the time span

42

4 InfoPlus.21 History Repository

between the two values has exceeded the value specified in


IP_MAX_TIME_INT, a recording of the new text data will be made.

How Tag Data is Processed by


InfoPlus.21
When you look at an InfoPlus.21 data display, for example, an Aspen Process
Explorer trend display, the information you see for the current time and the
real-time updates to the display come from the InfoPlus.21 database. The
information you see for the past comes from the InfoPlus.21 history
repository and any relevant relational database.
Thus, you should keep in mind that three things might cause the data you see
on InfoPlus.21 displays to vary slightly from the data produced by the process
equipment.

Data is based on a series of scanned snapshots that are spaced apart by


the amount of time specified in the device tables.

Data coming from the InfoPlus.21 history repository might have been
compressed for storage and may vary from the original scanned data by
the compression limit set up for the tag in the InfoPlus.21 database.

The information that follows describes in more detail how these slight
differences could occur.

Information Collection
During operation, sensors gather data generated by the process equipment.
Depending on the nature of the sensor, this data may be available as
continuous information or individual samples.
The next figure shows, for a single tag, a comparison of the data the process
device generates and the data samples sent to the InfoPlus.21 database.

Process Data Generated

Data Points Reported by the Scan System


Comparison of data generated and data samples

Data Compression for Storage


Data compression is done on a tag-by-tag basis and is based on whether the
change from one sample to the next exceeds the compression limits set up

4 InfoPlus.21 History Repository

43

for the tag in the database. Thus, over a period of time, although the
scanners may have collected a number of samples for a tag, only the samples
that exceed the compression deviation limits are stored in the InfoPlus.21
history repository.
The next figure shows a comparison of the data samples collected and the
data stored in the InfoPlus.21 history repository after data compression.

Data Points Reported by the Scan System

Data Points Stored in the Repository

Comparison of data samples (pre and post data compression)

You control the limits the data compression software sets by the value you
specify for IP_DC_SIGNIFICANCE for each tag. For the tags that you need to
track closely, you can minimize or turn off compression to ensure that even
the slightest changes are saved. For other tags, you can use different
compression limits to save storage space without loss of information.

Data Decompression for Trend Displays


When data is displayed from the InfoPlus.21 history repository in Aspen
Process Explorer trend displays, the recorded points are connected with
straight lines and any periods of no data are indicated by a break in the line.
The next figure shows an example of the history data compression and the
corresponding trend display.

Data Points Stored in Repository

Aspen Process Explorer Trend Line


History data compression and the corresponding trend display

44

4 InfoPlus.21 History Repository

Understanding InfoPlus.21
History Repository File Sets
The InfoPlus.21 history repository is not a relational database. It is made up
of a number of file sets in separate directories. Each file set has a data file, a
long-record data file, and a companion key file. The files in a set always have
the names arc.dat, arc.byte, and arc.key.
Each file set holds all the data for a continuous period of time for all tags, for
example, from 10 December 97 11:27:45 to 15 Jan 98 05:34:32. There are
typically 10 to 20 file sets in an InfoPlus.21 repository with several days or
weeks of data in each set.
The next figure shows an example of the organization of an InfoPlus.21
history repository. In the example, there are seven file sets. File sets 1 and 2
are dismounted (D) and available for use. The history storage program will
shift to file set 1 when it completes storage to file set 7, which is currently the
active (MA) file set. File sets 3 through 7 are mounted (M) and have already
been used to store data. File set 3 has very old data and is mounted as
Reserved (I) so that it will not be overwritten.

Example of the organization of an InfoPlus.21 history repository

By definition, the file set in use for storing data is called the active file set. It
receives all the current data samples (although other file sets can also be
updated by edits or backdated events, for example, from delayed lab
samples). As data samples are stored, the active file set grows until it reaches
its size limit. The system then shifts into the next available file set. The
previously active file set becomes permanently bounded by the start and end
times of its active period. Normally there are no time gaps between file sets
except where old sets have been restored from an archive tape.
The arc.dat file contains variable length data records up to 64K bytes. Each
record contains multiple history samples saved for the same tag. Each history

4 InfoPlus.21 History Repository

45

sample contains a timestamp having microsecond resolution, a key level and


the other fields defined for the historical occurrence.
The records for a specific tag are linked together by pointers creating a
continuous time history. The size of the records is determined by the activity
of the tag. Active tags with many events are given larger, more efficient
records, while quiet tags have small records to minimize wasted space when
the file set shifts.
If it would take more than 2048 bytes to store any history sample, the actual
history data is stored in the arc.byte file while the history sample in the
arc.dat file contains a pointer to the history data sample stored in the
arc.byte file.
Note to application developers: When a history data sample is larger than
2048 bytes, and is consequently stored in the arc.byte file, data retrieval will
be much slower than with data samples smaller than 2048 bytes. The
retrieval time is extended because it is necessary to open, read, and close the
arc.byte file in order to get each data sample. If many large data samples are
to be read, this could add a noticeable amount of time to the data retrieval.
These additional file operations are not needed to retrieve data samples
smaller than 2048 bytes. For time-sensitive data retrieval, it is recommended
that data samples be smaller than 2048 bytes.
Because of the translation of database history occurrences to archived data
samples and the overhead information added to a data sample, the size of the
database history occurrences may need to be several bytes smaller than 2048
bytes in order to keep the archived data sample smaller than 2048 bytes. In
addition, because there are many variables in this process, it is difficult to
predict how large the archived data sample will be given a database history
occurrence. When developing larger history occurrences, it is recommended a
test record be created and connected to a test repository. If writing history to
the test record results in the arc.byte file increasing in size, then the archived
data sample is too large to be stored in the arc.dat file.
The key file (arc.key) is an index that has one entry for each data record in
the data file. The keys are the Tag ID, starting time, and ending time of the
corresponding records. The key file allows the system to go directly to the
correct starting record when the tag and time are given. After that, data
retrieval is a simple matter of reading linked records for the tag and jumping
across file set boundaries where necessary. To the client programs, for
example, the Aspen Process Explorer, it appears as one continuous, timebased record.

Understanding InfoPlus.21
Quality Status Codes and
Quality Levels
Every data point that is collected by a Cim-IO interface has an associated
InfoPlus.21 quality status.

46

4 InfoPlus.21 History Repository

When the data points are stored in the InfoPlus.21 history repository, they
are also assigned an InfoPlus.21 quality level based on their quality status.
For the standard InfoPlus.21 tag types, each entry consists of the tags name,
value, quality status, and quality level.
The next table lists the InfoPlus.21 quality statuses and their associated
quality level and quality code. It also lists the typical interface source using
the status code.
The InfoPlus.21 quality code descriptors are text strings that are provided to
make the numeric quality statuses easier to understand. These codes are set
up by the selector record QUALITY-STATUSES.
InfoPlu
s.21
Quality
Level

InfoPlus.21
Quality
Status

InfoPlus.21
Quality Status
Descriptor

Description

Interface
Source

Bad

-72

Inter

Batch interrupt

SCAN.21

Bad

-71

Bad High

Above valid upper


limit

SCAN.21

Bad

-70

Arc Off

Archiving is off

SCAN.21

Bad

-69

Bad Calc

Bad calculation

SCAN.21

Bad

-68

Bad Data

Process equipment
indicates that the tag
is bad

SCAN.21

Bad

-67

Bad Low

Below valid lower


limit

SCAN.21

Bad

-66

No Data

Process equipment is
not available

SCAN.21

Good

-65

Low

Below low state


boundary

SCAN.21

Good

-64

High

Above high state


boundary

SCAN.21

Suspect

-63

?-Low

Front end
questionable Low

SCAN.21

Suspect

-62

?-High

Front end
questionable high

SCAN.21

Good

-61

Man

Manual entry

SCAN.21

Good

-60

Man-Low

Manual entry low

SCAN.21

Good

-59

Man-High

Manual entry high

SCAN.21

Suspect

-58

NFP

Not from process

Cim-IO

Bad

-57

PTFP

Path to process failed

Cim-IO

Good

-56

CLPP

Clamped, windup plus

Cim-IO

Good

-55

CLPM

Clamped, windup
minus

Cim-IO

Suspect

-54

CND

Conditional

Cim-IO

Bad

-53

NRDY

Process IO not ready

Cim-IO

Bad

-52

Inval DT

Invalid data type


usage

Cim-IO

Bad

-51

DT not Sup

Data type not

Cim-IO

4 InfoPlus.21 History Repository

47

InfoPlu
s.21
Quality
Level

InfoPlus.21
Quality
Status

InfoPlus.21
Quality Status
Descriptor

Description

Interface
Source

supported
Bad

48

-50

Inavail

Data unavailable

Cim-IO

Suspect

-49

Questiona

Data questionable

Cim-IO

Suspect

-48

CAL/IOPM

Calibration, lower
limit input open

Cim-IO
Yokogawa
Interface

Suspect

-47

CAL/NEFV

Calibration, no
effective value

Cim-IO
Yokogawa
Interface

Bad

-46

CAL/NEFV/B

Calibration, No
effective value, data
bad

Cim-IO
Yokogawa
Interface

Bad

-45

CA/NE/IO/B

Calibration, no
effective data, lower
limit, input open, data
bad

Cim-IO
Yokogawa
Interface

Bad

-44

CAL/IOPM/B

Calibration, lower
limit input open, data
bad

Cim-IO
Yokogawa
Interface

Good

-43

Recovered

Recovered from
history

Cim-IO

Suspect

-42

Cannot Val

Cannot validate, data


questionable

Cim-IO

Suspect

-41

NCOM/QST

Communications
error, data
questionable

Cim-IO
Yokogawa
Interface

Bad

-40

NCOM/BAD

Communications
error, data bad

Cim-IO
Yokogawa
Interface

Good

-39

CAL

Calibration

Cim-IO
Yokogawa
Interface

Suspect

-38

NEFV/QST

No effective data,
data questionable

Cim-IO
Yokogawa
Interface

Suspect

-37

CAL/QST

Calibration, data
questionable

Cim-IO
Yokogawa
Interface

Suspect

-36

NEFV/CAL/Q

No effective data,
calibration, data
questionable

Cim-IO
Yokogawa
Interface

Suspect

-35

ServOff/Q

Service off, data


questionable

Cim-IO
Yokogawa
Interface

Bad

-34

ServOff/B

Service off, data bad

Cim-IO
Yokogawa
Interface

Suspect

-33

MAIN/QST

Maintenance, data

Cim-IO

4 InfoPlus.21 History Repository

InfoPlu
s.21
Quality
Level

InfoPlus.21
Quality
Status

InfoPlus.21
Quality Status
Descriptor

Description

Interface
Source

questionable

Yokogawa
Interface

Bad

-32

MAINT/B

Maintenance, data
bad

Cim-IO
Yokogawa
Interface

Bad

-31

IOP

Input open

Cim-IO
Yokogawa
Interface

Suspect

-30

IOPP

Upper limit input


open

Cim-IO
Yokogawa
Interface

Suspect

-29

IOPM

Lower limit input


open

Cim-IO
Yokogawa
Interface

Bad

-28

IOPP/BAD

Upper limit IOP bad

Cim-IO
Yokogawa
Interface

Bad

-27

IOPM/BAD

Lower limit IOP bad

Cim-IO
Yokogawa
Interface

Suspect

-26

OOP

Output open

Cim-IO
Yokogawa
Interface

Bad

-25

OOP/BAD

Output open, data


bad

Cim-IO
Yokogawa
Interface

Bad

-24

Undef Qual

Unknown quality
returned

Cim-IO

Suspect

-23

Clamped

The return value was


clamped

Cim-IO

Bad

-22

V.F. Undef

Value field undefined

Cim-IO

Bad

-21

Field Acc

Unable to access field

Cim-IO

Bad

-20

Tag Mism

Unmatched tag name

Cim-IO

Bad

-19

Setcim Err

InfoPlus.21 database
error

Cim-IO

Suspect

-18

WFAR

Wait for
asynchronous reply

Cim-IO

Bad

-17

Declare E

Declare error

Cim-IO

Bad

-16

Cancel E

Cancel error

Cim-IO

Bad

-15

Undef Val

Undefined value

Cim-IO

Bad

-14

Off

Device table is shut


down

SCAN/21

Bad

-13

Bad Tag

Bad tag

Cim-IO

Bad

-12

Req Failed

Request failed

Cim-IO

Bad

-11

E.U. Conv E

E.U. conversion error

Cim-IO

Bad

-10

Deadband E

Deadband check error

Cim-IO

4 InfoPlus.21 History Repository

49

InfoPlu
s.21
Quality
Level

InfoPlus.21
Quality
Status

InfoPlus.21
Quality Status
Descriptor

Description

Interface
Source

Bad

-9

Out Range

Value out of range

Cim-IO

Bad

-8

No Permiss

No permission

Cim-IO

Bad

-7

Async Off

Asynchronous reply
off

Cim-IO

Bad

-6

Bad

Value is bad

Cim-IO

Suspect

-5

Clamped Low

Value is clamped
against its low limit

Cim-IO

Suspect

-4

Clamped High

Value is clamped
against its high limit

Cim-IO

Suspect

-3

Suspect

Front end
questionable

SCAN/21

Good

-2

No Status

There is no status
associated with the
value

Cim-IO

Good

-1

OK

Good data

SCAN.21 or
Cim-IO

Good

Initial

Never input

SCAN/21 or
Cim-IO

InfoPlus.21 quality statuses, quality level, and quality code

50

4 InfoPlus.21 History Repository

5 Glossary

Active file set


The active file set is the history file set that is being used to store current
InfoPlus.21 data as it is gathered.

Arc.byte
The arc.byte files are the long-record files for the InfoPlus.21 history
repository.

Arc.dat
The arc.dat files are the data files of history records for the InfoPlus.21
history repository.

Arc.key
The arc.key files are the key files for the InfoPlus.21 history repository.

AspenTech Chemical Company


The AspenTech Chemical Company is a simulation that is provided as a
training database for your use in learning InfoPlus.21 concepts.

Batch.21
Batch.21 is the InfoPlus.21 batch tracking option. It keeps track of
manufacturing process information on a batch-by-batch basis. It records
batch events, batch characteristics, and trend data. Batch.21 data is stored in
a Microsoft SQL Server relational database.

Case
When referring to character strings, case is the distinction between uppercase
letters (A-Z), or lower case letters (a-z). Matching the case means typing a
string in upper and lowercase exactly as it was originally typed. Case folding
means that the computer converts the string entered to either all upper case
or all lower case.

5 Glossary

51

Cim-IO
Cim-IO is one of the two InfoPlus.21 scan systems. It updates the InfoPlus.21
database with process data obtained from local or remote Cim-IO interfaces.
A Cim-IO client task can request the information periodically or when some
special database event occurs. Cim-IO can also accept unsolicited data
received from some interfaces; that is, when the device has new data to be
sent.

Cim-IO InfoPlus.21 Interface


The Cim-IO InfoPlus.21 Interface serves data from a local InfoPlus.21
database to a remote Cim-IO client task. This allows information to be
transferred from one InfoPlus.21 database to another.

Cim-IO Interface
Cim-IO interfaces are available for various kinds of distributed control
systems (DCS) and programmable logic controllers (PCL). A Cim-IO interface
collects process data from a DCS or PLC and sends it to a local or remote
InfoPlus.21 database.

Client application
A program that sends requests to another program and awaits a response.

Compression Software
The compression software reduces the amount of data stored in the
InfoPlus.21 history repository. Only those values that are required to
accurately recreate the data as it originally occurred are sent to the
InfoPlus.21 history repository. The tolerance of the compression algorithm
can be configured on a tag-by-tag basis as part of each tag's definition in the
InfoPlus.21 database.

Environment variable
An environment variable can be any of a number of variables that describes
the way an operating system is going to run. The MS-DOS command to see
environment variable settings is set.

GCS
GCS is an InfoPlus.21 database client program that allows process graphics to
be created for subsequent viewing by a plant operator. GCS displays include
process graphics, current database values, trend plots, X-Y plots, and bar
charts. GCS communicates with a GCS database interface running on the local
or a remote InfoPlus.21 host.

InfoPlus.21 Database
The InfoPlus.21 database is a memory-resident database that consists of
records. Each record consists of named fields. Fields can be defined to hold

52

5 Glossary

integers, floating point values, character strings, scratchpad data (for


example, a byte string), timestamps, record IDs, or field IDs.
The structure and behavior of a record is defined by its definition record. The
name, data type, location, display format, and behavior of every field in a
record are also defined by its definition record. Generally, many records are
defined by the same definition record. You can create new record types by
creating new definition records.The fields within a record are grouped into
areas. A record consists of a fixed area and zero or more repeat areas. All the
fields within the fixed area have different names. In contrast, a repeat area
can contain multiple occurrences of the same fields. Each repeat are has an
associated repeat count field in the fixed area that indicates the number of
occurrences within the repeat area.
History is maintained for records that have one or more history repeat areas.
Tags are a special type of record. They hold the process values (for example,
temperatures, flows, etc.).

InfoPlus.21 History Repository


The InfoPlus.21 history repository is set up as a number of directories, which
are usually referred to as the file sets and sometimes referred to as the
archives. Each file set has three files a key file, a data file, and a longrecord data file.

InfoPlus.21 Manager
The InfoPlus.21 Manager administers the InfoPlus.21 database and its
associated tasks.

InfoPlus-X
InfoPlus-X provides an alternative set of predefined tags that can be used
instead of the standard INFOPLUS.21 tag set. The GCS-based InfoPlus-X
display console is the primary operator interface. The InfoPlus-X tags can also
be configured from the InfoPlus-X display console.

IP_ACKNOWLEDGMENT
The tag field IP_ACKNOWLEDGMENT records whether or not an alarm state is
acknowledged or unacknowledged.

IP_ALARM_FORMAT
The tag field IP_ALARM_FORMAT specifies the record containing the alarm
state messages to be used by IP_ALARM_ STATE.

IP_ALARM_STATE
The tag field IP_ALARM_STATE displays the state message that is associated
with the value most recently received from the process equipment.
This field does not require a value at the time that the tag is defined. It is
filled in and updates automatically as the tag is used to gather data.

5 Glossary

53

The choices for IP_ALARM_STATE are defined by the selector record specified
by the field IP_ALARM_FORMAT.

IP_ARCHIVING
The tag field IP_ARCHIVING turns on/off recording tag data in the InfoPlus.21
history repository.

IP_COLUMN_NAME
The tag field IP_COLUMN_NAME specifies the database column where the
SQLA tag names reside.

IP_COLUMN_STATUS
The tag field IP_COLUMN_STATUS specifies the database column where the
status of SQLA tags resides.

IP_COLUMN_TIME
The tag field IP_COLUMN_TIME specifies the database column where the
SQLA tag timestamps reside.

IP_COLUMN_VALUE
The tag field IP_COLUMN_VALUE specifies the database column where SQLA
tag values reside.

IP_DBNAME
The tag field IP_DBNAME specifies the database name where an SQLA tag's
data resides.

IP_DC_MAX_TIME_INT
The tag field IP_DC_MAX_TIME_INT specifies a maximum time interval
parameter that is considered by the data compression processing.

IP_DC_SIGNIFICANCE
The tag field IP_DC_SIGNIFICANCE specifies the minimum amount that data
for the tag must change in order for the change to pass the compression
software and be recorded in the InfoPlus.21 history repository.
For analog tag values, IP_DC_SIGNIFICANCE is a 4-byte real number that is
displayed using an F12.7 format.
For discrete tag values, IP_DC_SIGNIFICANCE is a 32-bit signed integer that
is displayed using an I6 format.

IP_DC_STATUS
The tag field IP_DC_STATUS indicates the current state of the
boxcar/backward slope compression calculation.

54

5 Glossary

IP_DCS_NAME
The tag field I_DCS_NAME specifies the name of the tag on the Distributed
Control System (DCS). IP_DCS_NAME may be up to 64 characters long.

IP_DESCRIPTION
The tag field IP_DESCRIPTION specifies the description for the tag.

IP_ENG_UNITS
The tag field units specifies the label to use in displays to define the units for
the tag (for example, kg/sec).
IP_ENG_UNITS is a selector record defined by the record ENG-UNITS.

IP_GRAPH_MAXIMUM
The tag field IP_GRAPH_MAXIMUM specifies the upper limit for the normal
value range for the tag. IP_GRAPH_MAXIMUM is used for GCS trend display
default scaling.

IP_GRAPH_MINIMUM
The tag field IP_GRAPH_MINIMUM specifies the lower limit for the normal
value range for the tag. IP_GRAPH_MINIMUM is used for GCS trend display
default scaling.

IP_HIGH_HIGH_LIMIT
The tag field IP_HIGH_HIGH_LIMIT for Cim-IO and all other interfaces sets
the tag state boundary between the HIGH and HIGH limits.

IP_HIGH_LIMIT
The tag field IP_HIGH_LIMIT specifies the boundary between the mid state
and high state for event state monitoring.
To eliminate the mid state for a tag, set IP_HIGH_LIMIT and IP_LOW_LIMIT
to the same value.

IP_HISTORY_STATUS
Displays the history storage status for the tag. If IP_ARCHIVING is set to ON,
this field displays OK when values can be written to the InfoPlus.21 history
archive. It displays an error message when values cannot be written to the
InfoPlus.21 history archive. If IP_ARCHIVING is set to OFF, this field is blank.

IP_INPUT_QUALITY
The tag field IP_INPUT_QUALITY displays the status for the most recent value
received from the process equipment.

5 Glossary

55

IP_INPUT_TIME
The tag field IP_INPUT_TIME displays the timestamp for the most recent
value received from the process equipment.

IP_INPUT_VALUE
The tag field IP_INPUT_VALUE displays the most recent value received from
the process equipment.

IP_LIMIT_DEADBAND
The tag field IP_LIMIT_DEADBAND specifies the minimum amount that data
for the tag must vary before creating another alarm. This attribute eliminates
nuisance alarms when a tag's value is staying close to its upper or lower
alarm level.

IP_LOW_LIMIT
The tag field IP_LOW_LIMIT specifies the boundary between the mid state
and low state for event state monitoring.
To eliminate a mid state for a tag, set IP_HIGH_LIMIT and IP_LOW_LIMIT to
the same value.

IP_LOW_LOW_LIMIT
The tag attribute IP_LOW_LOW_LIMIT for Cim-IO and all other interfaces sets
the tag state boundary between the LOW and LOW_LOW limits.

IP_MESSAGE_SWITCH
The tag field IP_MESSAGE_SWITCH turns on/off writing the alarm state and
alarm state acknowledgment messages to the log file.
Setting IP_MESSAGE_SWITCH to ON causes all IP_ALARM_STATE and
IP_ACKNOWLEDGEMENT changes to be logged to the log records specified in
IP_AlarmLogCntrl and IP_AlarmAckCntrl. By default both of these records
point to the log record IP_LOG_RECORD.

IP_PLANT_AREA
The tag attribute area identifies the plant area or unit of operation where the
tag is located. It is used in Event.21 for filtering event data by area and
assigning key values to events.

IP_REPOSITORY
The tag field IP_REPOSITORY identifies the specific InfoPlus.21 history
repository to use for storing the tag's data.
The choices for IP_REPOSITORY are limited to the repository or repositories
that you set up for storing InfoPlus.21 data.

56

5 Glossary

Mounted file set


A file set in the InfoPlus.21 history repository with the status of mounted is
one that is available for viewing and reading data. A file set with the status in
use and mounted, can be viewed and written to, but not shifted into.

NAME
The tag field NAME defines the tag name. NAME can be a string of up to 24
alphanumeric characters. You can use the period (.), pound sign (#),
underscore (_), and hyphen (-) characters within the NAME. The characters in
NAME are not case sensitive.

Q
Q is the InfoPlus.21 quality control option. It allows statistical alarms to be
generated for process data as it is collected. Q provides control charts,
histograms, and pareto charts.

Relational database
A relational database is an industry standard database structure in which
information is held in tables of rows and columns. Relationships can be
defined between the information in different tables. Relational databases are
extremely flexible in the way they store and retrieve information. They permit
complicated queries of the information they contain using SQL, Structured
Query Language.

Sample
A sample is a single data point. It may refer to an interpolated value or to a
historized point.

SET
The tag type SET is used to record values that are either manually set or set
by the output from a client application.

Shift file sets


Within the InfoPlus.21 history repository, the active file set is the one that is
storing data as it comes from the scan server. To shift file sets means to
switch the active flag from one file set to another file set, closing the file set,
opening another file set, and starting data storage in that file set. This entire
process happens automatically when the active file set reaches either its
threshold capacity or its time limit. This process can also be performed
manually. (For more information, see the InfoPlus.21 Administration Help
file.)

SQLA tag
The tag type SQLA is used to view data in a relational database through a tag.

5 Glossary

57

SQLplus
SQLplus is the InfoPlus.21 SQL command language option. It provides a tool
set for searching and manipulating the InfoPlus.21 database.

Status
Every data point that is collected by a Cim-IO interface has an associated
InfoPlus.21 quality status.
When the data points are stored in the InfoPlus.21 history repository, they
are also assigned an InfoPlus.21 quality level based on their quality status.
For the standard InfoPlus.21 tag types, each entry consists of the tags name,
value, quality status, and quality level.
The InfoPlus.21 quality codes are text strings that are provided to make the
numeric quality statuses easier to understand. Those codes are set up by the
selector record QUALITY-STATUSES
The table InfoPlus.21 quality statuses, quality level, and quality code, in the
InfoPlus.21 History Repository chapter of this manual, lists the InfoPlus.21
quality statuses and their associated quality level and quality code.

WYSIWYG
WYSIWYG is an acronym applied to word processors that stands for "what you
see is what you get."

58

5 Glossary

Index

Acknowledgement
of alarms 0-24
Alarm states 0-23
Alarms
logging messages 0-27
tag field 0-26
ANALOG tags
fields for 0-10
Area 0-21
AspenTech
customer Support 0-5
engineering services 0-6
AspenTech support 0-2
AspenTech Support Center 0-2

Defaults
timespan 0-22
Description 0-21
DISCRETE tags
fields for 0-10
Documentation, related 0-2

B
Backslope 0-40
Backup
files that need backups 0-6
Boxcar 0-40
C
Changing
status codes 0-47
CIM-IO
tag types for 0-10
Classes 0-4
Compression
how data is stored 0-40
how data is uncompressed 0-43
tag field 0-25
Custom tag types 0-9
customer support 0-2

Index

E
e-bulletins 0-2
Engineering Services Group 0-6
Engineering units 0-22
F
Fields
required by tag type 0-9
H
Help
customer support 0-5
engineering services 0-6
help desk 0-2
History file sets
overview of 0-45
History repositories
how compression works 0-40
HISTORY/21
tag fields 0-24
I
InfoPlus.21
Setup considerations 0-3
InfoPlus.21 tag set
fields for 0-10

59

IP_#_OF_TREND_VALUES 0-10, 037


IP_ACKNOWLEDGEMENT 0-11
IP_ACNOWLEDGEMENT 0-24
IP_ALARM_FORMAT 0-11, 0-26
IP_ALARM_STATE 0-11, 0-23
IP_ARCHIVING 0-11
IP_COLUMN_NAME 0-11
IP_COLUMN_STATUS 0-12
IP_COLUMN_TIME 0-12
IP_COLUMN_VALUE 0-12
IP_DBNAME 0-12
IP_DC_MAX_TIME_INT 0-12
IP_DC_SIGNIFICANCE 0-13, 0-25
IP_DC_STATUS 0-13
IP_DESCRIPTION 0-13, 0-21
IP_ENG_UNITS 0-13, 0-22
IP_GRAPH_MAXIMUM 0-14
IP_GRAPH_MINIMUM 0-14
IP_HIGH_HIGH_LIMIT 0-14, 0-22
IP_HIGH_LIMIT 0-14, 0-26
IP_HISTORY_STATUS 0-15, 0-24
IP_INPUT_QUALITY 0-15, 0-24
IP_INPUT_TIME 0-15, 0-24
IP_INPUT_VALUE 0-16, 0-24
IP_LIMIT_DEADBAND 0-16, 0-26
IP_LOW_LIMIT 0-16, 0-26
IP_LOW_LOW_LIMIT 0-16, 0-22
IP_MESSAGE_SWITCH 0-17, 0-27
IP_PLANT_AREA 0-17, 0-21
IP_REPOSITORY 0-17, 0-25
IP_STEPPED 0-17
IP_TREND_QLEVEL 0-18, 0-37
IP_TREND_QSTATUS 0-18, 0-37
IP_TREND_SEQ_# 0-18, 0-37
IP_TREND_TIME 0-19, 0-37
IP_TREND_VALUE 0-19, 0-37
IP_TREND_VIEW_TIME 0-19, 0-22
IP_VALUE 0-19
IP_VALUE_FORMAT 0-20, 0-21
IP_VALUE_QUALITY 0-20
IP_VALUE_TIME 0-20

Tag state
messages 0-26
tag fields 0-26
Tags
determining range for good
versus invalid status 0-26
display setup 0-22
fields for InfoPlus.21 tags 0-10
name 0-21

Main tag types 0-9


Messages
for tag states 0-26
N
NAME 0-20, 0-21

60

Organization of manual 0-1


Overview of manual 0-1
P
Plant area 0-21
R
Records
contents of 0-45
Related documentation 0-2
Repeat area
for tags 0-37
Repositories
tag field 0-25
Responsibilities of the system
administrator 0-5
S
SET tags
fields for 0-10
Setup considerations 0-3
SQLA tags
fields for 0-10
Starting
InfoPlus.21 0-4
Status codes
making changes to 0-47
overview of 0-47
Stop
InfoPlus.21 0-4
support, technical 0-2
System administration
and AspenTech customer support
0-5
System administrator
responsibilities 0-5
typical tasks 0-5
T

Index

value display format 0-21


technical support 0-2
Technical support 0-5
TEXT tags
fields for 0-10
Third party software
support of 0-6
Timespan
default 0-22
Training 0-4
Trend values 0-11
Troubleshooting
arc off (-7) status 0-24
status code not correct 0-47
U
Units 0-22
V
Value
last reported 0-24
W
web site, technical support 0-2

Index

61

62

Index

You might also like