Using ENVOXâ Configuration

Software

This manual applies to ENVOX software version P3.4 only. Retain

and use previous revisions of this manual for earlier versions of
ENVOX software.

See subsection 1.3 for a description of the enhancements made

to ENVOX software, version P3.4.
D2U00481802

User Manual
UM6.1:SW3151
Revision H — July 1996
This manual supercedes the issue dated June 1995.
ENVOX,, PROFLEX, PROVOX, and PROVUE are marks of one of the Fisher-Rosemount group of
companies.
All other marks are the property of their respective owners.

ã Fisher-Rosemount Systems, Inc. 1990—1996. All rights reserved.

Printed in USA

The contents of this publication are presented for informational purposes only, and while every effort
has been made to ensure their accuracy, they are not to be construed as warranties or guarantees,
express or implied, regarding the products or services described herein or their use or applicability. We
reserve the right to modify or improve the designs or specifications of such products at any time without
notice.
 Your Evaluation Please . . .

Name: Title and Department:

Company: Years of Experience: ___ Instrumentation ___ Distributed Control

Telephone: ( ) -- Education: ____High School ____Years College ____Degree

Job Responsibility:

Please indicate your evaluation of UM6.1:SW3151 (Revision H — July 1996). Attach extra sheets if needed.
1. How and when do you use this manual? V Read entire manual before attempting task
V Read selected sections before attempting task
V Read while attempting task
V Attempt task first
V Read as last resort
2. How well is the manual’s content V Excellent — parallels product’s operation,
organized? Please explain. very usable
V Good — representative of the product’s
operation, usable
V Average — usable but can be improved
V Fair — not very usable, should be improved
V Poor — not usable, must be improved
V No Opinion
Understandable Applicable
3. Is the manual’s content understandable V V Excellent — very easy to understand,
and applicable to the product’s operation? very applicable
Please explain. V V Good — easy to understand, applicable
V V Average — applicable but some sections
not easy to understand
V V Fair — not very understandable/applicable,
should be improved
V V Poor — not understandable/applicable,
must be improved
V V No Opinion
4. How well do the manual’s illustrations V Excellent — very easy to understand, extremely
convey product information? usable
Please explain. V Good — easy to understand, very usable
V Average — fairly easy to understand, usable
V Fair — not easy to understand, should be
improved, not very usable
V Poor — cannot understand, must be improved,
totally unusable
V No Opinion
5. Describe the amount of usable information V Too much information — not all required to
in this manual including tables. perform task
Please explain. V Proper amount provided — not too much nor
too little
V Too little information — needed additional
information to perform task
V No Opinion
Sections Index

6. How well is information cross-referenced in V V Excellent — very easy to locate

the manual’s individual sections and index? information, extremely usable
Please explain. V V Good — easy to locate information,
very usable
V V Average — fairly easy to locate information,
usable
V V Fair — not easy to locate information,
should be improved, not very usable
V V Poor — cannot locate information, must be
improved, totally unusable
V V Did Not Use
V V No Opinion
7. How useful is the Glossary? V Useful
V Useful but not complete/accurate
V Not Useful
V Did Not Use
V No Opinion
8. What is your overall impression of this V Excellent — met all needs, extremely usable
manual? Please explain. V Good — met most of my needs, very usable
V Average — usable
V Fair — should be revised, not very usable
V Poor — must be revised, totally unusable
V No Opinion

Please FAX or MAIL this form to: Fisher-Rosemount Systems, Inc.

Technical Documentation Editor
FAX Number: (512) 834-7200 8301 Cameron Road, MD#12
Attention: Technical Documentation Editor Austin, TX 78753
FISHER-ROSEMOUNT USE ONLY — forwarded to:
V Lead Writer V Engineering V Technical Support V Marketing V Project File
 Documentation Map

Documentation Map
Using ENVOXâ Configuration Software
This map shows this manual and other ENVOX manuals available for ENVOX
configuration software, version P3.4. Related documentation is listed in
subsection 1.8. See the Document History list at the back of this manual for
manuals available for previous ENVOX software versions.

PN6.1:SW3151:VMS
Installing ENVOX Configuration Software
PN6 on DEC VAX and DEC AXP Systems
Installation
Manuals
PN6.2:SW3153:HPX
Installing ENVOX Configuration Software
on HP-UX Systems

TU1 TU1.0:SW3151
Tutorial ENVOX Tutorial

YOU ARE HERE

UM6
User UM6.1:SW3151
Using ENVOX Configuration Software
Manuals

TR1
Technical TR1.0:SW3151
ENVOX Technical Reference
Reference

SM1
System SM1.0:SW3151
The System Manager’s Guide to
Manager’s ENVOX Configuration Software
Guide

Revision H — July 1996 iii

UM6.1:SW3151
Documentation Map

PROVOXr documentation supports each stage of system development.

System Development Stages Document Type & Contents

System Design Configuration Engineering Manuals

Configuration data-entry help for a
product, including theory of
operation for improved product
use.
Installation and User Manuals for
Configuration Products
Installation procedures, and
operating methods and procedures
for using the configuration
software.
Technical Reference Manuals
Advanced user information for
expanding the capability of the
PROVOX system.
System Manager’s Guide
Expert users information for
managing operating systems.

System Planning and Installation Planning Manuals

Installation Site preparation, including the
environment, power, and
grounding. Also, product
input/output signal wiring, cable
connections, and software
installation.

System Startup and User Manuals

Operation Operating methods and
procedures for a product.
Tutorials
Structured training for operators.

Maintenance Maintenance Manuals

Preventative maintenance,
calibration, troubleshooting, and
repair procedures.

Ordering Information — To order additional manuals, contact your local

sales representative, specifying the number, title, and quantity of each
document required.

iv Revision H — July 1996

UM6.1:SW3151
 Using ENVOXâ Configuration Software

Contents
Section/Title Page

1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
1.1 Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
1.2 ENVOX Revision This Manual Supports . . . . . . . . . . . . . . . . . . . . 1-1
1.3 New This Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
1.4 Structure of This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
1.5 Manual Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
1.6 Cautions and Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
1.7 ENVOX Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
1.8 Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
1.9 Where to Find Answers About This Product or Manual . . . . . . . 1-8

2 PROVOX System Overview . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

2.1 PROVOX Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
2.2 Application Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
2.3 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
2.3.1 Device Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
2.3.2 Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
2.3.3 Point Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
2.3.4 Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
2.3.5 Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
2.3.6 Displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8

3 ENVOX Software Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

3.1 Product Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
3.2 Computer Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
3.3 Configuration Planning and Design . . . . . . . . . . . . . . . . . . . . . . . . 3-1
3.4 Configuration Engineering and Maintenance Tasks . . . . . . . . . . 3-3
3.4.1 Creating Configuration Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
3.4.2 Generate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
3.4.3 Download . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
3.4.4 Trace/Tune . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
3.4.5 Upload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
3.4.6 Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5

Revision H — July 1996 v

UM6.1:SW3151
Contents

Section/Title Page

3.4.7 Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5

3.4.8 Audit Trail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
3.5 ENVOX User Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6
3.5.1 Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6
3.5.1.1 Menu-Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6
3.5.1.2 Pull-Down Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6
3.5.1.3 Slide-Off Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6
3.5.2 Forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7
3.5.3 Display Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
3.5.4 Language Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
3.5.5 Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10
3.5.6 Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11
3.5.7 Menu Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11
3.5.8 On-Line Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12

4 Starting and Navigating Through ENVOX Software . . . . 4-1

4.1 Starting ENVOX Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
4.2 Navigating Through ENVOX Software . . . . . . . . . . . . . . . . . . . . . . 4-2
4.2.1 Navigating With a Mouse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
4.2.2 Navigating With a Keyboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9
4.2.3 Using Fast Access Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9
4.3 Navigating and Entering Data in Forms . . . . . . . . . . . . . . . . . . . . . 4-10
4.3.1 Calling Up an Item Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
4.3.2 Navigating Inside a Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
4.3.2.1 Moving the Cursor From Field To Field . . . . . . . . . . . . . . . . . 4-10
4.3.2.2 Moving the Cursor Within a Field . . . . . . . . . . . . . . . . . . . . . . 4-11
4.3.3 Exiting a Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12
4.3.4 Entering Form Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12
4.3.4.1 Selecting from a Visible Choice Field . . . . . . . . . . . . . . . . . . . 4-13
4.3.4.2 Selecting from a Values List . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
4.3.4.3 Searching in a Values List . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14
4.3.4.4 Using Default Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15
4.3.4.5 Using Pattern Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16
4.3.5 Form Navigation Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19
4.3.6 Navigating and Entering Data in Group Fields . . . . . . . . . . . . . 4-19
4.3.7 Finding Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20
4.4 Printing Forms Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-21
4.5 Printing Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-21
4.6 Using the Status Page Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22
4.6.1 Accessing the Status Page Form . . . . . . . . . . . . . . . . . . . . . . . . 4-22
4.6.2 Reading the Status of Other Databases . . . . . . . . . . . . . . . . . . 4-24
4.6.3 Viewing Disk Space Usage Information . . . . . . . . . . . . . . . . . . . 4-25

vi Revision H — July 1996

UM6.1:SW3151
 Contents

Section/Title Page

5 Creating and Editing Device Definitions,

Points and Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
5.1 Adding an Item to the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
5.1.1 Target Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3
5.1.2 Extra Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
5.1.3 Instrument Signal Tags (ISTs) . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6
5.1.3.1 Creating Instrument Signal Tags (ISTs) . . . . . . . . . . . . . . . . . 5-8
5.1.3.2 Creating ISTs from the Top Level . . . . . . . . . . . . . . . . . . . . . . 5-8
5.1.3.3 Creating a Primary IST from a Point Form . . . . . . . . . . . . . . 5-10
5.2 Example Device Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12
5.3 Modifying an Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-17
5.4 Modifying Items Using a Tag Set . . . . . . . . . . . . . . . . . . . . . . . . . . 5-18
5.5 Saving Form Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-19
5.6 Viewing Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20
5.7 Copying Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-21
5.7.1 Copy Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-22
5.7.2 Unique Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-24
5.7.3 Group Field Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-25
5.7.3.1 Overwrite Mode for Group Fields . . . . . . . . . . . . . . . . . . . . . . 5-25
5.7.3.2 Data Replace Mode for Group Fields . . . . . . . . . . . . . . . . . . . 5-25
5.7.3.3 Fill-in Mode for Group Fields . . . . . . . . . . . . . . . . . . . . . . . . . . 5-25
5.7.4 Copying Data to a Displayed Form (Copy Form) . . . . . . . . . . . 5-26
5.7.5 Item Copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28
5.7.5.1 Item Copy Form Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28
5.7.5.2 Copying . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29
5.7.5.3 Using Tag Sets With Item Copy . . . . . . . . . . . . . . . . . . . . . . . . 5-30
5.7.6 Copying a Console Configuration . . . . . . . . . . . . . . . . . . . . . . . . 5-32
5.7.7 Cloning PROVUE Consoles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-34
5.7.7.1 Restrictions on Cloning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-35
5.7.7.2 Changing an Existing Console to or From a Clone . . . . . . . 5-35
5.8 Deleting Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-36
5.8.1 Deleting From the Top Level Form . . . . . . . . . . . . . . . . . . . . . . . 5-36
5.8.2 Deleting from the Item Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-38
5.9 Clearing a Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39
5.10 Renaming an Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-40
5.10.1 Renaming Using the ENVOX Form . . . . . . . . . . . . . . . . . . . . . . 5-40
5.10.2 Renaming with a Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41
5.11 Using Note Forms for Comments . . . . . . . . . . . . . . . . . . . . . . . . . . 5-44
5.12 Errors and Warnings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-45
5.12.1 Understanding Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . 5-45
5.12.2 Understanding Warning Messages . . . . . . . . . . . . . . . . . . . . . . . 5-46
5.12.3 Viewing Verified Configuration Errors . . . . . . . . . . . . . . . . . . . . . 5-46
5.13 Upgrading Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-47

Revision H — July 1996 vii

UM6.1:SW3151
Contents

Section/Title Page

6 Using Tag Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

6.1 Menu Options That Support Tag Sets . . . . . . . . . . . . . . . . . . . . . . 6-1
6.2 Ways to Create a Tag Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
6.3 Creating from the Tag Set Form . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
6.3.1 Accessing the Tag Set Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
6.3.2 Creating the Tag Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5
6.3.2.1 Entering the Tags Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5
6.3.2.2 Using The Match Criteria! Option . . . . . . . . . . . . . . . . . . . . . . 6-5
6.4 Creating from the Generation Errors Form . . . . . . . . . . . . . . . . . . 6-9
6.5 Creating an Ad Hoc Tag Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-9
6.6 Modifying a Tag Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11
6.7 Deleting a Tag Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11
6.8 Tag Set Access from ISQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12

7 Using the Language Editor . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

7.1 Accessing the Language Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
7.1.1 Accessing the Editor for LCP FSTs . . . . . . . . . . . . . . . . . . . . . . . 7-2
7.1.2 Accessing the Editor for Operations . . . . . . . . . . . . . . . . . . . . . . 7-3
7.1.3 Accessing the Editor for Console Reports . . . . . . . . . . . . . . . . . 7-3
7.1.4 Accessing the Editor for Procedures . . . . . . . . . . . . . . . . . . . . . 7-3
7.1.5 Accessing the Editor for Conditional Color
and Conditional Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
7.1.6 Accessing the Editor for IAC FSTs . . . . . . . . . . . . . . . . . . . . . . . 7-5
7.2 Navigating in the Language Editor . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
7.3 Adding an Instruction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
7.3.1 Entering Instruction Mnemonics . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
7.3.2 Filling in the Operands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
7.3.3 Closing an Instruction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
7.4 Including Blocks of Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-10
7.4.1 Using the Include Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-10
7.4.1.1 Including an Instruction Block in Operations
and Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-10
7.4.1.2 Including an Instruction Block for All Other
Sequence Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-12
7.4.2 Include Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13
7.5 Modifying Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14
7.6 Adding a Comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14
7.7 Cutting and Pasting Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15
7.7.1 Cutting and Pasting a Closed Instruction . . . . . . . . . . . . . . . . . 7-15
7.7.2 Cutting and Pasting Text Within Comments . . . . . . . . . . . . . . . 7-15
7.8 Finding and Replacing Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16
7.9 Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
7.10 Using the Split Window Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18
7.11 Using the Learn Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-20
7.12 Saving Your Instruction Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21

viii Revision H — July 1996

UM6.1:SW3151
 Contents

Section/Title Page

7.12.1 Save With Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21

7.12.2 Save Without Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22
7.12.3 Cancel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22
7.12.4 Quit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22
7.13 Creating a Console Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-23
7.13.1 LAYOUT and PRINT Instructions . . . . . . . . . . . . . . . . . . . . . . . . 7-23
7.13.2 HISTORY Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-25
7.13.3 REPEAT, NEXT, UNTIL, and UNTIL END Instructions . . . . . . 7-27
7.13.4 Additional Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-27
7.13.5 Previewing a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-28
7.13.6 Example Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-29
7.14 Printing ASCII to a Printer or a File . . . . . . . . . . . . . . . . . . . . . . . . 7-30

8 Generating Configuration Data . . . . . . . . . . . . . . . . . . . . . . . 8-1

8.1 When to Generate Configuration Data . . . . . . . . . . . . . . . . . . . . . 8-2
8.2 Steps in Generating Configuration Data . . . . . . . . . . . . . . . . . . . . 8-2
8.3 Accessing the Generation Options Form . . . . . . . . . . . . . . . . . . . . 8-3
8.4 Specifying Devices to be Generated . . . . . . . . . . . . . . . . . . . . . . . 8-4
8.4.1 Manually Entering the Device Tags . . . . . . . . . . . . . . . . . . . . . . 8-4
8.4.2 Using the Values List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
8.4.3 Using a Tag Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5
8.4.4 Selecting All Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5
8.4.5 Clearing the Device List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6
8.5 Generation Options Form Contents . . . . . . . . . . . . . . . . . . . . . . . . 8-7
8.5.1 Updating the Form Information . . . . . . . . . . . . . . . . . . . . . . . . . . 8-7
8.5.2 Understanding the Form Contents . . . . . . . . . . . . . . . . . . . . . . . 8-7
8.6 Generating the Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-9
8.6.1 Batch Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10
8.6.1.1 Reviewing the Status of Batch Generation Jobs . . . . . . . . . 8-12
8.6.1.2 Viewing the Batch Jobs Status . . . . . . . . . . . . . . . . . . . . . . . . 8-13
8.6.1.3 Aborting a Batch File Generation . . . . . . . . . . . . . . . . . . . . . . 8-15
8.6.2 Interactive Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-16
8.7 Reviewing Generation Errors and Warnings . . . . . . . . . . . . . . . . . 8-18
8.7.1 Reviewing Errors and Warnings—Batch Generation . . . . . . . . 8-18
8.7.2 Reviewing Errors and Warnings—Interactive Generation . . . 8-19
8.7.3 Viewing Item-Form Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-21
8.7.4 Printing Generation Errors and Warnings . . . . . . . . . . . . . . . . . 8-21
8.7.5 Correcting Incomplete-Data Errors . . . . . . . . . . . . . . . . . . . . . . . 8-21

9 Downloading Configuration Data . . . . . . . . . . . . . . . . . . . . . 9-1

9.1 Tasks Required to Download Data . . . . . . . . . . . . . . . . . . . . . . . . . 9-1
9.1.1 Accessing the Download Options Form . . . . . . . . . . . . . . . . . . . 9-2
9.1.2 Creating a List of Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3
9.1.2.1 Entering Device Names One At a Time . . . . . . . . . . . . . . . . . 9-3

Revision H — July 1996 ix

UM6.1:SW3151
Contents

Section/Title Page

9.1.2.2 Selecting All Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3

9.1.2.3 Entering One or More Tag Set Names . . . . . . . . . . . . . . . . . . 9-3
9.1.2.4 Clearing the Download Options List . . . . . . . . . . . . . . . . . . . . 9-4
9.1.2.5 Download Options Form Information Fields . . . . . . . . . . . . . 9-4
9.1.3 Starting the Download . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-7
9.2 Viewing Download-Related Information . . . . . . . . . . . . . . . . . . . . . 9-8
9.3 Backing Up Downloaded Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10
9.3.1 Creating a Backup Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10
9.3.2 Downloading from a Backup Image . . . . . . . . . . . . . . . . . . . . . . 9-11
9.4 Emergency Downloading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-13
9.4.1 Creating an ED File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-13
9.4.1.1 Creating an ED File Using ENVOX Software . . . . . . . . . . . . 9-14
9.4.1.2 Creating an ED File from the Command Line . . . . . . . . . . . . 9-15
9.4.2 Downloading From an ED File . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-16
9.4.3 Emergency Downloading Without ENVOX
or SYBASE Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-17

10 Uploading Configuration Data . . . . . . . . . . . . . . . . . . . . . . . 10-1

10.1 Upload Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3
10.1.1 Batch Uploading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-5
10.1.1.1 Viewing the Status of Batch Upload Requests . . . . . . . . . . . 10-6
10.1.1.2 Aborting a Batch Upload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7
10.1.1.3 Viewing the Whole Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7
10.1.2 Interactive Uploading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8
10.1.2.1 Uploading Device Data into the Database . . . . . . . . . . . . . . 10-9
10.1.2.2 Printing Interactive Upload Information . . . . . . . . . . . . . . . . . 10-9
10.2 Generating Devices After Upload . . . . . . . . . . . . . . . . . . . . . . . . . . 10-10
10.3 Upload Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-10
10.4 Upload Failures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-10
10.5 Uploads to LCP Registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-11
10.6 Upload Data Precision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12
10.7 Upload Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12
10.8 Uploadable Points and Their DDPs . . . . . . . . . . . . . . . . . . . . . . . . 10-14

11 Using the Trace/Tune Utilities . . . . . . . . . . . . . . . . . . . . . . . . 11-1

11.1 Using the IAC Trace/Tune Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1
11.2 IAC Trace Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2
11.3 Starting the IAC Trace/Tune Utility . . . . . . . . . . . . . . . . . . . . . . . . . 11-3
11.3.1 Changing Trace Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-5
11.3.2 Setting Trace Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-5
11.3.3 Clearing Trace Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-5
11.3.4 Continuing from Breakpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-6
11.3.5 Examining I/O Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-6
11.3.6 Selecting a New Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-7

x Revision H — July 1996

UM6.1:SW3151
 Contents

Section/Title Page

11.3.7 Displaying and Changing Tuning Values . . . . . . . . . . . . . . . . . . 11-7

11.3.7.1 Tuning Controller DDPs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-7
11.3.7.2 Examining and Changing Controller I/O . . . . . . . . . . . . . . . . 11-8
11.3.7.3 Examining and Changing General Registers . . . . . . . . . . . . 11-9
11.3.7.4 Examining and Changing the Accumulator . . . . . . . . . . . . . . 11-10
11.3.8 Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-10
11.4 Using the LCP Trace/Tune Utility . . . . . . . . . . . . . . . . . . . . . . . . . . 11-11
11.5 LCP Trace Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-13
11.6 Starting the LCP Trace/Tune Utility . . . . . . . . . . . . . . . . . . . . . . . . 11-14
11.6.1 Changing the LCP Trace Mode . . . . . . . . . . . . . . . . . . . . . . . . . . 11-16
11.6.2 Setting LCP Trace Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-17
11.6.3 Clearing Specific LCP Trace Points . . . . . . . . . . . . . . . . . . . . . . 11-18
11.6.4 Clearing All LCP Trace Points . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-18
11.6.5 Selecting a New Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-18
11.6.6 Changing the LCP Point Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-19
11.6.7 Stepping through an FST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-19
11.6.8 Continuing From Breakpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-19
11.6.9 Running an LCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-20
11.6.10 Stopping an LCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-20
11.6.11 Clearing All Trace Points from a Device . . . . . . . . . . . . . . . . . . 11-21
11.6.12 Examining and Changing the Accumulator . . . . . . . . . . . . . . . . 11-21
11.6.13 Examining and Changing Registers . . . . . . . . . . . . . . . . . . . . . . 11-22
11.6.14 Examining and Overriding I/O . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-23
11.6.15 Tuning Controller DDPs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-24
11.6.16 Monitoring I/O Channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-24
11.6.17 Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-25

12 Using the HART Instrument Locator Tool . . . . . . . . . . . . . 12-1

12.1 Starting the HILT Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1
12.2 HILT Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-2
12.3 HILT Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-3
12.4 Browsing HILT CDV Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-4

13 Using the Diagnostics Utility . . . . . . . . . . . . . . . . . . . . . . . . . 13-1

13.1 Activating the Diagnostics Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1
13.1.1 Activating With the ENVOX Forms System . . . . . . . . . . . . . . . . 13-2
13.1.2 Activating Via the Command Line . . . . . . . . . . . . . . . . . . . . . . . . 13-2
13.2 Diagnostics Utility Menu Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . 13-4
13.3 Navigating in The Diagnostics Utility . . . . . . . . . . . . . . . . . . . . . . . 13-6
13.4 Diagnostics Displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-8
13.4.1 System Integrity Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-9
13.4.2 Local Area Integrity Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-9
13.4.3 Device Integrity Displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-10
13.4.4 Device Revision Information Displays . . . . . . . . . . . . . . . . . . . . 13-13

Revision H — July 1996 xi

UM6.1:SW3151
Contents

Section/Title Page

13.4.5 Traffic Statistics Displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-15

13.4.6 Unsolicited Data Control Displays . . . . . . . . . . . . . . . . . . . . . . . . 13-16
13.5 Logging Diagnostic Displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-17

14 Documenting the Database . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1

14.1 Requesting a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1
14.2 Report Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-4
14.2.1 Detail Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-4
14.2.2 Summary Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-5
14.2.3 More Summary Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-6
14.2.4 Cross-Ref Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7
14.2.5 Other Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7

15 Creating Audit Trail Reports . . . . . . . . . . . . . . . . . . . . . . . . . 15-1

15.1 Creating Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1
15.1.1 Search Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-2
15.1.1.1 Date From and Date To . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-3
15.1.1.2 Event Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-3
15.1.1.3 Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-4
15.1.1.4 Username and Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-4
15.1.1.5 Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-4
15.1.1.6 Item Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-4
15.1.2 Audit Trail Search Form Options . . . . . . . . . . . . . . . . . . . . . . . . . 15-5
15.1.2.1 Count! . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-5
15.1.2.2 Retrieve! . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-5
15.1.2.3 Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-6
15.1.2.4 Event No.! . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-7
15.1.3 The History Summary Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-8
15.1.3.1 Detail Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-8
15.1.3.2 Print Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-9
15.1.4 The Event Detail Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-10
15.1.4.1 Print Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-11
15.1.4.2 Next and Previous Options . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-11
15.1.5 Using the Audit Trail Search Form . . . . . . . . . . . . . . . . . . . . . . . 15-12

Appendixes

A Import and Export Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

A.1 Migrating PROFLEX Configuration Data . . . . . . . . . . . . . . . . . . . . A-1
A.2 Importing CDV-Format Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
A.2.1 Creating a Subdirectory for CDV Files . . . . . . . . . . . . . . . . . . . . A-2
A.2.2 Using the Import Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
A.2.3 Loading CDV-Format Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-4
A.2.4 Merging CDV-Format Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-4

xii Revision H — July 1996

UM6.1:SW3151
 Contents

Section/Title Page

A.2.5 Aborting an Import Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-5

A.2.6 Tracking the Status of an Import Request . . . . . . . . . . . . . . . . . A-6
A.2.6.1 Using the View Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-6
A.2.6.2 Using the Log Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-7
A.2.6.3 Using the Whole Batch Queue Option . . . . . . . . . . . . . . . . . . A-8
A.2.7 Using the IMPORT_SETUP Utility . . . . . . . . . . . . . . . . . . . . . . . A-9
A.2.7.1 Running IMPORT_SETUP from Prompts . . . . . . . . . . . . . . . A-9
A.2.7.2 Running IMPORT_SETUP from a Single Command Line . A-10
A.2.7.3 Examples for Running IMPORT_SETUP . . . . . . . . . . . . . . . . A-11
A.2.8 Defining The Location Of Imported Data . . . . . . . . . . . . . . . . . . A-12
A.2.8.1 Defining the Location on VMS Systems . . . . . . . . . . . . . . . . A-12
A.2.8.2 Defining the Location on UNIX Systems . . . . . . . . . . . . . . . . A-14
A.3 Exporting Configuration Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-15
A.3.1 Running the Export Utility From ENVOX Forms . . . . . . . . . . . . A-16
A.3.1.1 Accessing the Export Form . . . . . . . . . . . . . . . . . . . . . . . . . . . A-16
A.3.1.2 Exporting All Database Data . . . . . . . . . . . . . . . . . . . . . . . . . . A-18
A.3.1.3 Exporting Selected Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-19
A.3.2 Exporting from a Command Line . . . . . . . . . . . . . . . . . . . . . . . . A-20
A.3.2.1 Running EXPORT_SETUP From Prompts . . . . . . . . . . . . . . A-20
A.3.2.2 Running EXPORT_SETUP From a Single Command Line A-22
A.3.2.3 Examples for Running EXPORT_SETUP . . . . . . . . . . . . . . . A-23

B Importing Bulk Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1

B.1 Importing Bulk Data with the Open Database Server Software B-1
B.2 Importing Instrument Signal Data in ASCII Code . . . . . . . . . . . . . B-1

C Keyboard Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1

C.1 Menu Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1
C.2 Forms Navigation Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2
C.3 Language Editor Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-4
C.4 Display Editor Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-8
C.5 Keyboard Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-10
C.6 Trace/Tune Keys and Keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . C-16
C.7 Diagnostic Utility Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-17
C.8 Using PCs for ENVOX Software . . . . . . . . . . . . . . . . . . . . . . . . . . . C-18

Glossary

Index

Document History

Revision H — July 1996 xiii

UM6.1:SW3151
Contents

Section/Title Page

Figures
1-1 Conventions for showing Menu Selections . . . . . . . . . . . . . . . . . . 1-5
2-1 PROVOX System Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
2-2 Configuration Item Relationships . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
2-3 Conceptual Representation of Points . . . . . . . . . . . . . . . . . . . . . . 2-5
2-4 Example of a Console Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8
3-1 Configuration and Maintenance Tasks
and the ENVOX Features That Provide Them . . . . . . . . . . . . . . 3-4
3-2 Item Form for a PCI Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7
3-3 ENVOX Form Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8
3-4 Example Language Editor Screen . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
4-1 ENVOX Top Level Form Menu Hierarchy (part 1 of 6) . . . . . . . . 4-3
4-2 PCI Point Item Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11
4-3 Group Field Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19
4-4 Example of Status Page Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22
4-5 Example of Database Space Information Form . . . . . . . . . . . . . . 4-25
5-1 Target Forms Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4
5-2 Instrument Signal Tag Flow Concept . . . . . . . . . . . . . . . . . . . . . . . 5-9
5-3 Analog Input Point Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-11
5-4 Example Data for a UOC/IFC Device . . . . . . . . . . . . . . . . . . . . . . . 5-13
5-5 Database Definition Form Layout . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14
5-6 UOC Serial IO File-Card Form Layout . . . . . . . . . . . . . . . . . . . . . . 5-15
5-7 UOC Serial IO Channels Form Layout . . . . . . . . . . . . . . . . . . . . . . 5-16
5-8 Modify Items In Tag Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-18
5-9 Copy Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23
5-10 Copy Items Form (Point Version Shown) . . . . . . . . . . . . . . . . . . . . 5-28
5-11 Copying Items Using Tag Sets (Example 1) . . . . . . . . . . . . . . . . . 5-30
5-12 Coping Items Using Tag Sets (Example 2) . . . . . . . . . . . . . . . . . . 5-31
5-13 Copy Items Form (Console Version Shown) . . . . . . . . . . . . . . . . . 5-33
5-14 Delete Items Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37
6-1 Tag Set Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
6-2 Match Criteria Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
6-3 Match Criteria Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
7-1 Pop-Up List of Valid Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7
7-2 Instruction in Open Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
7-3 Example Instruction in Closed Format . . . . . . . . . . . . . . . . . . . . . . 7-9
7-4 Include Function Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-10
7-5 Include Function Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-12
7-6 Instruction in Open Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16
7-7 Language Editor Split Window Example . . . . . . . . . . . . . . . . . . . . 7-18
7-8 Example History Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-26
7-9 Example Console Reports Edit Display . . . . . . . . . . . . . . . . . . . . . 7-29
8-1 The Generation Option Organizes Download Data . . . . . . . . . . . 8-1
8-2 The Generation Options Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3

xiv Revision H — July 1996

UM6.1:SW3151
 Contents

Section/Title Page

8-3 Completed Generation Options Form . . . . . . . . . . . . . . . . . . . . . . 8-7

8-4 Example of a Batch Generation Queue Status Form . . . . . . . . . 8-11
8-5 Batch Generation Job Status Form . . . . . . . . . . . . . . . . . . . . . . . . 8-13
8-6 Batch Jobs Status Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-14
8-7 Batch Generation Queue Status Form . . . . . . . . . . . . . . . . . . . . . 8-15
8-8 Interactive Generate Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-17
8-9 Generate Errors Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-20
9-1 Downloading Configuration Download Data to Devices . . . . . . . 9-1
9-2 Download Options Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
9-3 Download Interactive Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-7
9-4 Example Download Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-9
9-5 Download Options Form (Download Backup Version) . . . . . . . . 9-12
10-1 Making Tuning Changes Part of the Database . . . . . . . . . . . . . . 10-1
10-2 Upload Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3
10-3 Batch Upload Status Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6
10-4 Interactive Upload Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8
10-5 Upload Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-13
11-1 IAC Trace/Tune Form Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-4
11-2 I/O Setup Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-6
11-3 The Trace Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-11
11-4 LCP Trace/Tune Form Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-15
11-5 Example Trace Points Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-16
11-6 I/O Setup Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-24
13-1 Diagnostics Executive Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3
13-2 Diagnostics Utility Menu Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . 13-5
13-3 Diagnostic Display Menu Bar and Pull-Down Menu Options . . . 13-6
13-4 System Integrity Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-8
13-5 Local Area Integrity Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-10
13-6 Device Integrity Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-12
13-7 Device Revision Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-14
13-8 Traffic Statistics Display (for an LTD) . . . . . . . . . . . . . . . . . . . . . . . 13-15
13-9 Unsolicited Data Control Display . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-16
14-1 Example of Document Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-2
14-2 Example Document Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-3
15-1 Example of Audit Trail Search Form . . . . . . . . . . . . . . . . . . . . . . . . 15-2
15-2 History Summary Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-8
15-3 Event Detail Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-10
A-1 Example of Import Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3
A-2 The Import Utility Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-7
A-3 Batch Jobs Status Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-8
A-4 Export Utility Flow Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-15
A-5 Example of Export Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-17
C-1 Menu Keys Are Shown on the Screen in
Reverse Video or Underline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1

Revision H — July 1996 xv

UM6.1:SW3151
Contents

Section/Title Page

C-2 Forms Navigation on a DEC LK201 Keyboard . . . . . . . . . . . . . . . C-10

C-3 Language Editor on a DEC LK201 Keyboard . . . . . . . . . . . . . . . . C-11
C-4 Display Editor on a DEC LK201 Keyboard . . . . . . . . . . . . . . . . . . C-11
C-5 Forms Navigation on an HP-UX Keyboard . . . . . . . . . . . . . . . . . . C-12
C-6 Language Editor on an HP-UX Keyboard . . . . . . . . . . . . . . . . . . . C-12
C-7 Display Editor on an HP-UX Keyboard . . . . . . . . . . . . . . . . . . . . . C-13
C-8 Forms Navigation When an ENVOX System (Either OpenVMS
or HP-UX) is Accessed through an IBM-Compatible PC . . . . . C-14
C-9 Language Editor When ENVOX OpenVMS System is Accessed
through an IBM-Compatible PC . . . . . . . . . . . . . . . . . . . . . . . . . . . C-14
C-10 Language Editor When an ENVOX HP-UX System is
Accessed through an IBM-Compatible PC . . . . . . . . . . . . . . . . . C-15
C-11 Display Editor When an ENVOX System (Either OpenVMS
or HP-UX) is Accessed through an IBM-Compatible PC . . . . . C-15

Tables
1-1 Type Style Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
4-1 Search String Characters for Valid Entry Lists . . . . . . . . . . . . . . 4-14
4-2 ENVOX Software Default Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16
9-1 Download Status Words . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-6
10-1 Uploadable Point Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-14
10-2 Uploadable Detail Display Parameters (1) . . . . . . . . . . . . . . . . . . 10-14
14-1 Document Data Selection Choices . . . . . . . . . . . . . . . . . . . . . . . . . 14-8
14-2 Document Results Order Choices . . . . . . . . . . . . . . . . . . . . . . . . . 14-8
15-1 Some Event Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-3
A-1 View Option Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-6
B-1 Field Definitions for IST CDV Format . . . . . . . . . . . . . . . . . . . . . . . B-3
B-2 Database Data Types for Instrument Signal Tags . . . . . . . . . . . . B-5
C-1 Keys for Navigating in ENVOXr Forms . . . . . . . . . . . . . . . . . . . . . C-2
C-2 Language Editor Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-4
C-3 Graphic Display Editor Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-8
C-4 Trace/Tune Keys and Keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . C-16
C-5 Diagnostics Utility Dedicated Keys . . . . . . . . . . . . . . . . . . . . . . . . . C-17

xvi Revision H — July 1996

UM6.1:SW3151
 Section Tab Guide
Introduction 1
PROVOX System Overview 2
ENVOX Software Overview 3
Starting and Navigating Through ENVOX Software 4
Creating and Editing Device Definitions, Points and Templates 5
Using Tag Sets 6
Using the Language Editor 7
Generating Configuration Data 8
Downloading Configuration Data 9
Uploading Configuration Data 10
Using the Trace/Tune Utilities 11
Using the HART Instrument Locator Tool 12
Using the Diagnostics Utility 13
Documenting the Database 14
Creating Audit Trail Reports 15
Import and Export Utilities A
Importing Bulk Data B
Keyboard Reference C
Glossary 19
Glossary

Index 20
Index

Revision H — July 1996 xvii

UM6.1:SW3151
 This page intentionally left blank.

xviii Revision H — July 1996

UM6.1:SW3151
 Introduction 1-1

Figure 1-Table 1

1
1 Introduction
SW3150 Series ENVOXâ Configuration Software are application
programs used for configuring a PROVOXâ process management
system. ENVOX configuration software is available as:

J Type SW3151 ENVOX Configuration Software (ENVOX DEC VAX),

version P3.4 for DEC OpenVMS.

J Type SW3153 ENVOX Configuration Software (ENVOX HP-UX),

version P3.4 for HP_UX.

J Type SW3155 ENVOX Configuration Software (ENVOX DEC AXP),

version P3.4 for DEC AXP OpenVMS.

This manual describes ENVOX software functions for configuration

engineers and how to use them. Some ENVOX functions are reserved for
the ENVOX system manager. These functions are described in, The
System Manager’s Guide to ENVOX Configuration Software,
SM1.0:SW3151.

1.1 Intended Audience

This manual is written for users who have a knowledge of their process
and of general process control principles, but need to learn and use
ENVOX configuration software. You should have attended or should work
with someone who has attended a Fisher-Rosemount Systems certified,
ENVOX school.

1.2 ENVOX Revision This Manual Supports

This manual supports ENVOX configuration software, release P3.4.
Retain earlier versions of ENVOX manuals for earlier releases of ENVOX
software.

Revision H — July 1996 UM6.1:SW3151

 1-2 Introduction

1.3 New This Release

ENVOX P3.4 includes several enhancements for configuration engineers
1 and for the ENVOX System manager. Each enhancement is explained in
the appropriate ENVOX manual. The enhancements are:
J ENVOX P3.4 operates on SYBASE System 10.0 SQL Servers. With
SYBASE System 10.0, new installation and upgrade procedures for
Client-Server systems use the Portable Database Transfer (PDX)
utility to improve installation and upgrade.
J With SYBASE System 10.0 servers, a password is required. It cannot
be NULL, and it must be at least 6 characters.
J With SYBASE System 10.0, a server is added called the Backup
Server. It is separate from the SQL server, and used exclusively for
database backup and recovery operations.
J For ENVOX P3.4, DECwindows Motif is required as the user interface
for OpenVMS VAX and OpenVMS AXP software.
J A read-only Item Type field has been added to the Add, Modify, and
View popup forms which display the type of item being added,
modified, or viewed.
J On the Add, Modify, and View popup forms, you can now retrieve the
last tag entered by pressing the Last Tag function key.
J You can restrict the entries in the values list in Modify and View popup
forms with a new Set Item Type! field.
J You can use up to 20 characters in the Modify and View popup forms
for pattern matching and wildcard searching.
J A Highway-Access report has been added to document the Highway
Access Control List. The report lets you easily find the index numbers
of points of interest.
J You can now access the Language Editor and Display Editor, and
navigate in ENVOX forms, from a personal computer keyboard. You
can also change the keymapping on the keyboard.
J Other enhancements have been made to ENVOX P3.4 which expand
the configuration options for specific PROVOXr highway devices.
These enhancements are explained in the configuration engineering
manuals for the affected devices.
J ENVOX P3.4 now provides the means for you to run the HART
Instrument Locator Tool (HILT), which gathers information about all
smart field devices (HART-compatible) attached to the PROVOX
network through configured controllers. This utility gives you the
capability of creating an up-to-date list of all HART instruments
configured as connected to the network and to access this list through
commands, regardless of the platform on which your system runs.

UM6.1:SW3151 Revision H — July 1996

 Introduction 1-3

1.4 Structure of This Manual

The manual includes the following sections and appendixes:
1
Section 1 — Introduction: provides an introduction to this manual,
describes the audience, describes the content of each section and
appendix, provides an overview of the documentation set for ENVOX
software, and describes the symbols and stylistic conventions used.

Section 2 — PROVOX System Overview: provides an overview of

PROVOX instrumentation systems.

Section 3 — ENVOX Software Overview: describes ENVOX software

requirements and features.

Section 4 — Starting and Navigating Through ENVOX Software:

describes how to start the software. This section also explains the menu
organization, how to navigate within the software, and how to enter data.

Section 5 — Creating and Editing Device Definitions, Points, and

Templates: describes the menu options you use to create and edit a
configuration.

Section 6 — Using Tag Sets: describes how to use sets of database

items to improve configuration productivity.

Section 7 — Using the Language Editor: provides general instructions for

using the language editor to create logic and operator console reports.

Section 8 — Generating Configuration Data: describes how to generate

configuration download data for each device in the system.

Section 9 — Downloading Configuration Data: describes how to send the

configuration download data to the appropriate devices in the system.

Section 10 — Uploading Configuration Data: describes how to update

the ENVOX database with on-line configuration data.

Section 11 — Using the Trace/Tune Utilities: describes how to debug a

control strategy for an interactive controller (IAC) and for a logic control
(LCP) function sequence table (FST).

Section 12 — Using the HART Instrument Locator Tool (HILT) Utility:

describes how to run the HART Instrument Locator Tool from a command
line to create an up-to-date list of HART instruments connected to your
PROVOX network, and how to access these lists through an SQL query.

Section 13 — Using the Diagnostics Utility: describes how to troubleshoot

problems in the instrumentation system using the ENVOX software.

Section 14 — Documenting the Database: describes how to create a

variety of database reports.

Revision H — July 1996 UM6.1:SW3151

 1-4 Introduction

Section 15 — Creating Audit Trail Reports: explains how to view audit

trail information and print audit trail reports.

Appendix A — Import and Export Utilities: describes how to import

1 migration format data into a database, and how to export data from one
database to another.

Appendix B — Importing Bulk Data: describes, in general, the ENVOX

software’s ability to accept ASCII files, and specifically, how to import
ASCII instrument signal data to an ENVOX database.

Appendix C — Keyboard Reference: lists key and keyword functions for

the forms editor, language editor, trace/tune utility, and the diagnostics
utility.

1.5 Manual Conventions

This manual uses the following conventions:

Menu — Where appropriate, menu selections are shown as they typically

appear in the software. The appearance of the software may be different,
depending on your terminal or workstation setup. See Figure 1-1.

Abbreviations — The glossary of this manual contains abbreviations,

their phrases, and explanations for the abbreviations.

Revision Control — The title page lists the printing date of this manual.
When the manual is revised, the revision level and the print date are
changed.

Cross Referencing — References to other documents give the

document name and document number.

Commands — Commands do not include the Return or Enter key at the

end. If the manual describes a command, assume that a Return or Enter
key is required to enter the command.

Table 1-1 describes the type styles this manual uses to distinguish
different types of information.

UM6.1:SW3151 Revision H — July 1996

 Introduction 1-5

Table 1-1 Type Style Conventions

When Text Appears
This Way ... It Means ...
ENVOX Technical The title of another manual is referenced in this 1
Reference document.

BACKUP The word is an operating mode or status, or a key

function (used instead of a specific keyboard key).
Ctrl-v This style designates a keyboard key or key
combination. The word key does not appear after the
key name.
Database This style designates a message or prompt that
appears on a screen.
CREATE This style indicates the words that you should type in,
as it appears on the printed page. Examples are
commands you enter at the prompt and keywords in a
configuration source file.
filename.type This style indicates a guideline for the kind of
information to type in. You decide on the specific item.
detail display These words are emphasized.

Conventions for showing menu selections in the ENVOX forms system

are illustrated in Figure 1-1.

ENVOX TOP LEVEL FORM

X Add Modify! Utilities More Status! Help

Generate
Menu Keys are
shown in boldface Download ->
Document
Menu Selections Upload
are shown in Document
Diagnostics
Reverse Video
IAC Trace/Tune
LCP Trace/Tune
Administration
Dbase Management ->
Audit Trail
EV087

Figure 1-1 Conventions for showing Menu Selections

Revision H — July 1996 UM6.1:SW3151

 1-6 Introduction

1.6 Cautions and Notes

Cautions and Notes attract attention to essential or critical information in
1 this manual. The types of information included in each are explained in
the following:

Caution
All cautions have this form and symbol. Do
not disregard cautions. They are
installation, operation, or maintenance
procedures, practices, conditions,
statements, and so forth, which if not
strictly observed, may result in damage to,
or destruction of, equipment or may cause
a long term health hazard.

Note
Notes have this form and symbol. Notes contain
installation, operation, or maintenance procedures,
practices, conditions, statements, and so forth,
that alert you to important information which may
make your task easier or increase your
understanding.

1.7 ENVOX Documents

Although ENVOX software is your primary configuration tool, the
documentation is also a tool for getting the most value out of developing
an effective configuration. Different users require different documentation
support, depending on their background and the tasks they are doing.
Documentation available for ENVOX configuration software, version P3.4,
includes the following items:
J Installation manual, Installing ENVOX Configuration Software on DEC
VAX and DEC AXP Systems, PN6.1:SW3151:VMS (Revision A —
July 1996): describes ENVOX system requirements and provides
instructions for installing ENVOX software on DEC VAX and DEC
AXP computers running the DEC OpenVMS operating system.

UM6.1:SW3151 Revision H — July 1996

 Introduction 1-7

J Installation manual, Installing ENVOX Configuration Software on

HP-UX Systems, PN6.2:SW3153:HPX, (Revision B — July 1996):
describes ENVOX system requirements and provides instructions for
installing ENVOX software on HP computers running the HP-UX
operating system.
1
J User manual, Using ENVOX Configuration Software, UM6.1:SW3151
(Revision H — July 1996): describes how to use ENVOX
Configuration Software to configure your PROVOX system databases.
Includes generating, downloading, uploading, trace and tune
functions, diagnostic procedures, and documenting.

J Tutorial, ENVOX Tutor, TU1.0:SW3151 (Original — June 1991): takes

you through an example of a configuration, introducing you to the
configuration process in general. After completion, you will be able to
configure a device, create several point types, and design a display
for process operators.

J Technical reference, The Technical Reference for ENVOX

Configuration Software, TR1.0:SW3151 (Revision F — July 1996):
provides information about the structure of ENVOX configuration data,
and procedures for reading and changing this data. The manual also
defines the ASCII format (CDV format) used to import data into the
ENVOX configuration database. ENVOX software uses a relational
database for data storage, retrieval, and manipulation.

J System Manager’s manual, The System Manager’s Guide to ENVOX

Configuration Software, SM1.0:SW3151 (Revision D — July 1996):
describes the features available in ENVOX configuration software for
the ENVOX system manager. The features let the system manager
tailor the software to each user and to structure the ENVOX system to
support multiple databases and users.

J Open Database Manual, Installing and Using the ENVOX Open

Database, UM6.2:SW3152 (Revision E — July 1996): describes how
to use the Open Database Module built into ENVOX software and the
Type SW3152 Open Database PC Client Server Software.

J On-line help screens: describe the menu options, forms, and each
field on the forms, and provide navigation help. The screens are
embedded in the ENVOX software.

J Configuration engineering manuals: describe the functions of the

PROVOX products so that you can apply the right functions to your
process. The manuals provide guidelines for using ENVOX forms
specific to the associated product.

J Relational database documentation: You can purchase ENVOX

software with or without the SYBASE relational database software.
When you purchase ENVOX software with SYBASE software, you
also receive a complete set of relational database documentation.

Revision H — July 1996 UM6.1:SW3151

 1-8 Introduction

1.8 Related Documentation

You need the configuration engineering manuals for PROVOX consoles,
1 controllers, and the other devices that make up your PROVOX
instrumentation system. The following list identifies these manuals by title
and catalog number.

J Configuring the SRx Controller Family, CE12.0:CL6640 (Volumes 1

and 2)

J Configuring the 20-Series (SR90) Controller Family, CE10.0:CL6633

(Volumes 1 and 2)

J Configuring the 20-Series (SR90) Controller Family, CE4.2:CL6623

J Configuring Type DM6001 and DM6003 Multiplexer Units,

CE4.11:DM6001

J Configuring CL6010, CL6210, and CL7010-Series Interactive and

Computing Controllers, CE4.2:CL6211

J Configuring the Operator Workplace Console, CE11.0:DC9400

J Configuring the PROVUEr Console, CE7.0:DC6400

J Configuring the DH6200-Series Computer/Highway Interface Package

(CHIP) Software, CE8.0:DH6200

As other products are released, configuration engineering manuals are

made available for them.

1.9 Where to Find Answers About This

Product or Manual
Fisher-Rosemount Systems’ goal is to provide products and
documentation that exceed your needs. If you have questions or
comments about this product or manual, please contact your
Fisher-Rosemount Systems representative or sales office.

To help us evaluate how well this manual fills your needs, please
complete and send in the evaluation form located in the front of this
manual. We also appreciate your suggestions on ways to improve any
page of the manual. Please mark your suggestions on a copy of the page
and include it with the evaluation form. Thank you for providing this
information.

UM6.1:SW3151 Revision H — July 1996

 PROVOX System Overview 2-1

Figure 2-Table 2

2 PROVOX System Overview 2

This section provides background information about PROVOXr process

management systems to help you understand how ENVOXr software
works within the system. PROVOX systems monitor and control batch
and continuous processes in many industries, including the manufacture
of chemicals, food items, and pharmaceuticals.
PROVOX systems are made up of hardware (with embedded firmware)
and software. The hardware consists of PROVOX devices and devices
from other vendors that communicate with each other to provide a
functional system. The software includes PROVOX application programs
and operating software containing the system functionality. You use
ENVOX software to create a PROVOX system configuration which is
customized to your process control needs.

2.1 PROVOX Devices

Figure 2-1 is a block diagram of a PROVOX system.

Process
I/O I/O I/O I/O

Regulatory
Controllers
Unit Integrated Multi-
Operations Function plexers
Controllers Controllers
DCU

Data Highway

CHIP

Operator Application
PROVUEr
Workplace Computer/
Console
Console Workstation

Figure 2-1 PROVOX System Hardware

Revision H — July 1996 UM6.1:SW3151

 2-2 PROVOX System Overview

The paragraphs below provide a brief description of the families of

PROVOX devices which are configured with ENVOX software:

J PROVOX Data Highway and PROVOX Highway II — are the

communications paths for PROVOX devices.

2 J Traffic Directors and Communications Interface Cards (not

shown) — Control the communications between devices on a
PROVOX Data Highway. Local traffic directors (LTDs) control a local
plant area; network traffic directors (NTDs) control interconnected
local plant areas.

J Bridges and Communications Interface Cards (not shown) —

Control the communications between devices on a PROVOX Highway
II. Local area highways and network highways can be implemented.

J I/O Subsystems — Provides interface between process I/O field

devices and the PROVOX system.

J Regulatory Controllers — Provide single-loop and interactive

single-loop process control calculations, as defined by you, which
determines the specific process control and monitoring the controller
does.

J Data Concentrator Units (DCUs) — Buffer communications between

a PROVOX highway system and regulatory controllers.

J Unit Operations Controllers (UOCs) — Provide unit operations (and

in conjunction with console software, batch) process control
calculations, as defined by you, which determines the specific process
control and monitoring the controller does.

J Integrated Function Controllers (IFCs) — Provide integrated

multi-loop continuous process control calculations, as defined by you,
which determines the specific process control and monitoring the
controller does.

J Multiplexers (MUXs) — Provide data acquisition from process field

devices, such as flow, level, and temperature transmitters, and return
data to final control elements. Multiplexers do not provide control
functions.

J Operator Workplace and PROVUE Consoles — Provide operators

with a way to monitor and control the process, as defined by you. The
consoles are the home for displays and certain point types.

J Intelligent Device Interface (IDI) (not shown) — Integrate

programmable logic controller data into the PROVOX system.

J Computer/Highway Interface Packages (CHIPs) — Provide plant

computers with access to the PROVOX system database. Such
access enables users to do calculations for optimization, reporting,
process analysis, and other plant-management tasks.

UM6.1:SW3151 Revision H — July 1996

 PROVOX System Overview 2-3

2.2 Application Software

Application software packages extend the capabilities of the software
resident in the devices. Typical packages include the Type SW2011 Data
Historian, Type SW3152 Open Database PC Client Software, and the
Type SW2035 Process Data Server.
2
2.3 Configuration
The configuration is an application program which you develop to define
how your PROVOX system works to control the process at your plant.
The configuration is made up of:
J Device definitions
J Points (using logic or algorithms)
J Templates
J Logic or algorithms
J Displays
Figure 2-2 illustrates the relationships among these configuration items.
The following subsections define the items.

DEVICE A CONSOLE
DEFINITION DEFINITION

POINT POINT

POINT DISPLAY

TEMPLATE

POINT
DEVICE B DISPLAY
DEFINITION
POINT TEMPLATE POINT

POINT

POINT

POINT

TEMPLATE

X00248:SW3151-0

Figure 2-2 Configuration Item Relationships

Revision H — July 1996 UM6.1:SW3151

 2-4 PROVOX System Overview

2.3.1 Device Definitions

Device definitions identify the types of devices in a PROVOX system,
determine their highway addresses, and establish limits necessary for
their operation.

2
2.3.2 Points
Within each device are one or more points. Points are the software
building blocks of the configuration. Each point is a storehouse for
information within the process-control database. The point includes data
and the action necessary to perform a particular control task.

The data in a point is a unique set of operating, tuning, and, configured

parameters. Operating parameters can include the actual process
variable (PV), such as the level in a vessel or the value you want the
control system to maintain (setpoint). Tuning parameter values are values
that you can change from a console. For example, you can change the
gain, reset, and, rate values of a loop point. Configured parameter values
are values that you cannot change from the console. You can only
change configured values by downloading the device from ENVOX
software. The configuration engineering manuals discuss point
parameters in more detail.

A point also provides action — the process of data manipulation and

calculation necessary to achieve the control and monitoring objectives of
that point. A point’s action may be inherently defined by the point,
selected from a list of standard algorithms, or defined in a template or
instruction set by you.

Finally, a point also may include several important services. For example,
communications services allow other devices in the system to retrieve
and use the data in a point. Another point service is alarm handling.
Process changes activate alarms that can show up on displays, and
sound console horns and other audible devices. The trace facility is a
service that enables you to step through a control strategy and verify that
it works correctly before connecting it to the process.

UM6.1:SW3151 Revision H — July 1996

 PROVOX System Overview 2-5

Figure 2-3 is a conceptual representation of points.

Point TAG
Point TAG
Point TAG
2
DATA ACTION SERVICES
Operating Defined by point Commu-
Tuning User-selected nications
Configured algorithm Alarm
User-written Trace
(template or
instruction set)

ALGORITHM
X00249:SW3151-0

Figure 2-3 Conceptual Representation of Points

Points are of several types; each type performs specific functions. For
example, there are simple input and output point types that acquire data
from field devices or send signals out to field devices. These point types
include analog input (AI), analog output (AO), discrete input (DI), discrete
output (DO), and pulse count input (PCI). The action for these point types
is defined by the point itself. The action is a simple manipulation of
discrete or analog data.

Loop points maintain a process variable at a user-specified setpoint. You

select the specific action for these points by selecting a standard
algorithm; for example, proportional (P), integral (I), derivative (D), or a
combination of these.

A discrete control device (DCD) point coordinates the control of one or

more discrete field devices such as pumps and motors. A user-written
template determines the action for a DCD.

A more complex point, called a unit point, provides an execution

environment for programs called operations that can automate an entire
batch process. Operations are user-written using the ENVOX language
editor.

To create a point, you use one of the point types as a basic structure,
then define:

J The data the point uses

J The action or how the point manipulates the data

J The device in which the point resides

Revision H — July 1996 UM6.1:SW3151

 2-6 PROVOX System Overview

For example, here are the general steps for creating a loop point:

Step 1: Select the type of point you want to create: loop

Step 2: Select the data the point uses, for example, the initial setpoint
and tuning parameters.
2 Step 3: Select the action, for example, PID

Step 4: Select the device, for example, UOC1

You may also target the point to one or more devices. Targeting a point to
a device (the target device) ensures that the configuration system
updates the target device with data from the point. Subsection 2.3.3
describes targeting.

Because points provide a large degree of flexibility and several control

functions, most of the configuration is based on points. This manual
explains how to create new points. The manual also explains ways to
improve your configuration productivity by copying and modifying existing
points and by using default point data.

2.3.3 Point Reporting

Point reporting determines what data is available to PROVOX devices
over the PROVOX system highway. You determine how a point reports its
data and to what devices, through targeting. Each time you create a point,
you select the devices targeted for that point’s data. A point can report its
data according to three modes:

J Periodic — The point reports its data to its target devices at one of
several rates that you select.

J Periodic by Exception — The point reports its data to its target

devices at a rate you select, but only if the data value changes by an
amount that you specify or if the alarm status changes.

J Change-of-State — The point reports its data whenever the point’s

alarm status changes or if a discrete input changes state.

Subsection 5.1.1 provides a more detailed introduction to targeting. The

configuration engineering manuals provide targeting details with regard to
specific devices and point types.

UM6.1:SW3151 Revision H — July 1996

 PROVOX System Overview 2-7

2.3.4 Templates
Templates are related process monitor and control signals organized
together in the process database. There are four template types:

J Discrete templates
2
Group

DCD

J Batch templates

Alias

Unit definition

A group template treats a group of DCDs like one device. In many

process applications, a group of such devices has a definable
combination of on and off states. For example, in one stage in the
process, pumps 1 and 2 must be off, and pumps 3 and 4 must be on. A
group template lets you define one command that places all four pumps
in the correct state. This is just one example of a template. The
configuration engineering manuals for SR90 and SRx controllers provide
more information about discrete and batch templates.

2.3.5 Logic
The controllers and consoles also have the ability to perform logic and
sequence programs. These programs, called function sequence tables
(FSTs), operations, or procedures, are used to perform complex
calculations, interlocking strategies, advanced control strategies, time
sequencing, and batch unit operations and recipes. The ENVOX
software’s language editor lets you configure these programs as well as
console reports and display color expressions.

Revision H — July 1996 UM6.1:SW3151

 2-8 PROVOX System Overview

2 3
4LIC-4 4FIC-4
TANK LEVEL PRODUCT FLOW
23.000 1.000
2
16.103 0.515
16.000 0.514
INCHES GPM
4FI-10 5 4VALVE 0.000 0.000
0.500 SP:OPEN MODE:AUTO MODE:RSP
PV:OPEN ALARM: ALARM: DEV
MODE:MAN RSP
FT

LT

FT
4 4PUMP
SP:ON
PV:ON
MODE:MAN
4FIC-4 1TIC-202 1TIC-202 1TIC-202 1TIC-202 1TIC-202 MORE OAL
DSPLY:LEVEL LOOP 2 PRINT
X00250:SW3151-0

Figure 2-4 Example of a Console Display

2.3.6 Displays
Displays use bar graphs, trend graphs, and symbols of field devices to
provide graphic representations of what is happening in the process. You
create the displays using ENVOX software. The displays are used at the
operator console. A single console can have hundreds of displays. The
instructions for creating displays are in the configuration engineering
manuals for operator consoles. Figure 2-4 is an example of a display.

UM6.1:SW3151 Revision H — July 1996

 ENVOX Software Overview 3-1

Figure 3-Table 3

3 ENVOX Software Overview

ENVOXr configuration software is your tool for engineering and
maintaining the configuration of a PROVOXr system. 3

3.1 Product Media

ENVOX configuration software includes ENVOX P3.4, OPEN DATABASE
P1.2, SYBPRELIM100, SYBASE System 10.0 (including APT and Open
Client) supplied on appropriate media, as follows:

J Software for Type SW3151 ENVOX Configuration Software (ENVOX

DEC VAX) is supplied on TK50 tape.

J Software for Type SW3153 ENVOX Configuration Software (ENVOX

HP-UX) is supplied on 4mm DAT cartridge tape.

J Software for Type SW3155 ENVOX Configuration Software (ENVOX

DEC AXP) is supplied on 4mm DAT cartridge tape.

3.2 Computer Requirements

Computer hardware and software requirements vary depending on the
platform on which you are running ENVOX software. The requirements
are provided in the installation manual for the particular ENVOX software
package. To determine the correct installation manual, refer to subsection
1.7. which lists available ENVOX documentation.

3.3 Configuration Planning and Design

This manual approaches the topic of configuration assuming that you
have completed the initial top-down design of your process. That is, you
have identified the general operator interface and control strategies, and
you have developed the P. & I.D. drawings that illustrate the process flow
and input/output (I/O) needs.

In addition, this manual assumes that you have documented your I/O
needs in an instrument index or instrument specification sheet, or
perhaps by using ENVOX Instrument Signal Tags (ISTs). Finally, this
document assumes that you have identified your basic control needs by
documenting the loops, batch descriptions, and logic required to support
your process.

Revision H — July 1996 UM6.1:SW3151

 3-2 ENVOX Software Overview

Now, you want to proceed in a way that takes full advantage of ENVOX
software and the PROVOX system while making effective use of your
time. The following steps describe one effective way to approach
configuration planning.

Step 1: Define control conventions.

For example, determine a consistent way to control motors

and pumps and control strategies such as cascade loops.
3
Step 2: Identify your control strategies and the I/O that supports them.

For example, the I/O that supports a specific loop or unit of

batch control typically uses the same controller. Group your
I/O based on the strategy.

Step 3: Define the operator interface.

Consistent operator interface includes how display elements

appear and how aspects of your process appear. For example,
is water colored blue or white? Also, the operator interface
should provide a consistent way to display point data.

One of the most crucial aspects of operator interface is alarm

management. PROVOX operator consoles let you define
alarm priorities and apply these priorities to groups of alarms.
Furthermore, you can configure the characteristics of these
alarm groups to change as the state of the process changes.
Read the section on plant organization in your PROVUEt
console or Operator Workplace console configuration
engineering manual before determining your alarm display
conventions.

Step 4: Proceed to the configuration engineering and maintenance

tasks, as described in subsection 3.4.

UM6.1:SW3151 Revision H — July 1996

 ENVOX Software Overview 3-3

3.4 Configuration Engineering and

Maintenance Tasks
Figure 3-1 illustrates the normal flow of configuration tasks. The figure
also shows the ENVOX feature you use to do the task. The paragraphs
below define the tasks.

3
3.4.1 Creating Configuration Data

Creating the configuration data includes these activities:

Create device definitions — You name the types of hardware devices in

the system. You also identify their locations on the highway, specify the
I/O hardware, and establish limits necessary for their operation. This is
the device definition.

Create Instrument Signal Tags (ISTs) — For each field or instrument

signal, you create an item called an Instrument Signal Tag that identifies
the signal’s file-card-channel (F-C-C) location and defines the signal
characteristics, such as signal type, EU range, and alarms. PROVOX
points reference ISTs for their respective I/O signal characteristics.
Subsection 5.1.3 describes ISTs in more detail.

Create templates — You create templates as you create points, because

certain types of points reference templates.

Create points — You copy and modify existing points and add new
points. You provide the point with a tag (name) and define its operating,
tuning, and configured parameters. You specify which device each point
is located in, and you also specify the devices to which the point reports
data (targeting).

Create algorithms — Using the ENVOX language editor, you build

function sequence tables (FSTs), reports, operations, procedures, and
color and text conditionals for displays. The configuration engineering
manuals for the products related to FSTs, operations, procedures, and
color and text conditionals provide more information.

Create displays — Using the ENVOX display editor you create the
displays for the operator consoles. You also specify which consoles
contain which displays.

Create reports — Using the language editor, you design reports that
record process changes. You also determine which console manages
each report.

Revision H — July 1996 UM6.1:SW3151

 3-4 ENVOX Software Overview

Configuration and Maintenance Task ENVOXR Feature

Create Configuration Data
Create Device
Definitions

Create Templates Item Forms

Create Points
3
Create Displays Display Editor

Create Algorithms
-- FSTs Language Editor
-- Operations
-- Procedures

Create Console
Reports Language Editor

Generate Generation Options

on forms
Download
-- Total
-- Partial Download Utility
-- Backup
-- Emergency

Algorithm Testing Trace/Tune Utility

Upload Tuning Parameters Upload Utility

Maintenance Diagnostics Utility

Document Document Database

Change Management Audit Trail

Figure 3-1 Configuration and Maintenance Tasks and the ENVOX Features That
Provide Them

Transfer PROFLEXâ Database — Do this step first if you have

configuration files from a PROFLEX configuration device. A migration
utility converts PROFLEX ASCII files into a format that ENVOX software
can use. Your PROFLEX databases must be at version P3.0 or later to
migrate. A migrate utility is included in PROFLEX P5.0 software for
migrating from version P5.0. If your PROFLEX software is not at version
P5.0, you may order a migration tape from your Fisher-Rosemount
Representative or sales office.

UM6.1:SW3151 Revision H — July 1996

 ENVOX Software Overview 3-5

3.4.2 Generate
The ENVOX generate option checks the consistency of the data which
ENVOX software did not already verify as you entered it. The generate
option then creates download files which are ready to be downloaded to
the PROVOX devices.

3.4.3 Download
3
The download utility sends the generated data to the devices. The
download can be total; that is, the utility sends all the generated data to
all the devices you specify. Or the download can be partial: you limit the
download to include only new or modified data for the devices. The
download can include one or more than one device, depending on the
your login privileges.

3.4.4 Trace/Tune
After ENVOX software downloads the configuration files to the devices,
the trace/tune utility lets you tune control loops and test FSTs. Without
affecting the process, this utility lets you enter simulated analog and
discrete inputs for an on-line controller. You can observe the controller
outputs resulting from this simulation to determine whether the FST is
functioning correctly.

3.4.5 Upload
Once the devices have their configuration download files and are on-line,
console operators can change the device tuning parameter values.
Uploading is the process of updating the ENVOX configuration database
with these changes.

3.4.6 Maintenance
Using the ENVOX diagnostics utility, you can identify specific device
errors and even trace the source of intermittent faults. Diagnostic displays
provide extensive coverage of system conditions.

3.4.7 Documentation
Using the documentation utility, you create documents that record your
configuration—all the points, devices, and so on.

3.4.8 Audit Trail

After the initial configuration is complete, you can enable the audit trail
utility to track changes to the database.

Revision H — July 1996 UM6.1:SW3151

 3-6 ENVOX Software Overview

3.5 ENVOX User Interfaces

This subsection describes ENVOX user interfaces and how they support
the configuration process. ENVOX user interfaces include:
J Menus
J Forms

3 J Display editor
J Language editor
J Utilities
J Icons
J On-line help

3.5.1 Menus
ENVOX software is menu-driven. Using menus, you navigate through the
forms, editors, and utilities necessary to create and maintain the system
configuration. The menu system also has on-line help that describes the
function of each selection on a menu. Selection of menu options is driven
by the task you are performing.
ENVOX menus, described below, appear in the following format:
J Menu bar
J Pull-down menus
J Slide-off menus

3.5.1.1 Menu-Bar
The menu-bar appears when you select a form using the top-level menu
hierarchy. Figure 3-2 shows the menu bar for the pulse count input (PCI)
point.

3.5.1.2 Pull-Down Menus

Pull-down menus appear when you select some menu-bar menu options.
Figure 3-3 shows a pull-down menu. As you move the cursor over a
menu option, the option is typically in reverse video, although the exact
appearance depends on your terminal or workstation setup.

3.5.1.3 Slide-Off Menus

Slide-off menus appear when you select certain options from a pull-down
menu. Subsection 3.5.6 describes the menu options that have a slide-off
menu. Figure 3-3 shows a slide-off menu.

UM6.1:SW3151 Revision H — July 1996

 ENVOX Software Overview 3-7

3.5.2 Forms
Forms are screens with fields that you fill in. Forms enable you to create
device definitions, points, and global items. They also let you verify
configuration data and generate configuration download files. Each form
includes one or more prompts with blank fields. Figure 3-2 shows a form
for a point. You type in the information for each field as necessary. You
can tab or backtab between fields. Many fields provide a list of valid
selections that you can access through the Values List key. Smaller forms
called pop-up forms are prompts, and are typically used for entering a tag
3
before proceeding to some configuration task.

PCI POINT
X Edit Utilities Extra Data Target! Help

ADD PI-12L
Inlet Flow Rate for Tank #12A

Device v : UOC1 Rate Function Enbl : YES

YES NO
Index : (Auto) Rate Filter Enbl : YES
YES NO
Description : TANK-12A INLET Rate Filter Time : 10
Strategy : TANK12A
Resource Attr : Instrument Signal v : PC1-122CH
Signal Device UOC1
Off Scan : NO
YES NO Local MUX Address 1-6-2
Conversion Const 30.0
Scan Rate : 0.1 0.2 0.5 1 2 5 10 30

EV039

Figure 3-2 Item Form for a PCI Point

The software checks the validity of your entry as you enter it. ENVOX
software checks things such as range, valid values, relationship to other
points, and so on. If you make an error, an error message pops up. If you
don’t have all the data for all the fields, fill in those you know and leave
the rest blank. ENVOX software allows you to enter the remainder later,
when the information becomes available.

Revision H — July 1996 UM6.1:SW3151

 3-8 ENVOX Software Overview

Forms also provide the basic interface format for utilities such as
generate and download. Most forms have the same basic display
elements. Figure 3-3 shows a form and the display elements:

J ENVOX Form Name — Names the form which you have called up.

J Menu Bar — The location of the form menus and various icons.
Subsection 3.5.6 describes how each icon works.
3 J Work Area — The area for entering and viewing form data. The work
area is also where pull-down and slide-off menus appear.

J Pull-Down and Slide-Off Menus — The menus that list related menu
options. Subsection 3.5.1 describes menu organization.

J Mouse Pointer — A pointer that reflects the movement of your

mouse, if you use one.

J History Area — The area on item configuration forms where the

history of a database change is shown if the Audit Trail is turned ON
and there has been a change in the database.

Motif Menus ENVOXr Form ENVOX Form Name ENVOX Form Motif
Menus Window

ENVOX TOP LEVEL FORM

X Add Modify! Utilities More
More Status! Help o Menu
Bar
Generate
Download -> Menu
Document Bar Icon
Upload
Diagnostics
IAC Trace/Tune Work
LCP Trace/Tune Area
Administration
Dbase
Dbase Management
Management --> Export Utility
Audit Trail Import Utility

History
Area

Mouse Pointer Pull-Down Menu Slide-Off Menu EV001

Figure 3-3 ENVOX Form Elements

UM6.1:SW3151 Revision H — July 1996

 ENVOX Software Overview 3-9

3.5.3 Display Editor

The display editor lets you create and edit Operator Workplace console
and PROVUE console graphic displays. The editor helps you create
objects (for example: boxes, circles, lines, polygons, faceplates, and ISA
symbols), move objects, duplicate objects, and group objects for cut and
paste functions.
When running on various workstations or X terminals, the display editor
allows you to use the mouse interface to manipulate graphic elements. 3
Detailed procedures for using the display editor are described in the
Operator Workplace console and PROVUE console configuration
engineering manuals.

3.5.4 Language Editor

The language editor lets you create and edit control algorithms for
continuous, discrete, and batch control. Control algorithms include FSTs
for continuous or discrete logic, operations and procedures for batch
strategies, and color and text conditionals for console displays. When
using the language editor, you may enter comments, a command, or ask
for help. Figure 3-4 shows a typical screen.

{
This step fills the premix tanks and then starts the heating cycle
}
0001:ACQUIRE (PM-TANK) { Acquire the premix tank }
0002:ACQUIRE (INLET-A) { Aquire raw material A }
0003:CONST (INLET-A, OPEN) { Open valve for raw material A }
0004:CONST (PUMP-A, ON) { Begin pumping raw material A }
0005:WAIT UNTIL (PV:’LEV’ >= 50.0, 00:01S, CWEN) { Wait for 50% level }
0006:CONST (PUMP-A, OFF) { Turn pump off }
0007:CONST (INLET-A, CLOSE) { Close valve }
0008:RELEASE (INLET-A) { Release lock on raw material
A }
0009:ACQUIRE (INLET-B) { Aquire raw material B }
0010:CONST (INLET-B, OPEN) { Open valve for raw material B }
0011:CONST (PUMP-B, ON) { Begin pumping raw material B }
0012:WAIT UNTIL (PV:’LEV’ >= 80.0, 00:01S, CWEN) { Wait for 80% level }
0013:CONST (PUMP-B, OFF) { Turn pump off }
0014:CONST (INLET-B, CLOSE) { Close valve }
0015:RELEASE (INLET-B) { Release lock on raw material
B }
0016:CONST (HEATER, ON) { Start heating cycle }
0017: WAIT UNTIL
expression >> PV:’TANK TEMP’ >= 185.0
time >>
wait type >>
comment >>s

Operation: FILLTANK-1A3 Step: WAITONLEVEL3

Message: Enter time to evaluate expression minutes:seconds (mm:ss)
X00253:SW3151-0

Figure 3-4 Example Language Editor Screen

Revision H — July 1996 UM6.1:SW3151

 3-10 ENVOX Software Overview

When you enter a command, the editor prompts you for the associated
operands required. The editor also checks the validity of instructions as
you enter them and prompts you with an error message if it finds
problems. The editor lets you indent lines of code from the left margin to
show levels of IF logic or GO TOs.
The editor allows unlimited commenting. You can place comments at the
end of a line of code or between lines. Your comments can occupy as
many lines as you need. Each comment line can contain as many as
3 255 characters.
While the editor is active, ENVOX software provides on-line help pertinent
to the type of editing you are doing. The editor also enables you to search
for and replace text strings.
In addition, the language editor is used to configure operator console
reports. The user positions fields on a format line to show the software
where it should print each value. Next, the editor prompts for the source
of each field, for example, the tag or attribute name.

3.5.5 Utilities
ENVOX software includes the following utilities:
J Generate Utility — Generates configuration data for the devices on a
PROVOX highway.
J Download Utility — Transmits configuration files to the devices on a
PROVOX highway. Also included with the download utility is the ability
to make backup copies of the downloaded data and to create
emergency download files.
J Documentation Utility — Offers a variety of formats for documenting
your configuration. This documentation is a hardcopy of your devices,
their addresses, and the points that reside in them.
J Upload Utility — Updates the configuration database with tuning
changes.
J Diagnostics Utility — Troubleshoots PROVOX instrument faults to
the board level.
J Trace/Tune Utility — Tests and debugs control strategies.
J Administration Utility — Used by your ENVOX system manager to
structure ENVOX software to your plant operation and to troubleshoot
the ENVOX system.
J Export and Import Utility — Brings comma delimited values (CDV)
data into an ENVOX database (import) and moves the data from one
database to another (export).
J Audit Trail Utility — Records changes made to the ENVOX
database.

UM6.1:SW3151 Revision H — July 1996

 ENVOX Software Overview 3-11

3.5.6 Icons
ENVOX configuration software provides several icons. These are:
Figure 3-3 shows an example of some of these icons:

X The exit icon is on the lefthand of the menu bar and on pop-up
forms. Select this icon with the X letter key, or click on the icon
with the mouse to back the software out of the present
function.
3
—> The slide-off menu icon appears next to pull-down menu
options that have slide-off menus. The Dbase Management
menu option in Figure 3-3 shows this icon.

! This icon has two meanings. It appears next to menu options

that have no menu options below them in the hierarchy. When
you select an option of this type, the software performs the
related action or, in other cases, accesses a new form.
Options without an ! have a pull-down menu. This icon also
appears in the menu bar of the current form when you press
the Gold key in order to select a menu in the menu-bar.

@ The user-wait icon appears at the right side of the menu bar
when the software is processing some information. You cannot
use the software while this icon is visible.

o The overstrike mode icon appears when you are typing in

overstrike mode. No icon indicates that you are working in
insert mode.

P The P icon appears when you are printing.

3.5.7 Menu Keys

A menu key is a single character which allows you to select a specific
menu option. In a menu name, the highlighted letter indicates the
character to use to select that menu. Menu keys are displayed in the
menus on the menu bar and on the pull-down and slide-off menus. On the
ENVOX forms, the keys are shown in reverse video or underlined. See
Figure 4-1 for many of the menu keys, designated in boldface.

Revision H — July 1996 UM6.1:SW3151

 3-12 ENVOX Software Overview

3.5.8 On-Line Help

ENVOX software provides the following types of help:

J Form help — Available for device definition, point, and template

forms. Form help explains briefly how the point or device type works.
To get form help, you must be inside a form and select the Help option
from the menu-bar. Then select Form from the pull-down menu
option. To exit, press the Gold key and X.
3
J Field help — Available for fields in device definition, point, and
template forms. Field help provides information about the field on
which the cursor resides; for example, a description, range, special
conditions, and examples of how the field is used. It provides
immediate information for easy reference. To get field help, select the
Help! option from the menu-bar. Then select Field from the pull-down
menu. To exit, press the Gold key and X to get back to the form you
are working on.

J Keyboard help — Lists the function keys available for a form. To get
keyboard help, select the Help! option from the menu-bar. Then select
Keyboard from the pull-down menu option. To exit, press the Gold key
and X.

J Language-editor help — Provides a list of valid instructions,

describes each valid instruction, describes each valid operand, and
defines the keys used for navigating in the editor. Section 7 describes
language editor help in more detail.

J Display-editor help — Defines the keys used in the display editor.

See the appropriate console configuration engineering manual for
further information.

UM6.1:SW3151 Revision H — July 1996

 Starting and Navigating Through ENVOX Software 4-1

Figure 4-Table 4

4 Starting and Navigating

Through ENVOX Software
This section describes how to startup ENVOXr software and also the
details of navigating through ENVOX forms, using a keyboard only and a
keyboard and mouse. Several figures illustrate the the path through 4
pull-down menus, showing how to arrive at the operation or device with
which you wish to work. Study this section carefully before attempting
your first navigation in ENVOX software.

4.1 Starting ENVOX Software

Note
The steps below describe the general procedure
for logging into ENVOX software. Your ENVOX
system manager can alter the procedure. For
example, your system manager can modify your
account to start the software automatically when
you log into your computer.

To start ENVOX configuration software, enter the following at the prompt:

Step 1: Depending on the operating system:
J VMS command
$ ENVOX
J UNIX: command
$ envox
The software displays the ENVOX Login Screen and your user
name next to the User name prompt. The cursor is positioned
at the Password prompt.
Step 2: If your ENVOX user name is the same as your operating
system user name, enter your ENVOX password. If you have
a different ENVOX user name, press the Previous Field key,
backspace over the user name, and enter the correct user
name and password.

Revision H — July 1996 UM6.1:SW3151

 4-2 Starting and Navigating Through ENVOX Software

Step 3: At this point, you can suppress warning messages that are
normally given when you enter data on forms. To suppress
warnings, select the Warning Status menu bar option.
Subsection 5.12 describes warnings and how to determine
when to suppress them. You can also suppress warnings
using the Status! option on the ENVOX Top Level Form
described in subsection 4.6.

4.2 Navigating Through ENVOX Software

4 When you first log on to ENVOX software, it displays the ENVOX Top
Level Form. In the menu bar of this form are six menus you use to access
the rest of the ENVOX forms. Figure 4-1 shows the menus you see when
you select these options. The Help menu lets you access on-line help
screens, and the Status! menu provides information about your
configuration system (see subsection 4.6).

Note that, like the ENVOX Top Level Form, the configuration forms also
contain menus in the menu bar and various pull-downs menus, which
may lead to additional slide-off menus. How you navigate through the
menus depends on whether you use a mouse or a keyboard. Subsection
4.2.1 describes navigating with a mouse, and subsection 4.2.2 describes
navigating with a keyboard.

UM6.1:SW3151 Revision H — July 1996

 Starting and Navigating Through ENVOX Software 4-3

ENVOX TOP LEVEL FORM

X Add Modify! Utilities More Status! Help

Menu Bar
Form Form Selections

Pull-Down Menus Showing Menu Options

UOC/IFC/SR90 POINTS -> Generate 4

CONSOLE POINTS -> Download ->
CHIP POINTS -> Document
OTHER POINTS -> Upload
DEVICES -> Diagnostics
LOGIC -> IAC Trace/Tune
INSTRUMENT SIGNAL LCP Trace/Tune
GLOBAL ITEMS -> Administration
Dbase Management ->
Audit Trail

View Field PF3

Rename Item Form
Item Copy Keyboard
Copy Console Configuration
Display Editor
Tag Set ->
Highway Access Control List
Delete
Special Functions ->

Figure 4-1 ENVOX Top Level Form Menu Hierarchy (part 1 of 6)

Revision H — July 1996 UM6.1:SW3151

 4-4 Starting and Navigating Through ENVOX Software

AI
ENVOX TOP LEVEL FORM AO
X Add
Add Modify! Utili
LOOP
UOC/IFC/SR90 POINTS -> DI
CONSOLE POINTS -> ACCUMULATION DO
Forms
CHIP POINTS -> ACTIVITY DCD
OTHER POINTS -> DCD GROUP
Forms
DEVICES -> LCP
4 MAINTENANCE
LOGIC ->
* EPCI UNIT
INSTRUMENT SIGNAL INTEGRITY OTHER ->
*
GLOBAL ITEMS ->
*
AI
AO INTEGER
REAL LOOP
ASCII LCP
Forms
GROUP EPCI Forms
DCD ACCUMULATION
DI DM
DO PDO
MORE -> MORE ->
*
CONFIGURABLE DCP Forms
MUX POINTS ->
**
IAC/COMPUTING POINTS ->
**
PCIU POINTS ->
**
SINGLE DISCRETE Forms

PROVUE
WPCON
SR90
UOC/IFC
CONFIGURABLE
IAC/COMPUTING Forms

MUX
PCIU
TREND
EV041--2
CHIP
* Expanded on part 3 of this figure.
LCON
** Expanded on part 4 of this figure.

ENVOX Top Level Form Menu Hierarchy (part 2 of 6)

UM6.1:SW3151 Revision H — July 1996

 Starting and Navigating Through ENVOX Software 4-5

LCP FST
Forms
ENVOX TOP LEVEL FORM OPERATION
X Add
Add Modify! Utili
CONSOLE REPORTS->
*
UOC/IFC/SR90 POINTS ->
CONSOLE POINTS ->
PROCEDURES ->
CONDITIONAL COLOR
*
Forms
CHIP POINTS -> CONDITIONAL TEXT
OTHER POINTS ->
DEVICES -> ALIAS TEMPLATE
LOGIC -> DCD TEMPLATE 4
INSTRUMENT SIGNAL Form GROUP TEMPLATE
GLOBAL ITEMS -> PMA
PPA Forms
ALARM PRIORITIES
UOC/IFC/SR90 POINTS:
USER DEFINITIONS
AI APPLICATION
AO USER DEFINED KEY
LOOP USER PALETTE
DI
DO
DCD
GROUP EPCI
LCP PCI EV041--3

UNIT DM Forms
OTHER -> PDO
FIELDVUE AO

CHIP POINTS —> MORE:

INTEGER
LOOP
LCP 4-BIT DISCR
EPCI LOOP RATIO
ACCUMULATION LOOP BIAS Forms
DM LOOP BIAS & RATIO
PDO MON DEVIATION
MORE -> REF DEVIATION

* Expanded on part 4 of this figure.

ENVOX Top Level Form Menu Hierarchy (part 3 of 6)

Revision H — July 1996 UM6.1:SW3151

 4-6 Starting and Navigating Through ENVOX Software

Forms

AO -> STD AO
OTHER POINTS: STD AI EXT AO
EXT AI REC AO
CONFIGURABLE DCP
STD AC2
MUX POINTS ->
EXT AC2
IAC/COMPUTING POINTS->
STD DO
PCIU POINTS ->
4 SINGLE DISCRETE
EXT DO
DI
PCI

DCP
ANALOG ICP
DISCRETE ICP

AO
AI
DISCRETE

Forms

LOGIC:

LCP FST REPORT

OPERATION REPORT HEADER
CONSOLE REPORTS-> EQUIPMENT LIST
Forms
PROCEDURES ->
CONDITIONAL COLOR PROCEDURE
CONDITIONAL TEXT PROCEDURE LIST

ENVOX Top Level Form Menu Hierarchy (part 4 of 6)

UM6.1:SW3151 Revision H — July 1996

 Starting and Navigating Through ENVOX Software 4-7

ENVOX TOP LEVEL FORM

X Add Modify! Utilities More Status! Help

View
Rename Item
Item Copy Forms
Copy Console Configuration
Add
Display Editor
Tag Set ->
Modify Forms
4
Delete
Highway Access Control List
Forms
Delete
Upgrade UOC/IFC
Special Functions ->
Upgrade UOC/IFC To SR90 I/O
Upgrade PROVUE
Upgrade PROVUE To WPCON

ENVOX Top Level Form Menu Hierarchy (part 5 of 6)

ENVOX TOP LEVEL FORM

X Add Modify! Utilities More
More Status! Help

Generate Forms
Download -> Download
Document Download Backup
Upload Backup All Devices
Diagnostics Backup To ED Files ->
Forms
IAC Trace/Tune All Devices
LCP Trace/Tune Single Device
Administration
Dbase Management -> Export Utility
Audit Trail Import Utility

ENVOX Top Level Form Menu Hierarchy (part 6 of 6)

Revision H — July 1996 UM6.1:SW3151

 4-8 Starting and Navigating Through ENVOX Software

4.2.1 Navigating With a Mouse

The following describes how to select menus and exit from the ENVOX
Top Level Form with a mouse:

J To select a menu from the menu bar of a form:

Step 1: Point to the menu you want.

Step 2: Click the left mouse button. The menu options appear in a
pull-down menu, unless the menu name ends with an !. In
4 this case, selecting the menu takes you directly to the
menu function.

J To select a pull-down menu option:

Step 1: Move the mouse pointer to the menu option you want and
click the left mouse button.

Step 2: Depending on the option you selected, one of three

responses happens: a new form appears, the ENVOX
software executes the command associated with the
option, or a slide-off menu appears if the option has one.

J To select a slide-off menu option, move the mouse pointer to the

option you want and click the left mouse button.

J To back through one menu at a time, click on the previous menu.

J To back through all the displayed menus, click with the pointer
anywhere off the displayed menus. This action removes all the
slide-off and pull-down menus from the screen. The ENVOX Top
Level Form or form-level menu remains.

J To exit from the ENVOX Top Level Form, click on the X icon.

UM6.1:SW3151 Revision H — July 1996

 Starting and Navigating Through ENVOX Software 4-9

4.2.2 Navigating With a Keyboard

The following describes how to select menus and exit from the ENVOX
Top Level Form with a keyboard:

J To select a menu from the menu bar of a form:

Step 1: Press the Gold key to get to the menu bar.

Step 2: Type the highlighted letter of the menu you want; or use
the left and right arrow keys to select the menu, and press
Return. The menu options appear in a pull-down menu,
unless the menu name ends with an !. In this case,
4
selecting the menu takes you directly to the menu function.

J To select a pull-down menu option:

Step 1: Type the highlighted letter of the option; or use the up and
down arrow keys to select the desired option, and press
Return.

Step 2: Depending on the option you select, one of three

responses happens: a new form appears, ENVOX
software executes the command associated with the
option, or a slide-off menu appears if the option has one.

J To back through one menu at a time, press the left arrow key.

J To back through all the displayed menus, press the right arrow key.
This removes all the slide-off and pull-down menus from the screen.
The menu in the menu bar remains.

J To exit from the ENVOX Top Level Form, press the Gold key followed
by X. If you wish to confirm the exit, press Return. If you decide not to
exit the software, use the right arrow key to move away from the X,
and select a menu from the menu bar.

4.2.3 Using Fast Access Keys

Fast access keys (sometimes called Accelerator keys) are function keys
which represent a menu option selection. These keys are listed, when
they exist, next to the slide-off menu entry. The listing reminds you that
you can use the function key instead of navigating in the normal way. For
instance, PF3 on the VMS platform is listed next to Field in the pull-down
menu option of the Help menu. Therefore, if you are in a form and need
help understanding the field, you can press PF3, and you are taken
immediately to the help information. Figure 4-1 (part 1 of 6) shows how a
function key (in this case, PF3) is listed in a menu.

Revision H — July 1996 UM6.1:SW3151

 4-10 Starting and Navigating Through ENVOX Software

4.3 Navigating and Entering Data in Forms

ENVOX software provides forms for creating device definitions, points,
and templates. Forms have fields, prompts, and menus. Most fields are
blanks into which you enter data. Other fields contain information that the
ENVOX software enters. Fields followed by a colon require data from you;
fields without colons are read-only fields, which are filled in by the
ENVOX software.

Each field has a help screen that defines the prompt and explains the
4 type of information the field requires. The software checks the validity of
the data as you enter it and displays errors and warnings. Subsection
5.12 defines errors and warnings in detail. Menus on the forms let you
edit, print, and save the data.

Each point type, device type, and template type has its own form or series
of forms. Figure 4-2 shows an item form for a pulse count input (PCI)
point and identifies some important characteristics described later in this
section.

4.3.1 Calling Up an Item Form

You call up an item form with the Add or Modify menu options from the
ENVOX Top Level Form’s menu bar. Subsections 5.1 and 5.3 explain how
to use the Add and Modify menu options.

4.3.2 Navigating Inside a Form

The navigation instructions in the following subsections explain how to
move the cursor inside a form and how to add and edit data. Various
function keys are named and explained. For quick reference, the keys
with their functions are listed in Appendix C.

4.3.2.1 Moving the Cursor From Field To Field

You can move from field to field one of several ways, depending on the
type of field (see subsection 4.3.4 for a description of three types of fields):

J For fields requiring typed input or input from a valid entries list, you
can move by pressing Return, Tab, or the Next Field Key, or by using
the arrow keys or a mouse.

J For visible choice fields, you can move by pressing the Tab or the
Next Field key, or by clicking on the next field with the mouse pointer.

UM6.1:SW3151 Revision H — July 1996

 Starting and Navigating Through ENVOX Software 4-11

Prompt Valid Entries List is Available Field with Data Visible-Choice Fields

File Edit Commands Options Print Help

PCI POINT
X Edit Utilities
Utilities Extra Data Target! Help

ADD PI-12L
Inlet Flow Rate for Tank #12A

Device v : UOC1 Rate Function Enbl : YES

YES NO 4
Index : (Auto) Rate Filter Enbl : YES
YES NO
Description : TANK-12A INLET Rate Filter Time : 10
Strategy : TANK12A
Resource Attr : Instrument Signal v : PC1-122CH
Signal Device UOC1
Off Scan : NO
YES NO Local MUX Address 1-6-2
Conversion Const 30.0
Scan Rate : 0.1 0.2 0.5 1 2 5 10 30

EV040
Read-Only Data

Figure 4-2 PCI Point Item Form

All fields on a configuration form are inactive and do not accept data until
you activate them. Moving from one field to the next using the Return,
Tab, or the Next Field key (and mouse pointer) activates the next field.
Activating a typed input field or a valid entries list field, causes a broken
line to appear next to the field name, indicating that the field is now ready
for data input. Moving from field to field using the arrow keys does not
activate the next field unless you place the cursor in the field and press
the Return key.

4.3.2.2 Moving the Cursor Within a Field

When the cursor is in a field not activated for editing, the cursor moves
left and right in response to the left and right arrow keys. The up and
down arrow keys move the cursor out of the field.

To edit a different field, press Tab, the Next Field key or the Previous
Field key. Unless you are in a visible choice field, you can also move the
cursor to another field and press Return to activate the field.

Revision H — July 1996 UM6.1:SW3151

 4-12 Starting and Navigating Through ENVOX Software

4.3.3 Exiting a Form

To exit a form, press the Gold key to get to the menu bar, then press X.
Or, if you have a mouse, click on the X icon with the mouse. The software
asks you to Apply or Quit. Apply and Quit are options that the software
gives you during a number of different tasks described in this manual.

Generally, Apply saves data to the database unless you are in an extra
data form. Subsection 5.1.2 describes the Apply option on extra data
forms. Quit does not save data. The exact consequences of Apply and
Quit depend on the task you are doing. Make sure you read the
4 descriptions for Apply and Quit that pertain to the task so that you
understand the consequences.

If you decide not to exit the form, use the right arrow key to move away
from the X, and select a menu from the menu bar.

4.3.4 Entering Form Data

There are four ways to enter data into a field:

J Type it in.

J Select from choices displayed on the screen. (Fields that display

choices are called visible choice fields.) The default for these fields is
null.

J Select from a list that appears if you press the Values List key.

J Use the default data.

Regardless of how you enter the data, you can edit by back spacing over
the entry and typing in other characters, or for visible-choice fields, by
selecting another visible choice. You can erase an entire field by pressing
the Erase Entry key.

You can edit in Insert of Overstrike mode. Ctrl-a toggles between the
modes. While in overstrike mode, the top right of the menu bar displays
an o.

Note that when entering an exponential number, the software accepts

numbers according to the format 10.6e--9. The software accepts numbers
within the range of --9.99e+37 to 9.999e+37. However, highway devices
cannot support this same range. For example, UOC/IFC and SR90
controllers have absolute limits as follows:

5.4210e--20 to 9.2233e18 and --2.71e--20 to --9.223e18

ENVOX software allows the entry of 9-character floats. If larger numbers

are required, ISQL can be used and the numbers be displayed with the
correct truncation in forms.

UM6.1:SW3151 Revision H — July 1996

 Starting and Navigating Through ENVOX Software 4-13

4.3.4.1 Selecting from a Visible Choice Field

Fields with only a few valid entries show the entries. These fields are
called visible-choice fields. To select a visible choice, move the cursor to
the choice you want using the left and right arrow keys, then press
Return. Figure 4-2 includes examples of visible-choice fields.

4.3.4.2 Selecting from a Values List

Fields followed by the letter v provide pop-up lists of valid entries for you
to select from. Do the following to select from a valid entries list:
4
Step 1: Press the Values List key to display the valid values.
Step 2: Move the cursor to the correct value or selection and press
Return. The ENVOX software automatically writes the
selected value into the field, and exits the values list. If you are
using a mouse, you can click on the correct entry and the
software writes that entry to the field, and exits the values list.
If the values list is longer than the window displaying it, the list
can be scrolled using the scroll form keys on the side of the
window.
As an alternative to using the valid entries list, you can type in the entry
directly. If the entry is a user-defined string like a tag, you simply type the
tag.
There is an additional feature for these fields that allows you to enter a
partial string and if it is unique, it is expanded into its full value when you
tab from the field. If the value is not unique, an error message is
displayed and you are re-positioned to the field and you have to correct
the value.
For example, on the Action DI form, the valid types are DISCRETE
OUTPUT, CONSTANT DBI, COPY DBI, and UNIT COMMAND.
J If you enter COP, the value is accepted and expanded to COPY DBI.
J If you enter CO, the value is rejected and an error message stating
that the entry is ambiguous is displayed. You are re-positioned on the
field until a valid entry or unique string is entered.
J If a totally invalid string is entered such as ABC for this example, the
normal rule violation message is displayed. Again, you are
re-positioned on the field until a valid entry is made.
Valid entry lists may or may not change as the configuration changes. For
example, the Device v field in Figure 4-2 accesses a dynamic entry list:
the list contains devices currently configured in the database and is
updated every time a new device is configured. The PCA Type v field on
the loop configuration form accesses a fixed valid entry list: the list
contains five PCA types that never change.

Revision H — July 1996 UM6.1:SW3151

 4-14 Starting and Navigating Through ENVOX Software

4.3.4.3 Searching in a Values List

Some lists contain a small number of selections, while others contain
many selections. Fields with long lists of entries do not allow you to see
complete lists. You may limit the list by entering a search string. Enter a
search string using the information in Table 4-1. For example, to modify a
point that you know begins with L, type L in the Modify field and press the
Values List key. The ENVOX software then displays the partial entry list of
points beginning with L. If no values match the search string, the software
displays:

4 No non-null values for this field

Note that the search function for valid entries is case sensitive. Because
the ENVOX software stores all tags in uppercase letters, use uppercase
letters when specifying search strings.

Table 4-1 Search String Characters for Valid Entry Lists

Character Description Example Search Strings
% Wildcard for %FIC01 — Searches for entries that end with
character strings the string FIC01
FIC01% — Searches for entries that begin
with the string FIC01
%FIC01% — Searches for entries that
include the string FIC01
_ (underline) Wildcard for a TANK_AO — Searches for entries that begin
single character with the word TANK and have AO as the sixth
and seventh characters. You may wish to add
% to the end of the search string to pick up
longer items.
[] For a single LIC[a—f], or LIC[abcdef] — Searches for
character within a entries beginning with the letters LIC, with a
range fourth letter a, b, c, d, e, or f. You may wish to
add the percent sign (%) to the end of the
search string to pick up longer items.
[^] For a single LIC[^a—f] or LIC[^abcdef] — Searches for
character not entries beginning with the letters LIC and a
within a range fourth character other than a through f. You
may wish to add the percent sign (%) to the
end of the search string to pick up longer
items.

UM6.1:SW3151 Revision H — July 1996

 Starting and Navigating Through ENVOX Software 4-15

4.3.4.4 Using Default Data

ENVOX software includes a set of default data for each item type. The
tags for default items begin with two exclamation marks (!!) so that you
can distinguish them from other items in the database. The exclamation
marks tell the ENVOX software generator to ignore these points.

You can automatically enter default data into the current form using the
Default Values key. For example, if you are creating a new PROVUE DCD
point, call up the Add DCD Point form and press the Default Values key.
The software fills in the default data from the !!PROVUE DCD default tag
for this form only. To automatically enter the default data for the 4
sub-forms, call up each form and press the Default Values key.

Note
The default data feature does not copy group field
data. Examples of group fields include the console
user display list or UOC analog input (AI)
extended alarms.

Using the Modify form, you can modify the content of default items
(except for the Target Data form and sub-forms) to suit your configuration
needs. To enter customized target data, use Pattern Tags, described
below, and the Item Copy menu option.

Table 4-2 lists the ENVOX software default tags. To call up the same list
using the software:

Step 1: Select Modify on the ENVOX top-level menu.

Step 2: Enter ! on the TAG field.

Step 3: Press the Values List key for a list of all tags that begin with !!.

Revision H — July 1996 UM6.1:SW3151

 4-16 Starting and Navigating Through ENVOX Software

4.3.4.5 Using Pattern Tags

Pattern tags are a configuration productivity tool. Basically, you create a
pattern tag for items that you need several of. You can then copy all parts
of the pattern tag to a particular form by using one of the Copy utilities.
One exclamation point precedes a pattern tag. The exclamation points tell
the ENVOX software generator to ignore these points so pattern tags do
not interfere with your actual configuration.
If you want to fill in a form and all its sub-forms with pattern-tag data, use
the Item Copy menu option. If you only want to fill in an individual form or
sub-form with predefined data, use the Copy Form option under the Edit
4 top-level menu. See subsection 5.7 of this manual for additional details on
the Item Copy and Copy Form menu options.
One of the most useful applications of pattern tags is to create a large
number of new points with the same attributes. To do this, create a tag set
of new tag names and then use the Item Copy menu option to copy
predefined data from a pattern tag into all the points in the tag set.

Table 4-2 ENVOX Software Default Tags

ENVOX Tag Type
!!AI AI
!!AO AO
!!CCNTRLLR IAC CONTROLLER
!!CDSCRTCP IAC DISCRETE ICP
!!CHIP CHIP
!!CHIP AI CHIP AI
!!CHIP AO CHIP AO
!!CHIP ASCII CHIP ASCII
!!CHIP DCD CHIP DCD
!!CHIP DI CHIP DI
!!CHIP DM CHIP DM
!!CHIP DO CHIP DO
!!CHIP EPCI CHIP EPCI
!!CHIP GROUP CHIP GROUP
!!CHIP LCP CHIP LCP
!!CHIP LOOP CHIP LOOP
!!CHIP PDO CHIP PDO
!!CHIP REAL CHIP REAL
!!CHIPBTDSCRT CHIP 4-BIT DISCRETE
!!CHPCCMLTN CHIP ACCUMULATION
!!CHPLPBS CHIP LOOP BIAS

UM6.1:SW3151 Revision H — July 1996

 Starting and Navigating Through ENVOX Software 4-17

Table 4-2 ENVOX Software Default Tags (Continued)

ENVOX Tag Type
!!CHPLPBSRT CHIP LOOP BIAS + RATIO
!!CHPLPRT CHIP LOOP RATIO
!!CHPMNDVTN CHIP MON DEVIATION
!!CHPNTGR CHIP INTEGER
!!CHPRFDVTN CHIP REF DEVIATION
!!CNFGRBLCNT CONFIGURABLE CONTROLLER
!!CNFGRBLDCP CONFIGURABLE DCP 4
!!CNLGCP IAC ANALOG ICP
!!DCD DCD
!!DCDTMPLT DCD TEMPLATE
!!DI DI
!!DM DM
!!DO DO
!!EPCI EPCI
!!FIELDVUEAO FIELDVUEAO
!!GROUP GROUP
!!GRPTMPLT GROUP TEMPLATE
!!IAC DCP IAC DCP
!!IST INSTRUMENT SIGNAL TAG
!!LCON LCON
!!LCP LCP
!!LCP FST LCP FST
!!LOOP LOOP
!!LRMPRRTY ALARM PRIORITY
!!LSTMPLT ALIAS TEMPLATE
!!MUX MUX
!!MUX DI MUX DI
!!MUX EXT AI MUX EXT AI
!!MUX EXT AO MUX EXT AO
!!MUX EXT DO MUX EXT DO
!!MUX PCI MUX PCI
!!MUX REC AO MUX REC AO
!!MUX STD AI MUX STD AI
!!MUX STD AO MUX STD AO
!!MUX STD DO MUX STD DO
!!MUXEXTAC MUX EXT AC2

Revision H — July 1996 UM6.1:SW3151

 4-18 Starting and Navigating Through ENVOX Software

Table 4-2 ENVOX Software Default Tags (Continued)

ENVOX Tag Type
!!MUXSTDAC MUX STD AC2
!!NSTRMNTSGN INSTRUMENT SIGNAL
!!OPERATION OPERATION
!!PCDSCRT PCIU DISCRETE
!!PCI PCI
!!PCIU PCIU
4 !!PCIU AI PCIU AI
!!PCIU AO PCIU AO
!!PDO PDO
!!PMA PMA
!!PPA PPA
!!PPLCTN APPLICATION
!!PRCDRLST PROCEDURE LIST
!!PROCEDURE PROCEDURE
!!PROVUE PROVUE
!!PROVUE DCD CONSOLE DCD
!!PROVUEEPCI CONSOLE EPCI
!!PRVCCMLTN CONSOLE ACCUMULATION
!!PRVCTVTY CONSOLE ACTIVITY
!!PRVMNTNNC CONSOLE MAINTENANCE
!!PRVNTGRTY CONSOLE INTEGRITY
!!QPMNTLST EQUIPMENT LIST
!!RPRTHDR REPORT HEADER
!!SNGLDSCRT SINGLE DISCRETE
!!SRDFNDKY USER DEFINED KEY
!!SRPLTT USER PALETTE
!!TARGET AI
!!TREND TREND
!!UNIT UNIT
!!UOC SR90/UOC
!!USER NAME USER NAME
!!WPCON WPCON

UM6.1:SW3151 Revision H — July 1996

 Starting and Navigating Through ENVOX Software 4-19

4.3.5 Form Navigation Keys

Appendix C defines all of the control and function keys for form
navigation.

4.3.6 Navigating and Entering Data in Group Fields

Some forms have special fields called group fields that allow you to
access many rows of data within a small number of lines. You make
additional rows of data visible by scrolling. Figure 4-3 shows an example
of group fields as found on the Operator Display List form. 4

OPERATOR DISPLAY LIST

X Edit Utilities Extra Data Target! Help

Type PROVUE MODIFY CON425

NO. Display v Display Display Display Overview
No. Forward v Backward v
15 FACEPLATES_ 38 TEST TEST YES NO
16 HELP 39 HELP HELP YES NO
17 LCP FAILURE 24 UNITFAILURE ACTFAILURE YES NO
18 MAINTENANCE 35 SYS PMA/PPA DEV PMA/PPA YES NO
19 MUX316 FP1 7 MUX316 FP2 MUX316 FP2 YES NO
20 MUX316 FP2 8 MUX316 FP1 MUX316 FP1 YES NO
21 OVERVIEW 13 OVERVIEW OVERVIEW YES NO
22 SYS PMA/PPA 40 DEV PMA/PPA1 MAINTENANCE YES NO
23 TEST 37 FACEPLATES FACEPLATES YES NO
24 TREND 36 TREND TREND YES NO
25 UNITFAILURE 25 ACTFAILURE1 LCP FAILURE1 YES NO
26 UOC416 FP1 11 UOC416 FP2 UOC416 FP2 YES NO
27 UOC416 FP2 12 UOC416 FP1 UOC416 FP1 YES NO
28 UOC420 FP1 1 UOC420 FP2 UOC420 FP2 YES NO
29 UOC420 FP2 2 UOC420 FP1 UOC420 FP1 YES NO

EV042

Figure 4-3 Group Field Example

The paragraphs that follow provide instructions for using forms with group
fields.
J To move to the bottom of a group, and to make additional rows visible,
press Next Screen.
J To back up to previous rows, press Prev Screen.
J To delete a row of data, press the Erase Row key.
J To insert a blank row at the current position, press the Insert Row key.

Revision H — July 1996 UM6.1:SW3151

 4-20 Starting and Navigating Through ENVOX Software

J If your terminal shows scroll icons on the right side of the work area,
you may use these to scroll in the field.

Some forms with group fields have a menu option called X-List. Selecting
the X-List option moves the cursor out of a group field into the next field.

Note that the register forms in the LCP point extra data series of forms
have a unique user interface in order to keep registers 0 through 4 visible
(registers 1 through 4 contain information about operator read write
privileges). The forms are: the LCP Boolean Registers form, the LCP
Integer Registers form, and the LCP Floating Point Registers form. The
4 group fields in these forms show 12 registers at a time (0-12). Registers 0
through 4 do not support the scrolling keys. To access registers 12
through 31, make sure your cursor is on register 5 or higher.

For the Operator Display List, Grade List, and Procedure List, and many
other forms, ENVOX software requires that the entries in the list have no
blank rows. If you use the Erase Entry key to delete an entry, the software
prevents you from moving off the fields of this row, you must supply data
for the row. To delete the data in a row, use the Erase Row key to delete
the row. Similarly, you cannot insert a blank row using the Insert Row key.
When you use the Insert Row key, the software creates a row but
requires you to supply data for it.

4.3.7 Finding Data

You can use the FIND function to locate tags, error numbers and other
bits of data in long lists. to use the FIND function:

Step 1: Place the cursor in the field that you want to search. If you
have a group with several fields in it (like the Display List),
position the cursor in the field (column) you want to search.

Step 2: Press the Find Row key. The software prompts you for a
search string.

Step 3: Enter the specific text to search for, or a search string.

UM6.1:SW3151 Revision H — July 1996

 Starting and Navigating Through ENVOX Software 4-21

4.4 Printing Forms Data

The Print option on the form-level Utilities menu prints the data for the
displayed item, including related target and extra data information, in the
forms format.

You can also use the document option to create a variety of reports that
include point data. Section 14 describes the document option.

To print data for a displayed item:

Step 1: Select the Utilities item-level menu. 4

Step 2: Select the Print option.

PCI POINT
X Edit Utilities Extra Data Target! Help

Save
Print
Show Errors
Ad Hoc Tag Set

4.5 Printing Screens

You can print help screens or any displayed ENVOX form. To do so on a
MicroVAX 3100, display the screen and press Ctrl-Shift-6. On a
VAXstation 3100 and VAXstation 4000, press the left mouse button in an
area of the screen that is blank, select the Print option, then use the
mouse (hold down the left mouse button) to select the area of the screen
to be printed.

Revision H — July 1996 UM6.1:SW3151

 4-22 Starting and Navigating Through ENVOX Software

4.6 Using the Status Page Form

The Status Page form allows you to review the status of the databases in
your configuration system. From the Status Page form, you can also
review information about disk space allocation in your databases.

4.6.1 Accessing the Status Page Form

To access the Status Page form:
Step 1: Select the Status! option from the ENVOX Top Level Form.
4

ENVOX TOP LEVEL FORM

X Add Modify! Status!
Utilities More Status! Help!

The software displays the Status Page form (Figure 4-4). The fields on
the form are read only.

STATUS PAGE
X! Database Config Warnings Space Used! Help

Current product revisions are :

ENVOX (FORMS) _____ 12B3229

SYBASE _____
VAX/VMS _____

Current system status :

Default Database __________________ Configuration Warnings ____

Current Database __________________ Free Space ____ Mb
Last Database Backup __________________ Verify Mode ____
Last Database recovery __________________ Audit Trail ____

Figure 4-4 Example of Status Page Form

Step 2: Exit this form or continue to the Database Space Information

form (See subsection 4.6.3).

UM6.1:SW3151 Revision H — July 1996

 Starting and Navigating Through ENVOX Software 4-23

The menu bar of the Status Page form includes Database and Config
Warnings pulldown menus to be used as follows:

Database — Enables you change between the current database or a

default database. If you wish to change to another database, go to
subsection 4.6.2.

Config Warnings — Enables you to suppress warnings. The option

provides a YES/NO pull-down menu.

Spaced Used! — You may select Space Used! in the Status Page form
menu bar to view detailed information about disk space usage. See
subsection 4.6.3.
4
The paragraphs below describe the fields on the form.

Current product revisions — Shows the revision levels for the software
running on your ENVOX system. An additional field to the right contains
information such as factory part number, customer-special product
number, and Modkit number.

Default Database — Shows the name of the selected default database.

Current Database — Shows the name of the selected current database.

Last Database Backup — Shows the date, hours, and minutes of the
last time that the database was backed up. If the database has never
been backed up, the display is NEVER BACKED UP.

Last Database Recovery — Shows the date, hours, and minutes of the
last time that the database was recovered. If the database was never
recovered, the display is NEVER RECOVERED.

Configuration Warnings — Shows the ON/OFF status for configuration

warnings.

Free Space — Shows the total space in megabytes (rounded to the

nearest whole number) used by data within the tables. If ???? is
displayed, the value has not been calculated by the system. Your system
manager can program the system to calculate the value, if necessary.

Verify Mode — Shows the ON/OFF status for Verify Mode.

Audit Trail — Shows the ON/OFF status for configuration warnings.

Revision H — July 1996 UM6.1:SW3151

 4-24 Starting and Navigating Through ENVOX Software

4.6.2 Reading the Status of Other Databases

The Database menu option lets you change between the current
database and a default database. To change to another database:

Step 1: Select the Database option. A pulldown menu appears.

Step 2: Select Default on the pull down menu. The following popup
form appears.

STATUS PAGE
4 X! Help

Default Database v : __________________

Step 3: Enter the name of the database on the pop-up form.

You may enter the name of the database directly, or you may
display a list of all databases on the Sybase server by
pressing the Values List key to obtain the valid entries list. If
you know the first letters of the database name, enter these
letters and press the Values List key. A list of all databases
whose names begin with the letters you entered is displayed.

If you select an entry from the values list, you must press Tab
to enter the database name. A different database can only be
selected if the current user is authorized in that database.

If you enter the name directly, enter the name in the same
case as it exists in the system. The database name is case
sensitive and is not converted to upper case. If you enter the
name from the values list, select the desired name and press
Return.

If the chosen database name is considered to be unusable by

SYBASE, an error is issued and another name must be
chosen.

UM6.1:SW3151 Revision H — July 1996

 Starting and Navigating Through ENVOX Software 4-25

4.6.3 Viewing Disk Space Usage Information

The Space Used! option in the menu bar of the Status Page form lets you
view detailed information about disk space usage. To view this
information:
Step 1: Select the Space Used! option.
The software displays the Database Space Information form (Figure 4-5).

4
DATABASE SPACE INFORMATION
X! Recalculate! Help

DATABASE _______________________________

Values calculated on _____________________________

MBytes %

Total Database Space ________ ________

Overhead Space ________ ________

Configuration Space ________ ________

Configuration Space ________ ________

Used configuration Space ________ ________
Reserved Configuration Space ________ ________

Free Configuration Space ________ ________

Figure 4-5 Example of Database Space Information Form

Step 2: Exit and Quit this form.

If the selected database is an ENVOX or Open Database, the information
displayed on the Database Space Information form normally appears
quickly. If the selected database is not an ENVOX or Open Database, the
information displayed on the Database Space Information form may take
extended time to appear.
The paragraphs below describe the fields in the form.
DATABASE — The name of the selected database.
Values calculated on — Valid responses are either the date, hours, and
minutes of the calculation or NEVER CALCULATED if no space
information exists for the selected database.
Total Database Space — Shows the total space used for all data and log
segments allocated for the database.

Revision H — July 1996 UM6.1:SW3151

 4-26 Starting and Navigating Through ENVOX Software

Overhead Space — Shows the total space used by the log segments
and the space taken by overhead data, such as system tables, stored
procedures, triggers, rules, and so on.

Configuration Space (shown twice) — Shows the total space which is

available for the configuration data of the database.

Used Configuration Space — Shows the space already used for the
configuration data of the database.

Reserved Configuration Space — Shows the space reserved for use by

4 tables which are not yet saved.

Free Configuration Space — Shows the space not already used or held
in reserve.

MBytes — Space calculations are shown in megabytes.

% — Total space calculations are shown as 100%; other calculations are

shown as percentages of 100%.

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-1

Figure 5-Table 5

5 Creating and Editing Device

Definitions, Points and
Templates
This section describes how to use forms to create and edit device
definitions, points, and templates. This section uses the term item, or
configured item, when discussing device definitions, points, and 5
templates, collectively.
Section 6 explains how to improve your productivity when creating items
by using tag sets. You do not need to use tag sets when configuring an
instrumentation system. However, after becoming familiar with the
information in this section, you may want to read about tag sets before
creating your configuration.

5.1 Adding an Item to the Database

This subsection provides guidelines for adding any item — such as a new
device definition, new point, or new template — to the configuration
database. All items are added in a similar way, regardless of the item.
This subsection uses the creation of a device as an example of how to
create any item. To create a device definition, do the following:
Step 1: Select the Add menu from the ENVOXr TOP LEVEL FORM.
The options for the Add menu appear.

ENVOX TOP LEVEL FORM

X Add
Add Modify! Utilities More Status! Help

UOC/IFC/SR90 POINTS ->

CONSOLE POINTS ->
CHIP POINTS ->
OTHER POINTS ->
DEVICES ->
LOGIC ->
INSTRUMENT SIGNAL
GLOBAL ITEMS ->
EV046

Revision H — July 1996 UM6.1:SW3151

 5-2 Creating and Editing Device Definitions, Points and Templates

Step 2: Select the menu option for the type of item you want to create.
See Figure 4-1 for a complete display of slide-off menus. The
software displays an ENTER TAG popup form:

ENTER TAG
X! Set Item Type! Help

Item Type:
Add :

5 The Item Type field is read-only. It shows the type of item

which is being added. The Set Item Type! menu option is not
used with the Add function.

Step 3: Type in the tag name for the device you want to create and
press Return. If you want to return to the previous tag name
which you entered, press the Last Tag function key.

If you have returned to the previously entered tag, you can

change one character in the field, such as UOC1 to UOC2. If
you have entered an invalid name for the previous tag, the
name will not be displayed when you press the Last Tag
function key.

A tag is a unique name associated with an item in the

database. Tags may have as many as 12 characters, with at
least one alpha character. Legal characters are:

J 0 through 9

J A through Z

J - . , / (space)

The first character cannot be a space.

When you enter a valid tag name, the form for the device type
appears.

Note
Refer to the device configuration engineering
manual and to the help screens available through
the form Help menu option to determine what data
you must enter on the device form.

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-3

Step 4: Enter the data into the form using the methods described in
subsection 4.3.4. Most forms have a menu bar that includes
the menus Target! and Extra Data. The following subsections
describe these options.

Step 5: If you want to exit the main form, press the Gold key to get to
the menu bar; then select X. Select Apply or Quit. Apply saves
your data to the database, Quit does not.

5.1.1 Target Option

Targeting point data establishes reporting between a point and other
devices in the database. When you target point data, you specify the
devices which the point reports to, the reporting rate and deadband, and 5
so on. The point that reports to the devices is called a source point. The
receiving devices are called target devices. Target devices include
consoles, CHIPs, Trend Units, and UOCs.

To target a point, select the Target! menu in the menu bar of the point’s
form.

PCI POINT
X Edit Utilities Extra Data Target!
Target! Help

EV054

The Target Data form includes fields for target data, such as reporting
mode, deadband, and so on. The form also provides fields for the target
devices. The devices you enter here are members of a target group.
These are the devices that use the same target data. Enter the names of
the devices that require the same target data.

If you want to target the point data to other devices, but with different
target data (for example, with a greater reporting interval), create a new
target group. Do this by selecting the New! menu option on the Target
Data form. You may create as many target groups as you need to
accommodate the different target data required by each device.

To view these different target groups, select Next!. This option displays
target data for the next group.

Revision H — July 1996 UM6.1:SW3151

 5-4 Creating and Editing Device Definitions, Points and Templates

For 10-Series, 20-Series, and 20-Series (SR90) controllers, consoles,

and trend devices, additional target forms appear beneath the Target
Data form. These forms must be completed or the target points will be
noted as incomplete. You cannot access these additional forms unless
devices of the appropriate types (consoles, trend units, or batch
controllers) have been previously configured. Figure 5-1 shows the
position of these different target forms in the forms hierarchy.

Source Point Forms

Target Data
5
Console Data Trend Data UOC Data

Console
UOC Ext Alarms
Extended Alarms

UOC PT
Compensation

UOC Action DI

Figure 5-1 Target Forms Hierarchy

To leave the targeting forms, exit and select Apply or Quit:

J Apply — Saves the current data that is in the form you are viewing
and returns to the form from which this form was called. For example,
exiting from the UOC Action DI form returns you to the UOC DI Point
form.

Note
When you Apply from a target form, the data is not
saved to the database until you select Exit and
Apply from the item’s main form.

J Quit — Returns to the form from which this form was called without
saving any data you entered.

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-5

5.1.2 Extra Data

Many items require configuration of several forms to complete the
configuration data. The Extra Data menu option enables an engineer to
access all required forms from the main form (the form that appears first
when you begin configuring the item).

Select Extra Data to access additional forms. Additional forms may

include the instrument signal tag, primary control algorithm (PCA)
definition, database definitions, and so on. The configuration engineering
manuals (CEs) describe specific Extra Data options for each device.

5
Caution
Exiting and applying from an extra data
form back to the main form does not save
the extra data to the database. ENVOX
software saves the extra data to the
database only when you select Apply from
the main form. Quitting from the main form
results in a loss of all extra data not
previously saved through the main form.

Select Apply to exit from an extra data form.

Revision H — July 1996 UM6.1:SW3151

 5-6 Creating and Editing Device Definitions, Points and Templates

5.1.3 Instrument Signal Tags (ISTs)

Instrument Signal Tags (ISTs) link PROVOXr points to their respective
field I/O signals. ISTs provide a facility to store and easily maintain field
signal data.

In the life cycle of a typical process instrumentation and control project,

you gradually create a database of process information. You start with
P & I diagrams and from these you develop instrument lists. You may
accumulate field instrument data such as signal type (for example,
4-20mA, 1-5 volt, pulse count, and resistance temperature detector),
ranges, alarm limits, and PROVOX I/O termination channels long before
you are ready to start assigning these signals (channels) to their
corresponding PROVOX points. Ideally, you maintain this instrument data
5 in the ENVOX database and use it when you begin point and logic
configuration.

ISTs provide you with the flexibility to log instrument signal data
independently from point and logic configuration. ISTs link PROVOX
points to their I/O signals and define the characteristics for each signal.
The characteristics are:

J Strategy

J Signal type

J Signal direction (input, output, input/output)

J Device tag and file number

J Card number

J Channel number

J Engineering units and ranges

J Signal inversion status

J Alarm values

The process controller configuration engineering manuals describe these

IST parameters in detail.

ISTs also minimize the impact hardware changes have on configuration.

For example, if a field signal characteristic such as range changes, you
only need to modify the data associated with the IST. The ENVOX
software then automatically updates all references to this IST by way of
its relational database.

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-7

By purchasing additional Sybase modules (for example, Data Workbench

or APT Workbench), users can expand the standard IST tables with their
own field instrument signal data. This data can include such items as the
following to be stored with its associated process signal data:

J Transmitter purchase information

J Transmitter maintenance history

J Associated I/O affected when a transmitter is serviced and instructions

on how to control and maintain associated I/O when servicing a
transmitter

In addition, the data contained in the spreadsheets of the

Fisher-Rosemount Systems Instrument Information Systemt (IIS) are 5
accessible through the Open Database Server Software embedded in
ENVOX software. Transferring the data to your ENVOX configuration can
simplify the configuration process. For more information, see the user
manual, Installing and Using the ENVOX Open Database,
UM6.2:SW3152.

More than one IST can reference the same signal source, that is, the
same file-card-channel (F-C-C). Thus, you can specify different alarms
and ranges for the same I/O signal—a useful feature when defining points
that reference the same signal data but require unique alarm values.
Modifications to one IST have no effect on other ISTs referencing the
same signal source. However, modifying IST data does affect multiple
points referencing that IST.

You must use ISTs to configure PROVOX points. Even points with pseudo
I/O have F-C-C, engineering units, and ranges associated with them and
consequently require ISTs. Points cannot be generated successfully
without configured ISTs.

Revision H — July 1996 UM6.1:SW3151

 5-8 Creating and Editing Device Definitions, Points and Templates

5.1.3.1 Creating Instrument Signal Tags (ISTs)

You configure an IST for each field I/O signal. Most point types reference
one I/O signal and thus one IST. Three point types, loop, discrete control
device (DCD), and discrete monitor (DM), can use multiple I/O signals. If
a point has multiple inputs and outputs, you must configure multiple ISTs
to support it.
Whether a point references one or multiple ISTs, most points have a
primary IST on their configuration form. The primary IST specifies a
point’s engineering unit (EU) range and alarms. For I/O points such as
analog input (AI), analog output (AO), discrete input (DI), and discrete
output (DO), the primary IST references the F-C-C for that I/O signal,
whether real or pseudo. For loop points, the primary IST defines the
5 loop’s engineering unit range, and alarms, but not necessarily the loop’s
input F-C-C, because a loop can obtain its input from logic, another
point’s attribute, or an F-C-C.
Create an IST in one of two ways: through the ENVOX Top Level Form or
through a point configuration form. The top-level method enables you to
create and modify ISTs before beginning point configuration. Creating
ISTs through the point forms is a convenient method to create or modify a
point’s primary IST during point configuration.

5.1.3.2 Creating ISTs from the Top Level

To create or modify an IST through the ENVOX Top Level Form:
Step 1: Select the Instrument Signal option from the Add menu.

ENVOX TOP LEVEL FORM

X Add
Add Modify! Utilities More Status! Help

UOC/IFC/SR90 POINTS ->

CONSOLE POINTS ->
CHIP POINTS ->
OTHER POINTS ->
DEVICES ->
LOGIC ->
INSTRUMENT SIGNAL
GLOBAL ITEMS ->
EV055

Step 2: An ENTER TAG pop-up form prompts you to enter an

instrument signal tag. Note that tags are unique within the
ENVOX database — two instrument signals cannot use the
same tag.

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-9

Step 3: The software displays the Instrument Signal Data form.

Figure 5-2 shows the form and its relationship to the process.
Fill in the appropriate fields for that type of IST. Note that
certain point types do not require all IST parameters.

Step 4: When you have completed the form, select Apply and define
the next signal, if necessary.

Loop Primary IST

FI--6

Analog Output IST FC

5
900--1
I/P
FT
FCV 900--1
900B--1 Analog Input IST

INSTRUMENT SIGNAL DATA

X Edit Utilities Extra Data Target!
Target Help
!
ADD FT900-1
Flow XMTR Revised 6/26/90 by John Doe

Type : ANALOG DISCRETE PULSE COUNT PARALLEL DISCRETE SMART

Signal Direction : INPUT
INPUT OUTPUT INPUT/OUTPUT

Strategy : Conversion Constant :

Device v : IFC1
Local MUX Address : 1-2-2 On Alarm Word :
Smart Variable : Off Normal Word :
Units : GPM Alarm Deadband : 0.1
High Scale Value :5 Alarm Deadband % : 0.05
Low Scale Value :0
Alarm Type v Value Word
A DEV 0.5 DEV
NO
Invert Input : YES NO
B LOW 0.1 LOW
Invert Output : C HIGH 5 HIGH

EV047

Figure 5-2 Instrument Signal Tag Flow Concept

Revision H — July 1996 UM6.1:SW3151

 5-10 Creating and Editing Device Definitions, Points and Templates

5.1.3.3 Creating a Primary IST from a Point Form

To create a point’s primary IST through the point’s configuration form
instead of the Top Level form:

Step 1: Display the point’s configuration form.

Step 2: Specify the primary IST in the Instrument Signal v field.

Note
When you enter the name of an existing IST in the
5 Instrument Signal v field, ENVOX software
references the IST table and automatically fills in
the read-only I/O signal data fields on the point
configuration form. For primary ISTs not previously
configured, the ENVOX software completes the
point configuration form after you complete the
Instrument Signal Data form.

Step 3: Select the Extra Data option from the menu bar.

Step 4: Select the Instrument Signal option from the pull-down menu.
The Instrument Signal Data form appears.

If you failed to enter an IST in the Instrument Signal v field,

selecting the INSTRUMENT SIGNAL menu will cause an error
message to be displayed.

AI POINT
X Edit Utilities Extra Data Target!
Extra Data Help

Notes
AI Point Processing
PT Compensation
Signal Characterization
Extended Alarms
INSTRUMENT SIGNAL

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-11

In the example in Figure 5-3, AI point FI-900 receives its signal and signal
characteristics from its primary IST, FT900-1.
Primary IST for this point

AI POINT
X Edit Utilities
Utilities Extra Data Target! Help

ADD AI point FI900-1

Device v : IFC1 Instrument Signal v : FT900-1

5
Index : 30 Signal Device IFC1
Description : Local MUX Address 1-2-2
Strategy : SMART Variable NO
Resource Attr : 11 Invert Input NO
Off Scan : YES NO High Scale Value 5
Scan Rate : 0.2 0.5 1 2 55 15 30 60 Low Scale Value 0
Units GPM
Input Filter Enbl : YES NO Alarm Deadband 0.05
Input Filter Time :

AO for Data Record Alarm Type Value Word

Enbl : YES NO B LOW 0.1
AO for Data Record v : C HIGH 5

EV048

Figure 5-3 Analog Input Point Form

The read-only I/O signal data fields on each point form do not accept data
input manually. When you specify an IST in the Instrument Signal v: field,
ENVOX software automatically fills in the remaining I/O data fields.

Within the forms, fields that are not preceded by a colon (:) are read-only
fields.

Revision H — July 1996 UM6.1:SW3151

 5-12 Creating and Editing Device Definitions, Points and Templates

5.2 Example Device Definition

The following example provides step-by-step instructions for defining an
SR90 device. This example demonstrates how the extra data forms
support the main device definition form.

Step 1: Select the following menu options.

ENVOX TOP LEVEL FORM

X Add
Add Modify! Utilities More Status! Help
5
UOC/IFC/SR90 POINTS ->
CONSOLE POINTS -> PROVUE
CHIP POINTS -> WPCON
OTHER POINTS -> SR90
DEVICES -> UOC/IFC
LOGIC -> CONFIGURABLE
INSTRUMENT SIGNAL IAC/COMPUTING
GLOBAL ITEMS -> MUX
PCIU
TREND
CHIP
LCON
EV064

Step 2: The software displays an ENTER TAG pop-up form. Enter the
tag name for the device. This example uses IFC1.

ENTER TAG
X! Set Item Type! Help

Item Type: UOC

Add : IFC1

Step 3: The software displays the Device Definition form. Enter data
by selecting your own values, or by pressing the Default
Values key to call up the default data. Figure 5-4 shows the
form and example data. Field help and the appropriate
configuration engineering manuals provide more information
about acceptable data for fields. Note that the Comment field
does not require information but is useful for entering notes
about the purpose or status of the device.

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-13

DEVICE DEFINITION
X Edit Utilities
UtilitiesExtra Data Target! Help

SR90 ADD IFC1

Device definition for IFC1

Type v : IFC FST Area Size : 100

SR90 Revision : P3.0 AI Limits Value Word

--------- ------- ------
Highway No. : 8 Low -2 LOW

Device No. : 25
High
Deadband
102
2
HIGH
5
Strategy : POWERHOUSE Action on Power Restoration
---------------------------
Overload Value : 95 Drive Failsafes : YES NO
Output Type :
No. of Resources : 320 Power Off Time :

EV049

Figure 5-4 Example Data for a UOC/IFC Device

Step 4: After completing the Device Definition form, you may apply
your data, quit, or continue entering data for the device. To
continue entering data, select the Extra Data menu option.
The pull-down choices on the Extra Data option are device
dependent. For an IFC device, the software provides these
pull-down choices:
J Notes — For making notes about this device
J Database Definition — For specifying device capacities
J OAR List — For defining Operator Action Request
messages
J IO Definition — For providing information on the controller
I/O hardware
J Required Operation Indices — For defining indices for
controller Unit Operations
For this example, select Database Definition.
Step 5: When you select the Database Definition option, the software
displays the Database Definition form. Figure 5-5 shows the
form and example data. This form allows you to specify limits
for point types in the device. These limits allocate device
memory.

Revision H — July 1996 UM6.1:SW3151

 5-14 Creating and Editing Device Definitions, Points and Templates

DATABASE DEFINITION
X Edit Utilities
UtilitiesExtra Data Target!
Target! Help

Type SR90 IFC ADD IFC1

Highway No. 8
Device No. 25

Maximum Maximum
Loop : 30 Extended Function : 0
PT Compensation : 0
5 Unit :
Group : 0 DCD Template : 1
DCD : 25 Group Template : 0
AO : 0 Extended DCD Block : 0
DO : 0
PDO : 0 LCP : 25
AI : 30 LCP FST : 15
DI : 25 Floating Point Register : 32
DM : 0 Integer Register : 32
PCI : 0 Boolean Register : 32

EV050

Figure 5-5 Database Definition Form Layout

Step 6: After you have finished entering data on the Database

Definition form, exit and apply the data. The software displays
the Device Definition form again.

Step 7: Select the IO Definition option from the Extra Data menu in the
menu bar. The software displays the IO File-Card Defn form.
Figure 5-6 shows the form and example data.

Step 8: To configure channel information for a card, move the cursor

to the Type v field for the card.

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-15

IO FILE-CARD DEFN
X Edit Utilities Extra Data Target! Help

MODIFY UOC416
Type SR90 IFC
Scan PCIU
Use
File Card Backup Sec Prior Sim.
1
No. No. Type v Redundancy Status File Card Term v v

1 1 PRIMARY SIMPLEX BACKUP

2 AIO PRIMARY
PRIMARY SIMPLEX BACKUP 1 4 0 1
3 PRIMARY SIMPLEX BACKUP
4 DIO PRIMARY
PRIMARY SIMPLEX BACKUP 0 4 5
5 PRIMARY SIMPLEX BACKUP
6 DIO PRIMARY
PRIMARY SIMPLEX BACKUP 1
7 PRIMARY SIMPLEX BACKUP
8 PCI PRIMARY
PRIMARY SIMPLEX BACKUP 1
9 PRIMARY SIMPLEX BACKUP
10 AIO PRIMARY
PRIMARY SIMPLEX BACKUP 1
11 PRIMARY SIMPLEX BACKUP
12 TPO PRIMARY
PRIMARY SIMPLEX BACKUP 1
13 WSI PRIMARY
PRIMARY SIMPLEX BACKUP 1
14 PRIMARY
SPECIAL EXT PRIMARY SIMPLEX BACKUP 4
>
EV051

Figure 5-6 UOC Serial IO File-Card Form Layout

Step 9: Select the Extra Data menu. The software provides these
pull-down choices:

J IO Channel Definition — For control I/O cards (for

example, AIO and DIO)

J External Interface Card List — For control I/O external

interface cards

J Distributed IO Card-Channel — For DISTRIBUTED

(distributed MUX I/O) cards

J SMART IO Channel Definition — For SMART cards

J IDI Card Definition — For IDI cards

For this example, select IO Channel Definition.

Step 10: The software displays the IO Channels form. Figure 5-7 shows
the form and example data.

Revision H — July 1996 UM6.1:SW3151

 5-16 Creating and Editing Device Definitions, Points and Templates

IO CHANNELS
X Edit Utilities Extra Data Target!
Target! Help Special

Type SR90 IFC ADD IFC1

File No. 1
Card No. 1 Card Type AIO PCIU Simulation

Channel Duration/ Base Deadband Scale H

No. Class v Type v Rate Period v Range v

1 REGULAR ANALOG AI ISOLATED 0-10

2 REGULAR ANALOG AI ISOLATED 1-5
5 3
4
REGULAR ANALOG
REGULAR ANALOG
AIO LOW LVL MV
AI LOW LVL SPECIAL 1
v

5 REGULAR ANALOG AI LOW LVL SPECIAL 2

6 REGULAR ANALOG AI SINGLE ENDED
7 REGULAR ANALOG AO
8 THERMOCOUPLEs AI TYPE B
9 RTDS AI RTD -270-140
10 OTHER UNCONFIGURED
11 OTHER UNCONFIGURED
12
13
14
>

EV052

Figure 5-7 UOC Serial IO Channels Form Layout

Step 11: After entering the data on the IO Channels form, exit and
apply the data. Configure additional channel information in the
same way. If all the channels are the same, use the Replicate
option described in Step 12 and Step 13.

Step 12: To use the Replicate option, enter the definition of Channel 1
as you normally would. Fill in the Class, Type, and other fields
as required.

Step 13: Select the Special option from the menu bar and the Replicate
IO Channels option. The software automatically gives the
other channels on the card the same definition as channel 1.

Do not use this menu option if you have a card with different
types of channels defined. If you select this menu option by
accident, and your channel definitions are overwritten, select
Quit to undo the error.

Step 14: After you complete all of the necessary card and channel
configuration, exit and apply the data from each form.

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-17

5.3 Modifying an Item

Modifying an item changes the data associated with the item in the
database. To modify an item do the following:

Step 1: Select the Modify menu from the ENVOX Top Level Form.

ENVOX TOP LEVEL FORM

X Add Modify! Utilities More Status! Help

EV057
5
The software displays an ENTER TAG popup form:

ENTER TAG
X! Set Item Type! Help

Item Type v :
Modify v :

Step 2: You may enter a tag several ways:

J Enter the tag by typing it.

J Access a list of valid entries limited to the item type by

selecting the Set Item Type! menu option, moving the
cursor to the Item Type v field, and then pressing the
Values List key. The Set Item Type! option limits the values
list to items within the item type.

J Access a list of valid entries by entering one or more initial

characters or a combination of characters and a wildcard
in the Modify v field, and then press the Values List key
(see Table 4-1 for a list of special search string
characters). You may use up to 20 characters for
searching, but the valid length of a tag is 12 characters.

J Press the Last Tag function key to return to the tag name
immediately preceding the displayed one. You can change
one character in the field, such as UOC1 to UOC2.

When you enter a tag, the software displays the first form for
the item. From the first form, you can access the extra data
and target data forms. Modify the forms.

Revision H — July 1996 UM6.1:SW3151

 5-18 Creating and Editing Device Definitions, Points and Templates

Step 3: Exit the form. The software prompts you to select Apply or
Quit:

J Apply — Saves the modified data to the database and

returns you to the Modify form.

J Quit — Does not save the modified data. Returns you to

the Modify form.

5.4 Modifying Items Using a Tag Set

Entering a tag-set name after the modify prompt enables you to modify
the points in the tag set quickly. Section 6 provides more information on
5 tag sets. To modify items using a tag set, select the Modify option from
the menu bar and enter the name of the tag set. The software displays
the Modify Items In Tag Set form. Figure 5-8 shows the form.

MODIFY ITEMS IN TAG SET

X Edit!

TAG SET MODTAGSET

Tag Type Status

IE-AICPNOREF IAC ANALOG ICP Unmodified

IE-AICPREF IAC ANALOG ICP Unmodified
IE-ALIAS-01 ALIAS TEMPLATE Unmodified
GROUP1 DISPLAY ** Cannot modify from form **
IE-AUT-DCP IAC DCP Unmodified
IE-CNDCOL-01 CONDITIONAL COLOR Unmodified
IE-CNDTXT-01 CONDITIONAL TEXT Unmodified
IE-SUP-DCP IAC DCP Unmodified

EV053

Figure 5-8 Modify Items In Tag Set

Initially, the items’ status is Unmodified, Cannot modify from form, or

Does not exist.

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-19

To modify an item in the list:

Step 1: With the item you want to modify highlighted, select the EDIT!
option from the menu bar. The software displays the modify
form for the item. The software does not allow you to select an
item that does not exist or cannot be modified.

You can use the F8 key to quickly locate a particular tag.

Step 2: Modify the form as you would any item. Make sure to Apply
your changes. The software saves your changes from the
modify form, not from the Modify Items In Tag Set form.

Step 3: After applying your changes, the software returns you to the
Modify Items In Tag Set form, with the next item highlighted, 5
and the status of the previous item changed to Modified.

5.5 Saving Form Data

The Save option on the Utilities menu of a form saves the data on the
currently displayed form to the database. The Save option is only
available on the main (Top-Level) form of an item, and it causes the entire
item, including any data on sub-forms, to be saved. Saving does not exit
the form, so you can do intermittent saves as you work on an item.

To save the data on the current form do the following:

Step 1: With the form displayed, select the Utilities menu.

Step 2: Select the Save option.

PCI POINT
X Edit UtilitiesExtra Data
Utilities Target! Help

Save
Print
Show Errors
Ad Hoc Tag Set

EV058

Revision H — July 1996 UM6.1:SW3151

 5-20 Creating and Editing Device Definitions, Points and Templates

5.6 Viewing Items

The View option under the Utilities top-level menu allows you to look at an
existing item without making changes.

To view an item:

Step 1: Select the Utilities menu from the ENVOX Top Level Form.

Step 2: Select the View option.

5 ENVOX TOP LEVEL FORM

X Add Modify! Utilities More Status! Help

View
Rename Item
Item Copy
Copy Console Configuration
Display Editor
Tag Set ->
Highway Access Control List
Delete
Special Functions ->
EV059

The software displays an ENTER TAG popup form:

ENTER TAG
X! Set Item Type! Help

Item Type v :
View v :

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-21

Step 3: You may enter a tag several ways:

J Enter the tag by typing it.

J Access a list of valid entries limited to the item type by

selecting the Set Item Type! menu option, moving the
cursor to the Item Type v field, and then pressing the
Values List key. The Set Item Type! option limits the values
list to items within the item type.

J Access a list of valid entries by entering one or more initial

characters or a combination of characters and a wildcard
in the Modify v field, and then press the Values List key
(see Table 4-1 for a list of special search string
characters). You may use up to 20 characters for 5
searching.

J Press the Last Tag function key to return to the tag name
immediately preceding the displayed one.

The software displays the first form for the item. From the first
form, you can access the extra data and target data forms.

Step 4: Exit to return to the ENVOX Top Level Form.

5.7 Copying Data

The ENVOX copy options let you reuse existing data in several ways. The
options can:

J Copy data to a displayed form (Copy Form option, see subsection

5.7.4)

J Copy points, DCD templates, group templates, operations, or FSTs

(Item Copy option, see subsection 5.7.5)

J Copy a complete console configuration (Copy Console Configuration

option, see subsection 5.7.6)

This subsection refers to the item or form you are copying to as the
destination and the item from which you are getting data as the source.

Revision H — July 1996 UM6.1:SW3151

 5-22 Creating and Editing Device Definitions, Points and Templates

5.7.1 Copy Modes

The Copy Form option and the Item Copy option support three
copy modes:

J Fill-in — Copies the data from the source into the null (blank)
destination fields only. Any fields on the destination form you have
already filled in are not affected by the copy.

Fill-in is useful for retro-fitting default data. For example, consider a

situation in which you have many PROVUEr EPCI points, some
points have been configured with specific high and low scale values
5 while the remaining points require default scale values of 100 and 0
that have not been configured.

J Data Replace — Overwrites the fields in the destination form

corresponding to the fields on the source form that have data in them.

J Overwrite — Overwrites all the fields in the destination form with the
data from the fields in the source form (except the name of the
destination item). If a field in the source form is empty, and the same
field in the destination form has data in it, overwrite wipes out the data
in the destination field.

You can configure a single EPCI point with the 100 and 0 values and
copy this to all the EPCI points using the fill-in mode. This copies the
values only to the points that require the default values, leaving the
specific scale values in tact.

Figure 5-9 shows the effect each copy mode would have on a small
portion of an example destination form. Subsections 5.7.2 and 5.7.3
describe exceptions in the way the copy modes work.

There are several items that do not support the fill-in and data replace
copy modes:

J Devices — Many device definitions have revision or type-related

restrictions that could be violated by fill-in or data replace. The
following restrictions apply for all devices other than consoles (which
have a unique copy option described in subsection 5.7.6):

Overwrite is the only valid mode

The tag specified as the destination cannot exist

J Logic Items — The following logic items support only the overwrite
mode: procedures, operations, LCP FSTs, IAC FSTs, reports,
conditional color, and conditional text.

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-23

Fill-in Present Resulting

Source Destination Destination
Values: Values: Values:

High Scale Value: 100 ______ 100

Low Scale Value: 0 5 5
Units: ______ kilos kilos

Data Replace Present Resulting

Source Destination Destination
Values: Values: Values:
5
High Scale Value: _____ 95 95
Low Scale Value: 5 85 5
Units: kilos gals kilos

Overwrite Present Resulting

Source Destination Destination
Values: Values: Values:

High Scale Value: 100 45 100

Low Scale Value: 0 5 0
Units: ______ kilos _____

Figure 5-9 Copy Modes

J Displays — Displays support only the overwrite mode.

J Multi-Format Fields — Some fields accept data in several different

formats. For example, the process variable input (MV1) field on the
loop pseudo IO form may be a loop tag, an IST, an attribute:tag, a
constant, or a register. Because of the way the system stores values
for these fields, they can only support the overwrite copy mode.

J Target Data — If the copy mode selected for a copy operation is

overwrite, the system copies the target data. The system ignores the
target data if the copy mode is fill-in or data replace.

Revision H — July 1996 UM6.1:SW3151

 5-24 Creating and Editing Device Definitions, Points and Templates

5.7.2 Unique Data

There are data that, if copied, can cause an error. The following lists data
that receive special handling to avoid such errors:

J Index Numbers — Index numbers, such as those for operations,

must be unique throughout the system. When copying items that have
an index, the software assigns a new index number to the destination
item.

J PPA Number — The PPA number on the PPA Definition form must be
unique throughout the system. The software sets this field to null in
the destination item.
5 J User Password — the password for any user definition must be
unique throughout the system. The software sets this field to null in
the destination item.

J Instrument Signal File-Card-Channel — In some circumstances it is

invalid to have more than one instrument signal referencing the same
file-card-channel (for example, the file-card-channel references for
each instrument signal associated with a MUX device). The software
sets the file-card-channel fields to null in the destination item.

J Instrument Signal Tag — An instrument signal must be unique for

each MUX point. Although it is not invalid to have an instrument signal
referenced by more than one UOC point, it is not a usual situation.
The system does not copy instrument signals specified for a UOC or
MUX.

J Device Address — The device address must be unique for each

device. When you copy a device using Overwrite, the system does
not copy the device address.

J Pen Recorder Data — Any pen driver specified in the Console Pen
Recorder List form can only be specified as a pen driver once
throughout the system. The software does not copy any pen recorder
information to the destination item.

J Slave Devices — Slave Devices can only be defined once throughout

the system. The software does not copy slave devices from a console
system clock list to the destination item.

J Console Device Redundancy fields — The system does not copy

the Secondary Console and Parent Console field values to the
destination device. The software sets the Clone field in the destination
device to NO.

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-25

5.7.3 Group Field Data

Group fields are fields containing multiple values. The Copy Form option
(subsection 5.7.4) does not copy group field data at all. The Item Copy
option (subsection 5.7.5), treats the data in a group field as a single entity.
The effect of a copy operation depends on whether the group field is null.
A group is considered null if all the fields except the row identifiers are
null. The row identifiers may be the row number or letter. Subsections
5.7.3.1, 5.7.3.2, and 5.7.3.3 describe how each copy mode manages
group data.

Some group fields also have underlying data—another set of data

associated with each row of grouped data. The Copy Item option treats
this data as part of the group also. Specifically: 5
J For a PPA definition, the software copies priority tag data with each
state name.

J For group templates, the software copies DCD setpoint data with
each group setpoint.

5.7.3.1 Overwrite Mode for Group Fields

Overwrite mode copies group field data to the destination as they appear
in the source.

5.7.3.2 Data Replace Mode for Group Fields

J If the source group field is not null and the destination group field is
null, the software copies the source data to the destination.

J If the source group field is null and the destination group field is not
null, the software does not copy the source data to the destination.

J If both the source group field and the destination group field are not
null, the software overwrites the destination data with the source data.

5.7.3.3 Fill-in Mode for Group Fields

J If the source group field is not null and the destination group field is
null, the software copies the source data to the destination.

J If the source group field is null and the destination group field is not
null, the software does not copy the source data to the destination.

J If both the source group field and the destination group field are not
null, the software does not copy the source data to the destination.

Revision H — July 1996 UM6.1:SW3151

 5-26 Creating and Editing Device Definitions, Points and Templates

5.7.4 Copying Data to a Displayed Form (Copy Form)

Note
Items may be on several forms. The Copy Form
function only copies data from the origination item
to the form on the screen; the remaining forms for
the destination item are not altered. The Copy
Form option does not copy group field data.

5 To copy data from an item in the database to a displayed form do the

following:

Step 1: Make sure you have on the screen the form you want the data
to be copied to (the destination form).

Step 2: Select the Edit menu.

Step 3: Select the Copy Form option.

PCI POINT
X EDIT Utilities
Edit Extra Data Target! Help

Copy Form
Delete
Clear
EV075

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-27

The software displays an ENTER TAG popup form:

ENTER TAG
X! Help

Copy from v:

Fill In Data Replace Overwrite

Step 4: Enter the source tag or select an entry from the values list.

Step 5: Select the copy mode. Subsection 5.7.1 describes these copy
modes. 5
Step 6: Press the Gold key and the software gives you the option to
select Apply or Quit.

J Apply — The software copies the data from the source

item to the destination item and displays the revised
destination form.

J Quit — The software displays the destination form. No

changes are made, causing the copy function to abort.

Revision H — July 1996 UM6.1:SW3151

 5-28 Creating and Editing Device Definitions, Points and Templates

5.7.5 Item Copy

The Item Copy menu option copies all the data from one item to another,
with the exception of instrument signal data. Subsection 5.7.2 describes
how the software copies unique data. Subsection 5.7.3 describes how the
software copies group-field data.

5.7.5.1 Item Copy Form Contents

Figure 5-10 shows the Copy Items form.

5
COPY ITEMS
X Copy! View Current! Report! Help

Copy Mode : FILL-IN DATA REPLACE OVERWRITE

Copy from Copy to v Status

Processing # out of #

EV065

Figure 5-10 Copy Items Form (Point Version Shown)

The form includes the following fields;

J Copy Mode — Determines what fields change in the destination item.

Subsection 5.7.1 describes the copy modes. If the destination item
does not exist, the effect of all three copy modes is the same.

J Copy from — The source items from which the data is copied.
Entries can be tags or tag sets. The items must already exist in the
database.

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-29

J Copy to — The destination items for the source data. Entries can be
tags or tag sets (subsection 5.7.5.3 provides examples for using tag
sets). The items do not have to exist in the database. If they do exist,
they must be of the same type as the source items.
J Status — Indicates the status of the copy operation. The status can
be one of the following:
Create Pending — The item does not currently exist in the
database. The software creates the item and copies the source
data to it.
Copy Pending — The item exists in the database. The software
copies the source data to it.
Incompatible — The destination item is not the same type as the 5
source item, or you did not specify a destination item, or the copy
mode is not supported for the item type (for example, logic items
can only use Overwrite mode).
J Processing # out of # — indicates the number of the item currently
being copied and the total number of destination items.

5.7.5.2 Copying
The Item Copy option copies the data from one item to another. The data
includes the target data but not the associated instrument data (for
points). If the item you are copying to does not exist, Item Copy creates a
new item. To use the Item Copy option, do the following:
Step 1: Select the Item Copy option from the ENVOX Top Level
Form’s Utilities menu.

ENVOX TOP LEVEL FORM

X Add Modify! Utilities
Utilities More Status! Help

View
Rename Item
Item Copy
Copy Console Configuration
Display Editor
Tag Set ->
Highway Access Control List
Delete
Special Functions ->
EV076

Step 2: Select a copy mode.

Revision H — July 1996 UM6.1:SW3151

 5-30 Creating and Editing Device Definitions, Points and Templates

Step 3: Fill in the Copy from field with the tags or tag set of the items
you want to copy from. You may select the View Current!
menu in the menu bar to verify that you have selected the
correct point. Exit and quit to return to the Copy Items form.
Step 4: Fill in the Copy to field with the tags or a tag sets of items you
want to copy to. Subsection 5.7.5.3 provides examples for
using tag sets

Step 5: Select the Copy! menu to start the copy process.

Each time you invoke Item Copy, you create a log file that
gives the following information: the time the copy was started,
Copy From and Copy To tags, any save cursors, and
5 completion status. You can view this log by selecting the
Report! option or viewing the log file located at:
ENVOX$DISK:[ENVOX]ITEMCOPY.LOG.

5.7.5.3 Using Tag Sets With Item Copy

Suppose you have a tag set UOC2AO containing four AO tags:
UOC2--AO1, UOC2--AO2, UOC2--AO3, and UOC2--AO4. If you enter this
tag set in the Copy to field, the software automatically enters the four
items in the tag set into the fields. If you then use UOC1--A01 in the Copy
from field, the software copies the data configured for UOC1--A01 to
UOC2--AO1, UOC2--AO2, UOC2--AO3, and UOC2--AO4. Figure 5-11
shows the Copy Items form as it would appear for this example.

COPY ITEMS
X Copy! View Current! Report! Help
Copy Mode : FILL-IN DATA REPLACE OVERWRITE
Copy from Copy to v Status

UOC1-AO1 UOC2-AO1 Copy Pending

UOC2-AO2 Copy Pending
UOC2-AO3 Copy Pending
UOC2-AO4 Copy Pending

Contents of UOC--A01
copied to all Copy to items

Processing # 1 out of # 4

EV066

Figure 5-11 Copying Items Using Tag Sets (Example 1)

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-31

If the tag set contains tags of different types, you can specify different
Copy from items directly across from the items of the same type as
shown in Figure 5-12.

COPY ITEMS
X Copy! View Current! Report! Help

Copy Mode : FILL-IN DATA REPLACE OVERWRITE

Copy from Copy to v Status

UOC1-AO01 UOC2-AO01
UOC2-AO02
Copy
Copy
Pending
Pending 5
UOC1-AI01 UOC2-AI01 Copy Pending
UOC2-AI02 Copy Pending

Processing # 1 out of # 4

EV067

Contents of UOC--AO01 and UOC1--AI01

copied to items of different types

Figure 5-12 Coping Items Using Tag Sets (Example 2)

Revision H — July 1996 UM6.1:SW3151

 5-32 Creating and Editing Device Definitions, Points and Templates

5.7.6 Copying a Console Configuration

The Copy Console Configuration option copies a console configuration.
This option creates a device definition for a new console, replicates the
data from an existing console, and makes the data part of the new
console. Note the following:

J The device being copied to must not exist before using the Copy
Console Configuration option.

J The Copy Console Configuration option does not copy the highway
address. You must modify the new console device definition to specify
the highway address.
5 J The Copy Console Configuration option does not copy hosted points
such as activities and accumulations, but will target these points to
the new console.

J Subsection 5.7.2 describes how the software copies certain types of

unique console data.

J Once a console configuration has been copied, modifying the device

definition of either console does not affect the configuration of the
other console. Note that the clone option on the console device form
does establish a relationship between consoles that causes their
configurations to track in this manner. The console configuration
engineering manual and subsection 5.7.7 in this manual describe
console cloning.

To copy a console configuration:

Step 1: Select the Copy Console Configuration option from the

ENVOX Top Level Form’s Utilities menu. The software
displays a form like the one in Figure 5-13.

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-33

COPY CONSOLE CONFIGURATION

X Copy! View Source! Help

COPY CONSOLE

Copy from v: Type

Copy to v:

Processing # out of #
5
Copy to Status Copy

EV068

Figure 5-13 Copy Items Form (Console Version Shown)

Step 2: Fill in the Copy from field with the tag of the console you want
to copy from. You may select the View Source! menu to verify
that you have selected the correct console. Exit and quit to
return to form.

Step 3: Fill in the Copy to field with the tag of the console you wish to
create.

Step 4: Select the Copy! menu to start the copy process. The software
prompts you with a Confirm Action form, allowing you to
confirm or cancel the copy operation.

Revision H — July 1996 UM6.1:SW3151

 5-34 Creating and Editing Device Definitions, Points and Templates

5.7.7 Cloning PROVUE Consoles

ENVOX software allows you to clone PROVUE consoles. Cloning
consoles duplicates most of the configuration from one console (the
parent) to another console (the clone). When consoles are cloned,
ENVOX software establishes a permanent link between the consoles.
Any changes made to the parent console’s configuration are also
generated into the clone console’s configuration. The configuration
duplication is done when the parent console is generated.

A typical application for cloning is when using redundant consoles. The

secondary console can be defined as a clone of the primary console so
that ENVOX software automatically keeps it updated with all of the
5 primary console’s point configuration.

The following items are copied from the parent console to the clone
console and cannot be re-defined separately:

J Shift Table

J Trend Set Definition

J Operator Display List

J PMA List

J User Access List

J Reports List

Additionally, all points targeted to the parent console are automatically

targeted to the clone. Console based points which are sourced in the
parent console are automatically targeted to the clone console.

The following items are not copied from the parent console to the clone
console. You must define them for the clone:

J Basic PROVUE console device definition form

J Options Definition

J Station Details

J Station Key Definitions (optional)

J System Clock

J Pen Recorder List

J Horn Tones (valid for WPCON, and PROVUE P5.3 or later)

J Console Preferences (valid for WPCON)

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-35

ENVOX software automatically generates the clone console when you

generate the parent console. The cloned device tag can be referenced
when the device is to be downloaded. Note than since the duplication is
done during the generate phase you should expect the parent console to
take longer to generate than if it was not cloned.

5.7.7.1 Restrictions on Cloning

A cloned PROVUE console is a special type of device. Its tag cannot be
entered in all of the places where a device tag is normally accepted. For
example, as the source device for a point, as the target device for a point,
or as a device to be generated.

The console you make into a clone must be similar to the parent console. 5
That is, if the parent is a P5.x console then the clone must be a P5.x
console. If the parent is a WPCON console, the clone must be a WPCON
console. The database size of the clone console must be equal or greater
in size to that of the parent console.

It is not possible to clone one redundant console pair from another. That
is, a primary console cannot be a clone of another console. Also note that
a simplex console cannot be a clone of a primary or secondary console in
a redundant console pair. When cloning simplex consoles, it is not
possible to have a parent console be a clone of another console. It is
possible however to have multiple simplex clones of a single parent
simplex console.

5.7.7.2 Changing an Existing Console to or From a Clone

When you change an existing console into the clone of another console,
any items previously existing in the clone which are to be copied from the
parent are automatically deleted from the clone.

When removing a clone from its parent, all items that were cloned from
the parent console no longer exist in the clone, so the clone console is no
longer functional. The duplicated items must be re-entered for the
previously cloned console. To remove the cloning relationship between
two consoles but keep the same configuration on the clone, delete the
clone console from the ENVOX database. Then use the Copy PROVUE
function to recreate the console just deleted.

Revision H — July 1996 UM6.1:SW3151

 5-36 Creating and Editing Device Definitions, Points and Templates

5.8 Deleting Items

You can delete an item from the database either by selecting the Delete
option on the Utilities menu of the ENVOX Top Level Form, or by
selecting the Delete option from the Edit menu on the main form for that
item.
The form-level delete works only for the displayed item and is restricted to
points and global items. Deleting from the ENVOX Top Level Form lets
you delete devices, as well as points and global items.

5 Note
Deleting an item that has references to it
elsewhere in the system (for example, in FSTs,
procedures, reports, and UDKs) does not delete
the references. Also, deleting from the ENVOX
Top Level Form lets you delete all the items in a
tag set, but it does not delete the tag-set tag.

5.8.1 Deleting From the Top Level Form

To delete an item from the ENVOX Top Level Form:
Step 1: Select the Utilities menu.
Step 2: Select the Delete option.

ENVOX TOP LEVEL FORM

X Add Modify! Utilities
Utilities More Status! Help

View
Rename Item
Item Copy
Copy Console Configuration
Display Editor
Tag Set ->
Highway Access Control List
Delete
Special Functions ->

EV077

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-37

The software displays the Delete Items form. Figure 5-14

shows the form.

DELETE ITEMS
X Delete! View Item! Help

Delete v: Processing # out of #

Delete tag Type Status Delete

5

EV069

Figure 5-14 Delete Items Form

Step 3: At the Delete v field, enter a tag or tag set by typing it in or

using the valid entries list.

Step 4: The software displays the tag under the Delete Tag field.

Step 5: To make sure this is the correct item, you may wish to select
the View Item! option. The View Item! option displays a
read-only version of the item’s form. Exit and quit to return to
the Delete Items form.

Step 6: To delete the item, select the Delete! option. Note the following
for device deletion:

J You cannot delete a console that is designated as a

secondary console in another console device definition. To
delete a secondary console, you must first remove the
console tag from the primary console device definition.

J No one is allowed to edit any item in the database while a

device deletion is in progress. A device deletion cannot
start if anyone is currently editing an item.

J Only one device deletion may be in progress at any time.

Revision H — July 1996 UM6.1:SW3151

 5-38 Creating and Editing Device Definitions, Points and Templates

J You cannot initiate a device delete while a generate is in

progress. Conversely, a generate may not be initiated if
any device delete is in progress.

J ENVOX software locks all database items affected by the

device deletion. If an item cannot be locked, the deletion
does not occur. For example, if another user is editing a
point and you try to delete the point’s device, the software
does not permit the deletion.

5.8.2 Deleting from the Item Level

To delete an item that you are looking at, do the following:
5
Step 1: Select Edit from the Item-level menu.

Step 2: Select Delete.

PCI POINT
X Edit Utilities
Edit Extra Data Target! Help

Copy Form
Delete
Clear
EV078

The software displays a Confirm Action pop-up menu,

enabling you to continue the delete or cancel it.

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-39

5.9 Clearing a Form

The Clear option on the Edit menu removes all the entries, except the tag,
from a displayed form and moves the cursor to the first field so that you
can begin to enter new data.

Note
Clear does not delete data from the database until
you select apply. It is possible to retrieve cleared
data, unless you have applied the cleared form. To
retrieve cleared data, Quit the form. Access the 5
form again using the Modify! option.

To clear a form, do the following:

Step 1: Select the Edit menu.

Step 2: Select the Clear option.

PCI POINT
X Edit Utilities
Edit Extra Data Target! Help

Copy Form
Delete
Clear
EV079

Revision H — July 1996 UM6.1:SW3151

 5-40 Creating and Editing Device Definitions, Points and Templates

5.10 Renaming an Item

The following subsections describe how to rename an item from the
ENVOX form and with a command.

5.10.1 Renaming Using the ENVOX Form

To rename an item, do the following:
Step 1: From the ENVOX Top Level Form, select the Utilities option.

5 Note
If you delete a point that has references to it
elsewhere in the system, that is in operations,
FSTs, procedures, reports, and UDKs, you cannot
rename another item to that tag while those
references still exist.

Step 2: Select Rename Item. The software displays the Rename Item
form.

ENVOX TOP LEVEL FORM

X Add Modify! Utilities
Utilities More Status! Help

View
Rename Item
Rename Item
Item Copy
Copy Console Configuration
Display Editor
Tag Set ->
Highway Access Control List
Delete
Special Functions ->

EV080

Step 3: Enter the appropriate tag names in the Rename from v field
and Rename to field.
Step 4: Select the Rename! menu option.

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-41

Note
Renaming causes ENVOX software to change all
references to the original name in the database. If
a rename fails before the software makes all
necessary changes to the database, some
functions can be locked out. To have the software
retry a failed rename, see subsection 5.10.2.

5.10.2 Renaming with a Command 5

You can rename an item with the following command:

Note
The quotes in the following commands prevent the
VMS system from converting the parameters to
the wrong case.

Caution
Renaming with a command does NOT
check for valid tag names. Ensure that you
use proper tags based on the list found in
subsection 5.1, Step 3. If you do not use
proper tag names, undesirable ENVOX
operation may result.

J VMS Command

$ rt == “$envox$application:rename_tag.exe”

$ rt “username” “database_name” “old_tag” “new_tag”

J UNIX Command

> rename_tag.exe “username” “database_name” “old_tag” “new_tag”

Revision H — July 1996 UM6.1:SW3151

 5-42 Creating and Editing Device Definitions, Points and Templates

where

username is the name of a user with access to this database

database_name is the name of the database containing the item

you wish to rename

old_tag is the name of the old tag

new_tag is the new tag’s name

For example:

J VMS Command
5
$ rt “ENVOX” “ENVOXDB” “FI-1000” “FI-2000”

J UNIX Command

> rename_tag.exe “ENVOX” “ENVOXDB” “FI-1000” “new_tag”

With VMS operating system, you can also create a command file with as
many renames as you wish and submit it to the batch queue. An example
command file follows:

Note
When using the VMS operating system, a blank
line after each “$ rt” line is required because
RENAME asks for a Return before it can
continue. In a command file, a blank line is
interpreted as a Return.

$ ! RENAME COMMAND FILE

$ ! define a symbol.....
$ rt == “$envox$application:rename_tag.exe”

$ ! run the utility .....

$ rt “ENVOX” “ENVOXDB” “FI-1000” “FI-2000”

$ rt “ENVOX” “ENVOXDB” “FI-1001” “FI-2001”

$ rt “ENVOX” “ENVOXDB” “FI-1002” “FI-2002”

$ rt “ENVOX” “ENVOXDB” “FI-1003” “FI-2003”

$ exit

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-43

Note
If you delete an item that has references to it
elsewhere in the system (for example an AI point
that is referenced by an Operation and a Display),
the rest of the database will still refer to the
deleted tag. If you then try to rename ANOTHER
point to the deleted tag, it will not be allowed
because those references still exist.

If the Rename command sequence fails, use the commands listed below
5
for your particular machine.

J VMS Command

1. To retry all failed renames in all ENVOX databases within a user’s

administration, enter:

$ mcr envox$application:rename_tag

2. To retry all failed renames in a user’s default databases for a specific

user, enter:

$ mcr envox$application:rename_tag “<USER>”

3. To retry all failed renames in a specified database as a specific user,

enter:

$ mcr envox$application:rename_tag “<USER>” “<USER_DB>”

J UNIX Command

1. To retry all failed renames in all ENVOX databases within a user’s

administration, enter:

$ rename_tag.exe

2. To retry all failed renames in a user’s default databases for a specific

user, enter:

$ rename_tag.exe “<USER>”

3. To retry all failed renames in a specified database as a specific user,

enter:

$ rename_tag.exe “<USER>” “<USER_DB>”

Revision H — July 1996 UM6.1:SW3151

 5-44 Creating and Editing Device Definitions, Points and Templates

Note
The normal result of retrying a failed rename is to
undo the unfinished rename. The rename is
completed only if it is significantly progressed and
has passed a point of no return.

5.11 Using Note Forms for Comments

5 The Notes option enables you to read existing notes, add a new note,
modify a note, and delete a note. Each form you create can have as
many as 32 notes, with each note having a maximum of 255 characters.
When you add a note, the software fills in the data server account name
and the date and time. This information provides a record of when the
note was made and from which account. A note does not cover up the
data for the current form.

To use the Notes option:

Step 1: Select the Extra Data option from the item-level form,

Step 2: Select the Notes option from the pull-down menu. The
software displays the notes form for this item and the first
associated note (if one exists). There may be additional notes
for this item, but the note form shows one note at a time. The
note form includes these menu options:

J New! — Places the cursor at the bottom of the list. Type in

a new note.

J Delete! — Enables you to delete the currently displayed note

J Previous! — Takes you to the previous note

J Next! — Takes you to the next note

J Last! — Takes you to the last note in the list

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-45

5.12 Errors and Warnings

ENVOX software may display error and warning messages as you enter
data into a field. The paragraphs below describe the difference between
an error and a warning message:
J Errors — If an error message occurs, you must fix the error before
you can go to the next field, or save the form.
J Warnings — If a warning message occurs, you can proceed to the
next field and even to save the form. However, the problem that
caused the warning may prevent a successful generation.
For example, if you specify a nonexistent template for an item, the
software displays a warning. Quite likely, you consciously decided to
configure your templates last. Configure the template before generating.
5
During the early stages of a project, you receive many warnings because
you have not defined many things in the database. You can suppress
warnings during the early phase of the project when you know the
database is incomplete. To suppress warnings, select the Warning Status!
option when you log on (turning it OFF). You can also suppress warnings
using the STATUS! option on the ENVOX Top Level Form described in
subsection 4.6. In later phases of the project, leave the warning status
ON. This option only affects form entry. The verification the software
performs for a generate ignores this option and always provides
warnings.
To acknowledge an error or warning, press Return.

5.12.1 Understanding Error Messages

The following are examples of common error messages:
J Tag does not exist — You’ve entered a tag for the modify, view,
delete, or copy field that does not exist. Use the valid-entries-list
feature to find the valid tags in the database. Or, you’ve entered a tag
for the add field that already exists. Use a different tag, or delete the
old tag.
J Invalid value — There are two classes of invalid values: those
detected as you enter them and those detected when you try to exit
the form and select Apply.
The software checks for range errors after you make an entry into a
field. For range errors, the software keeps the cursor in the field until
you correct it (or make it a null field). For example, the resource
attribute of a point always has to be in the range 0 through 127. If you
enter something outside the valid range, the software does not allow
you to leave the field until you correct it or make it null by pressing the
the Erase Entry key.
Errors checked at Save time (after you exit and apply changes) are
typically due to dependencies within the current item. For example,

Revision H — July 1996 UM6.1:SW3151

 5-46 Creating and Editing Device Definitions, Points and Templates

the Initial Mode on a Loop Point has to be valid for the Station Type
defined for the Loop. You can fix this error by changing the Initial
Mode or the Station Type. You cannot save the data until the error is
corrected.

J Device not defined in database — You have entered a device name

that is not in the database.

5.12.2 Understanding Warning Messages

In general, if you enter an incorrect value, the software gives you a
warning. For example:
5 J Template does not exist — You have specified a nonexistent
template. Make sure you add the template before the generate stage.

J Invalid template type — You have specified a template for a different

item type than the item you’re currently working on. Before generating
configuration data, make sure you either change the template to a
valid one, or change the template type for the template you specified.

5.12.3 Viewing Verified Configuration Errors

The Show Errors option displays the Item Generation Errors form. The
errors on the form are the result of an attempted device generation. To
view the errors while in the item’s configuration form, do the following:

Step 1: Select the Utilities option from the form-level menu.

Step 2: Select the Show Errors option.

PCI POINT
X Edit Utilities Extra Data Target!
Utilities Help

Save
Print
Show Errors
Ad Hoc Tag Set

EV109

When you correct a configuration item that failed to generate, the related
error messages under the Item Generation Errors form remain until a user
requests another device generation.

UM6.1:SW3151 Revision H — July 1996

 Creating and Editing Device Definitions, Points and Templates 5-47

5.13 Upgrading Configurations

ENVOX software provides four upgrade options that convert older product
configurations to newer product configurations. These options are located
under the Special Functions option under the Utilities top-level menu:

J Upgrade UOC/IFC — Upgrades an existing unit operations controller

configuration for compatibility with a 20-Series (SR90) controller. The
Upgrade UOC/IFC option deletes the parallel I/O definition for unit
operations controller configurations.

J Upgrade UOC/IFC To SR90 I/O — Upgrades 10-Series UOC and IFC

configurations to 20-Series (SR90) controller configurations
supporting distributed MUX I/O. During upgrade, the parallel I/O is 5
upgraded to distributed MUX I/O.

J Upgrade PROVUE — Upgrades a pre-P5.0 PROVUE configuration to

a PROVUE P5.0 configuration. You must add PMAs and PPAs after
using this option. Also for PROVUE upgrades, all targeted data forms
for targeted points must be modified by supplying the associated PPA.

J Upgrade PROVUE to WPCON — Upgrades the configuration of any

PROVUE console version to an Operator Workplace Console
configuration, including station definition and key definitions.

These options can only upgrade configurations, they do not enable you to
convert, for example, SR90 or P5.0 PROVUE configurations to older
types.

To use these options:

Step 1: Prepare for the upgrade:

J The Upgrade UOC/IFC option deletes the parallel I/O

definition for unit operations controller configurations.
Document the I/O so that this can be re-configured after
the upgrade. No change is required to any items (sourced,
targeted, global) in the device.

J The Upgrade PROVUE option deletes the alarm definition

from the pre-P5.0 configuration. Document the alarm
definition so that this can be re-configured after the
upgrade.

Step 2: Select the Special Functions option under the top-level utilities
menu. The Special Functions slide-off menu appears.

Revision H — July 1996 UM6.1:SW3151

 5-48 Creating and Editing Device Definitions, Points and Templates

ENVOX TOP LEVEL FORM

X Add Modify! Utilities
Utilities More Status! Help

View
Rename Item
Item Copy
Copy Console Configuration
Display Editor
Tag Set ->

5 Highway Access Control List

Delete
Special Functions ->->

Upgrade UOC/IFC
Upgrade UOC/IFC To SR90 I/O
Upgrade PROVUE
Upgrade PROVUE To WPCON

EV082

Step 3: Select one of the upgrade options. The software displays a

pop-up form:

ENTER TAG

X! Help

Device v :

EV084

Step 4: Enter the name of the device tag associated with the
configuration you want to upgrade. The software prompts you
to Cancel or Confirm. Confirm upgrades the configuration.

Step 5: For the controller upgrades, generate the device after the
upgrade. This is automatically a forced total generate. Finally,
perform an I-Total download.

For PROVUE upgrades, add PMAs and PPAs after using this
option. You must also modify all targeted data forms by
supplying the associated PPA.

UM6.1:SW3151 Revision H — July 1996

 Using Tag Sets 6-1

Figure 6-Table 6

6 Using Tag Sets

Tag sets are user-defined lists of tags on which the ENVOXr software can
perform functions, such as document, copy, generate, and download. Tag
sets optimize productivity, because they allow you to execute ENVOX
functions on a group of items. For example, you can use tag sets for:

J Documenting tags — The Match Criteria option on the Tag Set form
lets you specify certain criteria for the items you want in the tag set.
For example, you can ask the software to compile a tag set that
includes tags beginning with the characters DI, sourced in the device 6
named UOC04, and targeted to the device named UOC01. After the
software creates this list, you can add or delete items.

J Generating several devices — You can create a tag set of devices

to generate and then execute the generate function on that list.

The ENVOX system administrator uses tag sets to define areas of limited
access, called security areas, for different devices in different
configuration databases. The System Manager’s Guide to ENVOX
Software, SM6.0:SW3151, describes security area tag sets.

This section describes the different ways you can create a tag set and the
different ways you can use tag sets to be more productive.

6.1 Menu Options That Support Tag Sets

The configuration tasks described in the following paragraphs support tag
sets by enabling you to enter a tag set name in place of an item or device
name.

Document the database — When you use the Document Database

function, you may use a tag set to specify which points you want a report
to include. Section 14 provides details.

Deleting items — When you select Delete from the ENVOX Top Level
Form’s Utilities menu, you may enter the name of a tag set. The software
displays the items in the tag set so that you can review the items and
decide whether to delete them. Subsection 5.8.1 provides details.

Modifying Items — When you select the Modify option from the ENVOX
Top Level Form, you may enter the name of a tag set. The software
allows you to look at the items in the set one at a time so that you can
modify them if you want. Subsection 5.4 provides details.

Revision H — July 1996 UM6.1:SW3151

 6-2 Using Tag Sets

Generate configuration files — You can build the list of devices for
which you want to generate files by specifying a tag set. The software
includes the devices represented by the tag set in the Generation Options
form. Subsection 8.4.3 provides more details.

Uploading on-line configuration data — When you select the Upload

option from the More menu on the ENVOX Top Level Form, the software
enables you to specify the items you want to upload from a tag set.
Subsection 10.1 provides more details.

Downloading configuration files — When you select the Download

menu option, the software enables you to use a tag set to specify the
devices to which you want to send download files.

Exporting devices and/or items — When you select the EXPORT menu
option, the software enables you to use a tag set to specify the devices
6 and/or items you want to export. See Appendix A for more details.

Copying all the data from one point to another — When you select the
Item Copy menu option, the software enables you to copy all the data
(except IST data) in an existing point to the points in a tag set, thereby
creating a new set of points. Subsection 5.7.5 describes the Item Copy
option.

The following is one example of how you can use tag sets to save time. In
this example, you use a tag set with the Item Copy and Modify menu
options to create several similar points:

Step 1: Create one point, for example a DI point called DI101, that you
want to use as a basis for the other points you create.

Step 2: Create a tag set of the DI tags you want to create. Note that
you are entering the tags of points that do not exist, for
example, DI102, DI103, and so on.

Step 3: Use the Item Copy option to copy DI101 to all the items in the
tag set.

Step 4: Use the Modify option to make each of the points in the set
unique.

UM6.1:SW3151 Revision H — July 1996

 Using Tag Sets 6-3

6.2 Ways to Create a Tag Set

There are three ways to create a tag set:

J From the Tag Set form — You can type in the tags on the Tag Set
form or you can use the ENVOX software’s Match Criteria function to
automatically generate the tag set based on criteria you specify.
J From the Generation Errors form — After a generation attempt, you
can call up the Generation Errors form and save all the items that
prevented a successful generation to a tag set.
J With the Ad Hoc Tag Set option — You may want to create a tag set
for one-time use. The Ad Hoc Tag Set option, available under the
Point form utilities menu or several of the document menu options,
helps you quickly create such a tag set.
6
6.3 Creating from the Tag Set Form
The Tag Set form lets you build a tag set either by entering the tags or by
specifying criteria for the tags you want included using the Match Criteria
option.

6.3.1 Accessing the Tag Set Form

To access the tag set form:
Step 1: Select the Utilities menu from the ENVOX Top Level Form.

Step 2: Select the Tag Set option, and Add.

ENVOX TOP LEVEL FORM

X Add Modify! Utilities
Utilities More Status! Help

View
Rename Item
Item Copy
Copy Console Configuration
Display Editor
Tag Set -> -> Add
Highway Access Control List Modify
Delete Delete
Special Functions ->

EV085

Revision H — July 1996 UM6.1:SW3151

 6-4 Using Tag Sets

The software displays an ENTER TAG pop-up form:

ENTER TAG
X! Set Item Type! Help

Item Type:
Add :

The Item Type field is read-only. It shows the type of item

which is being added. The Set Item Type! menu option is not
used with the Add function.
Step 3: Type in the tag for the device you want to create, and press
Return, or, if you have more than one tag name entered, you
6 can return to the immediately preceding name by pressing the
PREV field key. You do not need to type it in.
Tags may have as many as 12 characters, with at least one
alpha character. Legal characters are 0 through 9, A through
Z, and -- . , / (space). The first character cannot be a space.
The software displays the Tag Set form (Figure 6-1).

TAG SET
X Match Criteria! Edit Utilities Help

ADD

Security Area: NO YES Tags in Tag set

Last Matched
___ __________
Tag Set Modified
___ __________
___ __________
Criteria Match v Sort ___ __________
Order ___ __________
Tag: __ ___ __________
Item Type v: __ __ ___ __________
Source Device v: __ __ ___ __________
Target Device v: __ __ ___ __________
Database Index min: max: __ ___ __________
Description: __ __ ___ __________
Strategy: __ __ ___ __________
Tag #: _____ out of:_____
Last Modified on ____________ by ____________

Figure 6-1 Tag Set Form

UM6.1:SW3151 Revision H — July 1996

 Using Tag Sets 6-5

6.3.2 Creating the Tag Set

There are two ways to create the tag set through the Tag Set form: by
entering the tag list manually and by using the Match Criteria! option in
the menu bar.

To enter the tags manually, you use the Tags in Tag Set field, Tag #, and
Out Of fields. To use the Match Criteria! option, you use the Criteria and
Sort Order fields in the lower left corner of the form. The Tag # and Out Of
automatically keep count for any entry form, not just the manual tag entry.

6.3.2.1 Entering the Tags Manually

To manually enter the tags you want in the set, complete the Tags in Tag
Set field. Use the Insert Row key and the Erase Row key to add, delete,
or edit fields. Note that the ENVOX software inserts tags above the 6
cursor, not below it. When you finish, exit the form and apply the changes.

6.3.2.2 Using The Match Criteria! Option

ENVOX software enables you to specify certain criteria and create a tag
set of items which match this criteria. Specify the Criteria and Sort Order
fields on the Tag Set form to establish criteria for the tag set. Select the
Match Criteria! option. The software then queries the database for items
that comply with these criteria and creates a tag set. For example, if you
specify xxx for the item type and yyy for the strategy, the resulting tag set
contains only those tags whose item type matches xxx and whose
strategy matches yyy.

Note these fields in the tag set form:

Security Area — This read-only field indicates whether or not the tag set
is located in a security, Normally, your ENVOX system administrator is the
one who defines security areas.

Last Matched — This read-only field displays the date when the software
last built a tag set from the displayed criteria. This field is filled in if you
enter the form from the Delete or Modify options and is filled in on ADD
once MATCH CRITERIA has been selected.

Tag set modified — This read-only field indicates whether you have
changed the list manually since last using the Match Criteria option. This
field is filled in if you enter the form from the Delete, Modify, or Add
options.

Revision H — July 1996 UM6.1:SW3151

 6-6 Using Tag Sets

Note
A tag set is static. If you add, modify, or delete
items in the database related to the tag set, you
must recreate your original match criteria fields
and request the tag set again in order to
incorporate database changes.

You do not have to fill in all or any of the criteria fields. If you do not
provide any information in the criteria fields, the software builds a list of all
tags in the database. The following paragraphs describe the criteria fields:

Tag — The search string that tags in the list must match. Table 4-1
6 describes search string characters that you can use to build a search
string.

Item type v — The string that matches the item type, for example, DI,
DO, LCP, and so on. You can use search string characters to match items
with similar type names.

Source Device v — The names of the devices the items in the tag set
must be sourced in. You can specify a source device where the Item type
is a point type or an Instrument Signal Tags (ISTs). You can use search
string characters to match items with source devices with similar names.

Target Device v — The names of the devices the items in the tag set
must be targeted to. You can use search string characters to match items
with target devices that have similar names.

Database Index — The database index range that the items in the set
must fall within. For instance, to include all items with a database index
between 100 and 300 inclusive, enter 100 at the Min prompt and a 300 at
the Max prompt.

Description — The string that matches the description field in the item
configuration. You can use search string characters to match items with
similar descriptions.

Strategy — The string that identifies the control strategy you want to
associate this tag set with. The strategy field is used primarily to help in
organizing the database. It enables you to associate a group of items. For
example, you could have the ENVOX software create a tag set of all the
loops in UOC1 that reference the strategy BOILERS.

UM6.1:SW3151 Revision H — July 1996

 Using Tag Sets 6-7

Match v — The qualifier for the criteria to the left of this field. You can
enter AND or NOT, or you can leave this field blank. Entering AND, or
leaving this field blank returns the tags that match the associated criteria
providing they meet the other criteria as well. Entering NOT returns
values that do not match the criteria in the associated field. Figure 6-3
includes an example of how the Match field can be used.

Sort Order — The criteria that the software should sort by. You do not
have to fill in all or any of the Sort Order fields. If you do not specify any
sort order, the software displays the items in the tag set in an undefined
order.

To create a tag set by criteria:

Step 1: Complete one or more of the criteria fields (Tag, Item type v,
Source Device v, Target Device v, Database Index,
Description, Strategy). 6
Step 2: Complete one or more of the Sort Order fields, if desired. (You
are not required to specify any of the Sort Order fields.) The
software sorts text by ASCII character order and integers by
ascending integer order. The spaces at the ends of fields are
significant. “ABCD” appears before “ABCD ” because “ABCD ”
is a longer string. “ABCD ” appears before “ABCDE” because
ASCII considers a space as being less than an “E”.

Step 3: Select the Match Criteria option. The software creates and
sorts a list of items.

TAG SET
X Match Criteria! Edit Utilities Help
EV086

Figure 6-2 and Figure 6-3 are examples of filled-in forms.

Revision H — July 1996 UM6.1:SW3151

 6-8 Using Tag Sets

Figure 6-2 shows tag set criteria that return specific tag names sourced in
UOC--1 and targeted to PROVUE--1.

TAG SET
X Match Criteria! Edit Utilities Help

Security Area: NO YES Tags in Tag set

Last Matched: 14-Apr-1995 12:45:23 ___ 1 DI-1
Tag set modified: NO 2 DI-2
3 DI-3
Criteria Match v Sort 4 D4-4
Order 5 DI-5
Tag: D_-[1-6] ________ 2 6 DI-6
Item type v: _________________ __ 1 7 DO-1
8 DO-2
6 Source Device v:
Target Device v:
UOC-1 _____
PROVUE-1 __
__
__
__
__ 9 DO-3
Database Index min: ____ max: ____ __ 10 DO-4
Description: ______________ __ __ 11 DO-5
Strategy: ______________ __ __ 12 DO-6

Last Modified on ____________ by ____________ Tag #:1 out of: 32

Figure 6-2 Match Criteria Example 1

Figure 6-3 shows tag set criteria that return all the items sourced in
UOC--1 that are not ISTs and are not targeted to any device.

TAG SET
X Match Criteria! Edit Utilities Help

Security Area: NO YES Tags in Tag set

Last Matched: 14-Apr-1995 12:45:23 ___ AI-301
Tag set modified: NO AI-302
AO-102
Criteria Match v Sort
Order
Tag: ____________ 2
Item type v: INSTRUMENT SIGNAL__ NOT 1
Source Device v: UOC-1 _____ AND __
Target Device v: ________ AND __
Database Index min: ____ max: ____ __
Description: ______________ __ __
Strategy: ______________ __ __

Last Modified on ____________ by ____________ Tag #:0 out of: 0

Figure 6-3 Match Criteria Example 2

UM6.1:SW3151 Revision H — July 1996

 Using Tag Sets 6-9

6.4 Creating from the Generation Errors Form

Subsection 8.7.2 describes how to create a tag set of items that fail a
generation attempt.

6.5 Creating an Ad Hoc Tag Set

ENVOX software lets you create an ad hoc, or special purpose, tag set
for quick use during configuration. For example, if you want to know the
tag names of all flow loops in UOC7 (beginning with FIC) so that you can
modify these loops, you can create an ad hoc tag set containing these
point tags. ENVOX software assigns the ad hoc tag your login
USERNAME preceded by the & sign. For example, if your login
USERNAME is JOHNSON, the software names your ad hoc tag set
&JOHNSON. 6
By referencing the tag set, you can quickly modify these points. Once you
complete the modification, you have no more use for the tag set. The
software retains the ad hoc tag set until you create a new one. The new
ad hoc tag set overwrites the old ad hoc tag set.

You can create an ad hoc tag set in one of two ways:

J Through the Utilities menu on a point configuration form:

Step 1: Select the Utilities menu from the menu bar of a point
configuration form.

Step 2: Select the Ad Hoc Tag Set option from the Utilities menu. The
ENVOX software displays the Tag Set form. (If the ad hoc tag
set exists for your current session, the software displays it on
the form.)

PCI POINT
X Edit Utilities
Utilities Extra Data Target! Help

Save
Print
Show Errors
Ad Hoc Tag Set

EV083

Step 3: Create the tag set as you normally would.

Revision H — July 1996 UM6.1:SW3151

 6-10 Using Tag Sets

Step 4: Apply the tag set.

J Through the Ad Hoc Tag Set menu option on either the Detail,
Summary, or Cross-Ref Document forms:

Step 1: Select the Detail, Summary, or Cross-Ref menu from the

Document form, then select an option from the associated
pull-down menu.

Step 2: Ignore the field items on the form—they have no affect on

creating an ad hoc tag set. Select the Ad Hoc Tag Set! option
from the menu. The ENVOX software displays the Tag Set
form. (If the ad hoc tag set exists for your current session, the
software displays it on the form.)

Step 3: Create the tag set as you normally would.

6 Step 4: Apply the tag set.

Access the ad hoc tag set as you would any other tag set, by entering its
name.

The ENVOX software supports one ad hoc tag set per user login
identification (ID). If two users log on to the ENVOX software under the
same ID, both can access the same ad hoc tag set. Logging on under the
same ID can cause problems if one user modifies the tag set without the
other knowing.

If you want to save an ad hoc tag set, use the Item Copy menu option
from the Utilities pull-down menu to copy it to another tag set name.

UM6.1:SW3151 Revision H — July 1996

 Using Tag Sets 6-11

6.6 Modifying a Tag Set

To modify a tag set, select the Tag Set option from the Utilities Menu on
the Top Level form, then select the Modify option form from the slide off
menu. Specify the tag set name to modify and begin modifying the tag set
as you would any other item.

The Edit menu option on the Tag Set form provides two options:

J Delete — Takes you to the Confirm Action form where you must
either Confirm or Cancel your delete request. If you Confirm, the
software deletes the tag set from the database and takes you to the
previous form.

J Clear — Clears all items from the Tag Set form without deleting the
tag set. You remain on that tag set form and can then enter new data
for the specified tag set. 6

6.7 Deleting a Tag Set

To delete a tag set, select the Tag Set option from the Utilities Menu on
the Top Level form, then select the Delete option form from the slide off
menu. Specify the tag set name to delete. The software displays the tag
set form. Apply the form to confirm the deletion.

Revision H — July 1996 UM6.1:SW3151

 6-12 Using Tag Sets

6.8 Tag Set Access from ISQL

In some cases it may be easier to create a special tag set using ISQL
instead of the ENVOX forms.

You can use ISQL to insert rows into an existing tag set or into a new tag
set. The tag_set table has triggers that enable you to create a new tag set
automatically when required.

You must be careful when using ISQL to insert the row; if not done
correctly, the integrity of the configuration data can be lost. Contact your
system administrator for instructions before attempting to use ISQL.

Deleting all the rows of one tag set does not delete the set; it only makes
it empty. In order to delete a tag set, you must use the ENVOX forms
system.
6
The following are restrictions when using ISQL:

J ISQL users are restricted by triggers from making changes to a

security area tag set. The message you receive in this case is: You
are not allowed to update a security area.

J ISQL users are restricted by triggers from updating a tag_set’s row

from one tag set to another.

J ISQL users are restricted by triggers from inserting a row in a new tag
set such that the tag of the new type already exists in the database
with an item type other than the tag set.

J ISQL users are restricted by triggers from operating on rows of more

than one tag set in one operation.

UM6.1:SW3151 Revision H — July 1996

 Using the Language Editor 7-1

Figure 7-Table 7

7 Using the Language Editor

The language editor is a free-form editor you use to create the following
logic sequences:

J Logic control point (LCP) function sequence tables (FSTs)

J Interactive controller (IAC) and computing controller function

sequence tables (FSTs)

J Procedures

J Operations

J Console reports
7
J Conditional color expressions

J Conditional text expressions

The instructions that you use to create these sequences are different for
each sequence type and are not described in this section (except for the
console reports editor). For information about specific sequence
instructions, refer to the configuration engineering manuals for the
controllers and operator consoles.

This section describes how to access the language editor, use the
language editor to enter and save instructions, use the editor’s special
function keys, and use the various language editor features such as cut
and paste, find and replace, and split window.

Revision H — July 1996 UM6.1:SW3151

 7-2 Using the Language Editor

7.1 Accessing the Language Editor

You access the language editor for all logic sequence types, except IAC
FSTs, by selecting the Logic option from the ENVOX Top Level Form’s
Add menu.
IAC FSTs are not selected through the Logic option, but through the
Devices option. To access the editor for IAC FSTs, see subsection 7.1.6.

ENVOX TOP LEVEL FORM

X Add
Add Modify! Utilities More Status! Help

UOC/IFC/SR90 POINTS ->

CONSOLE POINTS ->
CHIP POINTS ->
7 OTHER POINTS ->
DEVICES ->
LCP FST
LOGIC ->
OPERATION
INSTRUMENT SIGNAL
CONSOLE REPORTS->
GLOBAL ITEMS ->
PROCEDURES ->
EV046
CONDITIONAL COLOR
CONDITIONAL TEXT

Use the Logic slide-off menu options to access the language editor
directly or through a form. The editor works the same for all sequence
types. Keep in mind, however, that you can only use the instructions for
the sequence type you selected. For example, if you access the
language editor for FSTs, you cannot use console reports instructions.

7.1.1 Accessing the Editor for LCP FSTs

To access the language editor to create an LCP FST sequence:
Step 1: Select the LCP FST option from the Logic slide-off menu. The
software displays the an ENTER TAG popup form. After you
enter an LCP FST name, the LCP FST form is displayed.
Step 2: Select the Edit FST! option on the LCP FST form.

LCP FST
X Edit Utilities Extra Data EditFST!
Edit FST! Help
EV187

UM6.1:SW3151 Revision H — July 1996

 Using the Language Editor 7-3

7.1.2 Accessing the Editor for Operations

To access the language editor to create an operation sequence:
Step 1: Select the Operation option from the Logic slide-off menu.
After you enter an operation name, the software displays the
Operation form.
Step 2: Move the cursor onto the Step Name you want to edit, and
select the Step! option from the Operation form.

OPERATION
X Edit Utilities Extra Data Reorder Step!
Step! Help
EV188

7.1.3 Accessing the Editor for Console Reports 7

To access the editor to write a console report:
Step 1: Select the Console Reports option from the Logic slide-off
menu.
Step 2: Enter a report name. The software displays the language
editor.
The Report Header and Equipment List options call up forms.
Configuring the PROVUE Console (CE7.0:DC6460) describes the forms.

7.1.4 Accessing the Editor for Procedures

To access the language editor to write a procedure:
Step 1: Select the Procedures option from the Logic slide-off menu.
Step 2: Select Procedures from the slide-off menu.
Step 3: Enter a procedure name. The software displays the
Procedure form. (The Procedure List option calls up a form.
The console configuration engineering manuals describe the
form.)
Step 4: Move the cursor to the process name you want to edit and
select the Process! option on the Procedure form.

PROCEDURE
X Edit Utilities Extra Data Reorder Process! Help
EV189

Revision H — July 1996 UM6.1:SW3151

 7-4 Using the Language Editor

7.1.5 Accessing the Editor for Conditional Color and

Conditional Text
Conditional color and conditional text are conditional expressions used in
PROVOX system operator consoles. To access the editor to define a
conditional expression:

Step 1: Select the Conditional Color or Conditional Text option from

the Logic slide-off menu.

Step 2: Enter a conditional color or conditional text name. The

associated form is displayed.

Note that in PROFLEX software, nested IF statements are configured as

follows:

IF some expression THEN

IF some expression THEN
IF some expression THEN
7 IF some expression THEN color on color,
IF some expression THEN color on color,

In this example, the first four IF instructions are nested four deep. The
fifth IF instruction is not nested. Two of the possible 16 maximum
non-nested IF statements have been used.

In ENVOX software, the null THEN instructions are omitted so that the
same code looks as follows:

IF (some expression)
IF (some expression)
IF (some expression)
IF (some expression)
THEN (color, color)
IF (some expression)
THEN (color, color)

This coding applies for conditional color and conditional text expressions.
If you enter the PROFLEX style of conditional into the ENVOX instruction
editor, you run the risk of running over the maximum limit of 16
non-nested IF instructions. Also, generation flags the item as incomplete,
since the THEN instructions have no data.

Note that you can also access the language editor for conditional
expressions through a console display editor. Refer to the console
configuration engineering manuals for instructions.

UM6.1:SW3151 Revision H — July 1996

 Using the Language Editor 7-5

7.1.6 Accessing the Editor for IAC FSTs

To access the editor to create an IAC FST sequence:

Step 1: Select Add from the ENVOX Top Level Form.

Step 2: Select Devices from the pull-down menu.

Step 3: Select IAC/Computing from the slide-off menu.

Step 4: Enter a device name. The IAC/Computing Controller form is

displayed.

Step 5: Select the Edit FST! option.

IAC/COMPUTING CONTROLLER
X Edit Utilities Extra Data EditFST!
Edit FST! Help 7
EV186

7.2 Navigating in the Language Editor

Once you are in the language editor, you develop an instruction in an
open format. When you have finished the instruction, you close it and go
on to develop the next instruction. How function keys work in the
language editor depends on whether an instruction is open or closed.

J For open instructions, ENVOX software restricts you to navigation

within the operands of that instruction.

J If all of the instructions are closed, your scope of navigation is the

first character of any instruction in the entire sequence.

Appendix C describes the functions of the Language Editor keys.

Revision H — July 1996 UM6.1:SW3151

 7-6 Using the Language Editor

7.3 Adding an Instruction

Once you are in the language editor, you can add instructions. To add an
instruction, perform the following steps:

1. Enter an instruction mnemonic. Subsection 7.3.1 provides more

details on entering mnemonics.

2. Fill in the operands.

3. Close the instruction with the OPEN/CLOSE key.

The following subsections describe each of these steps.

Remember, you can suppress warnings during your edit session. Refer
to subsection 4.1 for instructions.

7.3.1 Entering Instruction Mnemonics

7
Begin typing instructions on the first line in the editor. If you do not know
the complete mnemonic, enter the first few letters and press Return.. The
system either:

J Completes the instruction, if only one instruction matches the letters

you typed, and opens the instruction for editing. For example, if you
enter CAC in the operations language editor, the software completes
the instruction by adding QUIRE so that CACQUIRE is displayed.

J Displays a list of all valid instructions that start with the characters
you typed. For example, if you enter AD, the software displays ADD
and ADVREQ. To remove the list, press the EXIT key.

If you do not know which instructions are valid, you can display a list of
valid instructions. To do this, either:

J Press the Help key. The system displays a pop-up window containing
all instructions available for use. Figure 7-1 shows an abbreviated list
of the instructions shown when you press the HELP key while
creating an operation. To remove the list, press the EXIT key.

J Use the Language Help form. Subsection 7.9 describes the

Language Help form.

UM6.1:SW3151 Revision H — July 1996

 Using the Language Editor 7-7

AVAILABLE INSTRUCTIONS

ACQUIRE { Acquire Resources }

ACTIVATE { Activate }
ADD { Add }
ADVREQ { Advance Request }
CACQUIRE { Conditional Acquire Resource }
CALCULATE { Calculate }

D D
D D
D D

Press RETURN for more>

Press EXIT to leave >

EV190

Figure 7-1 Pop-Up List of Valid Instructions

Note
While in the editor, when you hold down a
scrolling key for several seconds, some unusual
characters may appear on the screen. If this
happens, use the backspace key to remove the
characters, and continue.

When you type an instruction mnemonic and press Return, the

instruction appears in expanded, or open, form. That is, the software
displays a prompt for each operand that the instruction requires. For
example, if you enter the mnemonic ADD, the software displays the
expanded instruction in Figure 7-2.

Revision H — July 1996 UM6.1:SW3151

 7-8 Using the Language Editor

ADD { Add } Instruction

destination >>
value 1 >> Operand
value 2 >>
Prompts
comment >>

7 Context--Sensitive User
Operand Help
Message
Information Status

Operation: FILLTANK-1A3 Step: WAITONLEVEL3

Message: Enter a UV location for result

EV191

Figure 7-2 Instruction in Open Format

The screen is composed of several elements. They include:

Instruction — The instruction mnemonic that you entered and
parentheses for the operands.
Operand prompts — The prompts for all the operands required for this
instruction.
Context-sensitive user information — Information relating to the
specific task for which you are using the language editor. For this
example, this information indicates the operation and step names.
Operand help message — A description of the operand value required
for the operand the cursor is on.
Status — One of three status words indicating that you have requested
a special function:
J SELECT — Indicates you pressed the Select key.
J ERRORS — Indicates you pressed the FIND ERRORS key.
J PREVIEW — Indicates you are previewing a report.
J VIEW — Indicates you accessed the editor through VIEW mode.

UM6.1:SW3151 Revision H — July 1996

 Using the Language Editor 7-9

7.3.2 Filling in the Operands

Enter data at the operand prompts. If you enter an invalid operand, the
software displays an error message that describes why the operand is
invalid. Press Return or the EXIT key to remove the error message.

7.3.3 Closing an Instruction

When you have entered valid operands for each prompt, press Return.
Press the EXIT key or the OPEN/CLOSE key to close the instruction, or
press Return after the comment operand. Figure 7-3 shows the ADD
instruction in closed format.

0000:ADD (UV[26], UV[26], 1) {add 1 to UV26}

7
Figure 7-3 Example Instruction in Closed Format

You can continue to type in a sequence of instructions and comments in

this way. You can indent your instructions as many as 30 columns using
the space bar. The editor scrolls up as you reach the bottom of the page.

When you are done entering instructions, save your instruction set as
described in subsection 7.12.

Revision H — July 1996 UM6.1:SW3151

 7-10 Using the Language Editor

7.4 Including Blocks of Instructions

You can also include a block of existing instructions from another
instruction set. Only instructions from the same language editor can be
included. For example, if an LCP FST is currently being edited, you can
only include instructions from another LCP FST. The following sections
describe the Include function and the Include libraries.

7.4.1 Using the Include Function

To access the Include function, you must be in a language editor
session. The instruction is included at the current cursor position. The
Include function can only be accessed while in the Line Mode; that is, no
comments or instructions are opened, no find/find nulls in progress, and
so forth.
The way you include an instruction block is different for operations and
procedures than for all other sequence types.
7
7.4.1.1 Including an Instruction Block in Operations and Procedures
To include an instruction block:
Step 1: Press the MORE key. The software displays the following
pop-up:

Include
Learn Sequence
Cancel

Step 2: Highlight the Include option and press the Return key. The
software displays the following window:

INCLUDE
TAG v: PROCESS V:

Figure 7-4 Include Function Window

The window contains a Tag entry field, and an ID field.

J For Operations, this field is displayed as Step. This field is
the name, not the number of the Step.
J For Procedures this field is displayed as Process. This
field is the name not the number of the process.

UM6.1:SW3151 Revision H — July 1996

 Using the Language Editor 7-11

Step 3: Enter a tag name in the Tag field and press the Return or
Enter key. The system checks for the entered tag among
those configured for this particular language. If the tag is
configured and of the correct language type, the cursor is
positioned at the Process or Step field.

If the tag is not valid the following error message is displayed:

E3069: ERROR — Tag entered is not a

configured <language> Tag

where <language> is the current language being edited. You

must acknowledge the message.

Step 4: At the Process or Step field, enter a process or step name

and press Return or Enter. The system validates the name
against those configured for the particular tag. If the name is
valid, the instruction for the Process or Step is included at the
cursor position previous to the location where the include
function was requested. 7
An informational message is displayed stating the number of
instructions <n> included. You must press the Return or EXIT
key to acknowledge the information message.

If the Process or Step name is not valid for the Procedure or

Operation the following error message is displayed in the
standard editor window:

E3070: ERROR — <id_name> is not configured

<step/process> for this <language>

Revision H — July 1996 UM6.1:SW3151

 7-12 Using the Language Editor

7.4.1.2 Including an Instruction Block for All Other Sequence Types

Step 1: Press the MORE key. A menu with INCLUDE as the first
option is displayed.

Step 2: Highlight the INCLUDE option press Return. The following

window is displayed.

INCLUDE
TAG v :

Figure 7-5 Include Function Window

The window contains a Tag entry field.

7 Step 3: Type the tag name and press Return or Enter. The system
checks for the entered tag among those configured for the
particular language. If the tag is configured and of the correct
language type, then the instruction for the entered tag is
included at the cursor position previous to the location where
the Include function was requested.

An informational message is displayed stating the number of

instructions <n> included. You must press the Return or EXIT
key to acknowledge the information message.

UM6.1:SW3151 Revision H — July 1996

 Using the Language Editor 7-13

7.4.2 Include Libraries

Special tags exist (pattern tags) that can be used to enable libraries of
instructions to be created for inclusion at any point into a language editor
session. Since these library items are likely to be incomplete as they
stand, the language editor will not perform any exit validation of any
edited item that is a pattern tag; however, normal operand entry checking
and validation is performed. For additional information see subsection
4.3.4.4 and subsection 4.3.4.5.

The library items are created in the same way as for normal language
editor items except that they must all have the pattern tag format, and
the first character must be an exclamation character (!). If not, the
Language Editor performs the normal exit checks which can prevent an
item from being saved.

It is normally impossible to save the following three lined LCP FSTs from
the editor since an END statement and the label START1 is not
configured; however, if the tag of the FST is a pattern tag, the three lines
will save without error.
7
LDSV (B2)
BRA (=,TRUE,START1)
PDET (B2,B3)

This allows you to build your own library of commonly used FST
instructions for inclusion into other FSTs.

Note
Use register names with caution in library
instructions. Including a library routine into
another item results in the item being incomplete
if the register name is not configured for that item.
Or, the register name may be configured, but at a
different index. The editor will not give any
warning message to this effect following an
include.

Revision H — July 1996 UM6.1:SW3151

 7-14 Using the Language Editor

7.5 Modifying Instructions

To modify instructions, position the cursor on the instruction and press
the OPEN/CLOSE key. The software opens the instruction so that the
operands can be edited. Press the OPEN/CLOSE key to close the
instruction or simply press Return at the Comment operand.

To modify a loadable function that is used as an operand in an IAC FST

instruction, press Select (rather than the OPEN/CLOSE key) to open the
function for editing. Close the loadable function using the OPEN/CLOSE
key or simply press Return at the last operand field.

7.6 Adding a Comment

You can enter a comment for an open instruction or when all instructions
are closed.
Each instruction (except LAYOUT in reports) has a comment operand.
7 This line comment is restricted to 255 characters. You enter this
comment as you would any other operand. When you close the
instruction, the line comment is placed inside curly brackets ({}) after the
instruction starting at column 51. If necessary, the comment wraps to
column 51 of the following lines. (You may now continue to enter another
instruction mnemonic or a comment.)

To write a comment when all instructions are closed, type an open curly
bracket ({) and edit your comment as you would in a text editor. When
you’re finished, press the OPEN/CLOSE key. The language editor
supplies the closing bracket.

If you want blank lines between comments or instructions, you must

enclose the line in curly brackets. You can indent comments using the
space bar.

UM6.1:SW3151 Revision H — July 1996

 Using the Language Editor 7-15

7.7 Cutting and Pasting Text

The language editor provides two kinds of cut and paste, for:

J instructions

J text within comments

Each type has a separate paste buffer. You can store instruction or
series of instructions in one paste buffer and a string of comment text in
the other.

7.7.1 Cutting and Pasting a Closed Instruction

To cut and paste a closed instruction, or a series of closed instructions
(instructions include the instruction named COMMENT):

Step 1: With the cursor on the first instruction you want to cut,
press the Select key. 7
Step 2: Use the up or down arrow key to pass over the instructions
you want to cut.

Step 3: Press the Remove key. The instructions go the paste buffer.
You can paste the instructions by pressing the Insert Here
key. You can paste the instructions elsewhere in this
instruction set, or in another instruction set. Also, the paste
buffer retains its contents until you paste something else into
it, enabling you to do multiple pastes.

7.7.2 Cutting and Pasting Text Within Comments

To cut and paste text within comment instructions:

Step 1: With the comment instruction open, use the Select and
Remove keys to move the desired text into the paste buffer.

Step 2: You can paste this text elsewhere within this comment or in
another comment within this instruction set using Insert Here.
The paste buffer retains its contents until you paste
something else into it. This enables you to do multiple pastes.

Revision H — July 1996 UM6.1:SW3151

 7-16 Using the Language Editor

7.8 Finding and Replacing Text

The language editor software lets you search for a string of text and
replace the string with a different string. To search for a text string and
replace it with a different text string:
Step 1: Press the FIND/REPL key. The software shows at the bottom
of the display a pop-up interface like the one in Figure 7-6.

7
Search for :
Case
Replace with : Sensitive
Operation: FILLTANK-1A3 Step: WAITONLEVEL3

Message: Enter a UV location for result

EV193

Figure 7-6 Instruction in Open Format

Step 2: After the Search For prompt, enter the name of the string you
want the software to find. Note that the search function is
case sensitive and looks for exact character matches. For
example, if you enter ADD, the software does not find ADDP
or add or Add.
Step 3: After the Replace With prompt, enter the text string with which
you want to replace the old string.
Step 4: To start the search, press Return. To abort the search, press
the EXIT key. The software finds the first occurrence of the
string and prompts you to select Apply, Skip, Quit, or
All Remaining, which are described below:
J Apply — Replaces the search string with the replace
string
J Skip — Skips to the next occurrence
J Quit — Returns you to instruction entry

UM6.1:SW3151 Revision H — July 1996

 Using the Language Editor 7-17

J All Remaining — Replaces all occurrences

without confirmation

The software checks the validity of each operand you replace.

If the software encounters an error, the software goes back to
the offending replacement and prompts you with Apply, Skip,
Quit, and All Remaining again.

7.9 Getting Help

There are two kinds of help within the language editor. You can:

J Display a list of valid language editor instructions

J Obtain help for a selected instruction

To view the list of valid language editor instructions that are specific to
the type of logic sequence you are editing (FSTs, operations, and so on)
press the Help key.
7
To access help for all instructions:

Step 1: Make sure your cursor is not on an instruction. Press the

HELP key. The Language Help form is displayed, which lists
the functions into which the instructions are grouped, for
example, mathematical and logical.

Step 2: Select a function using the arrow keys to move to the

function and press Return.

Step 3: From the form’s menu bar, select the Group option. This
causes the list of instructions to appear.

Step 4: Select an instruction using the arrow keys to move to the

instruction and press Return.

Step 5: Select the Instruction option from the form’s menu bar to see
the instruction help screen.

The instruction help screen defines the instruction and provides menu
options Navigation and Operands. Selecting the Navigation option
shows further options: General Keys, Move (closed mode), Move (open
mode), Select Keys, Find Keys. Selecting the Operands option displays
the operand help text on the form.
You can also view help for a specific instruction or operand directly,
without accessing the Language Help form. To do this, place your cursor
on an instruction or operand and press the HELP key. A help screen for
that instruction is displayed.

Revision H — July 1996 UM6.1:SW3151

 7-18 Using the Language Editor

7.10 Using the Split Window Feature

The language editor also provides a split window capability, which splits
the editor screen in half and displays a a read-only window on top and a
main editing window on the bottom. An example of a split window is
shown in Figure 7-7.

0000: [End of buffer]

READ-ONLY WINDOW

7
PROVUE Report: NEW |Read-only|
0000: [End of buffer]

MAIN EDITING WINDOW

PROVUE Report: NEW

Message: Enter instruction.

EV192

Figure 7-7 Language Editor Split Window Example

The split window feature enables you, while creating a new instruction
sequence, to view another existing instruction sequence. You can then
include all or part of the sequence in the read-only window into the main
editing window. Appendix C shows the GOLD function keys used with
the split window feature.

Because the top half of the screen is a read-only window, you cannot
change or erase instructions. You can, however, search, get help, print,
cut and paste, and so on. In addition, the sequence type you view in the
read-only window must be the same type as that in the main editing
window.

UM6.1:SW3151 Revision H — July 1996

 Using the Language Editor 7-19

To create and use a split window:

Step 1: In the editor, press the Gold key and then the OPEN/CLOSE
key. The window splits; the read-only window is on the top of
the screen, and the main editing window is on the bottom.

Step 2: To view an existing instruction sequence in the read-only

window, press the Gold key and then the READ TO BUFFER
key.

A window is displayed where you enter the Tag name of the

instruction sequence you want to view and, if you are creating
a procedure or operation, an ID field. At this point, you can
include a block of instructions into the read-only window.
Refer to subsection 7.4 for how to do this.

Step 3: Once you have included a block of instructions, you can cut
selected instructions from the read-only window and paste
them into the main editing window using the Gold key
followed by the up arrow and the Gold key followed by the 7
down arrow or the Gold key followed by the OTHER
WINDOW key to toggle between the two windows.

Step 4: After you have copied the instructions you need into the main
editing window, and no longer need the split window, press
the Gold key and the ERASE WINDOW key to exit the split
window function.

Note that you can skip Step 1 if you wish. You do not need to split the
window first. Simply type the Gold key followed by the and READ TO
BUFFER key. When you enter the Tag name, the system will split the
window and place the included sequence in the top window.

Revision H — July 1996 UM6.1:SW3151

 7-20 Using the Language Editor

7.11 Using the Learn Feature

The learn feature lets you assign a series of keystrokes to a single
macro key. The sequence can be a combination of commands and text.
The sequence can also include other macro keys. You can nest macros
four-deep. For example, macro A can call macro B, which can call macro
C, which can call macro D.

The language editor remembers the sequence for the duration of the
editing session.

Step 1: To start a learn sequence, press the MORE key. The software
displays the following popup:

Include
Learn Sequence

7 Cancel

Step 2: Select Learn Sequence and press return.

Step 3: Type the text, commands, and other macro keys you want
assigned to the sequence.

Step 4: When you are finished with the sequence, press Ctrl-R. The
software prompts you for the key to which you want to assign
the learn sequence.

Step 5: To assign the sequence to a macro key, type a single alpha

character (A through Z).

You can invoke the learn sequence during this editing session by typing
the GOLD key followed by the macro key you assigned in 7.12.
Appendix C defines what the GOLD key is on all ENVOX platforms.

UM6.1:SW3151 Revision H — July 1996

 Using the Language Editor 7-21

7.12 Saving Your Instruction Set

To exit the edit session press the EXIT key. The software displays a
window where you select:

J Save With Check

J Save Without Check

J Cancel

J Quit.

Each of these options is described in this subsection.

To navigate through the decisions described in this subsection, you use

the arrow keys to make your selection and the Return key to apply it.

7.12.1 Save With Check 7

The Save With Check option checks the syntax and all the references to
item data within the instruction set such as label declarations, phrase
declarations, and point list declarations. External references, such as
point tags, are not checked.

If an error is found, that is, if the referenced data is not there, the system
displays an error and returns to the instruction editor. Incomplete fields
are not considered to be errors, so you can save incomplete instruction
sets and return to finish your work later.

If no errors occur, for most sequence types, the system displays the size
of the item in bytes for certain items, such as FSTs, and prompts you to
confirm the save. If you select No, you are returned to the editor and no
data is saved. If you select Yes, the software saves the data.

However, if you are editing steps or processes within an operation, the

system displays another window where you select Exit, Save and Edit
New, or Cancel.

J Exit — saves the data as described above and exits you from the
editor

J Save and Edit New — enables you to save the current step or
process and select another step or process without leaving the
language editor

J Cancel — returns you to the previous window

Note that if you entered the language editor from an associated form,
you must Apply from this form to make your editing changes part of the
database.

Revision H — July 1996 UM6.1:SW3151

 7-22 Using the Language Editor

7.12.2 Save Without Check

The Save Without Check option checks the syntax (overlooking
reference errors). For certain items such as FSTs, the software displays
the size of the item in bytes and prompts you to confirm the save. If you
select No, the software returns you to the editor—no data has been
saved. If you select Yes, the software saves the data.
However, if you are editing steps or processes within an operation, the
system displays another window where you select Exit, Save and Edit
New, or Cancel.
J Exit — saves the data as described above and exits you from the
editor
J Save and Edit New — enables you to save the current step or
process and select another step or process without leaving the
language editor

7 J Cancel — returns you to the previous window

Note that if you entered the language editor from an associated form,
you must Apply from this form to make your editing changes part of the
database.

7.12.3 Cancel
When you select the Cancel option, the software returns you to the
instruction edit session without affecting the database.

7.12.4 Quit
When you select Quit, the software asks if you want to quit, and provides
you with a Yes/No choice. If you select No, the software returns to the
editor. If you select Yes, the software exists the language editor without
saving any changes made during the edit session.
However, if you are editing steps or processes within an operation, the
system prompts you with the message:
’Quitting current step (or process)’
Edit new?
followed with the options Yes, No, Cancel.
J Yes — quits the current step or process and allows you to edit
another step or process without leaving the editor.
J No — quits the current step or process and exits you from the
language editor.
J Cancel — returns you to the step or process which you were editing.

UM6.1:SW3151 Revision H — July 1996

 Using the Language Editor 7-23

7.13 Creating a Console Report

The console report instructions enable you to define the data and the
format of a console report. Console reports can include text strings that
you define, point attribute data, time and date indicators, and other data
that document process changes. You create reports using the language
editor. During console configuration, you define what reports you want the
console to print and when. Subsections 7.13.1 through 7.13.4 define the
valid instructions for console reports. Subsection 7.13.5 shows how to
view the report format without having to download and actually request a
hard copy of the report from a console. Subsection 7.13.6 shows an
example of a report. The configuration engineering manuals for the
consoles provide additional background about configuring reports.

7.13.1 LAYOUT and PRINT Instructions

There are two basic instructions that you use to build a report: LAYOUT
and PRINT. When you enter the LAYOUT instruction, the editor displays
a layout window like the one below: 7

Instruction
Layout window

LAYOUT
====-====-1====-====2====-====3====-====4====-====5====-====6====-====7

=======================================================================

The layout window provides a working area for positioning the text and
other data you want in the report. A report line can include as many as
132 characters. The window displays part of the line. To view the
undisplayed section, press the right arrow key.
The next step is to identify the text you want printed (if any) and to create
a placeholder for your data. For example:

LAYOUT Text string Data placeholder characters

====-====-1====-====2====-====3====-====4====-====5====-====6====-====
The time is @@@@@@@@@@@@@@@@@
======================================================================

Revision H — July 1996 UM6.1:SW3151

 7-24 Using the Language Editor

To exit the layout window, press the OPEN/CLOSE key. If you had
entered the information shown above, the editor reads your text string
and data placeholder and automatically creates print statements so that
you can specify the type of information to print. For example:

LAYOUT
====-====-1====-====2====-====3====-====4====-====5====-====6====-===
The time is @@@@@@@@@@@@@@@@@
=====================================================================

PRINT (TIME DATE, LEFT, NOUNDERLINE)

7 Note that the software creates one print instruction to support the data
you entered in the layout window for each data place holder. The
example .above shows the instruction with the desired operand values
already in parentheses. An actual display would not look precisely like
this. The editor supplies default values for justification (default is left) and
underline (default is no underline) until you alter them.
Now you must fill in the fields for each print instruction. The following
paragraphs describe the fields.
Print Item — Identifies the type of report item that you want printed.
Selections are:
J The keyword TIME DATE. This calls the actual time and date into the
report from the system clock.
J The keyword POINT followed by: Attribute[Occurrence]:Point Tag.
This prints the attribute specified.
J The keyword LIST followed by: Attribute[Occurrence]:Point List
Name. This prints the next point in the list.
J The keyword BATCH followed by: Attribute[Occurrence]. This prints
the batch end data specified.
J The keyword PHRASE followed by: phrase list name. This prints the
next phrase in the list.
J The keywords STATUSER:n. This prints the user name of the user at
station n, where n is 1 through 4.
Justification — Determines where the software places the item within
the field if there is extra space. Selections are: LEFT, CENTER, and
RIGHT.
Underline — Determines whether the software underlines the data in
the report. Selections are UNDERLINE and NOUNDERLINE.

UM6.1:SW3151 Revision H — July 1996

 Using the Language Editor 7-25

Comment — Provides a placeholder for your comment. Comments are

readable when you are looking at the instruction set, they do not show
up on the report.

If you delete a layout instruction, all the corresponding PRINT

instructions are deleted.

Note that the following keys have these restrictions in the reports editor:

J Remove (ERASE ENTRY) — Cannot cut a partial layout and print

group.

J The ENBL/DSBL key — Does not work with a PRINT statement by

itself. Works with a LAYOUT instruction and automatically affects the
associated PRINT statement.

J Insert Here — Does not work within a layout and print group. Must
be used on or above the LAYOUT instruction, or below the PRINT
instruction.
7
7.13.2 HISTORY Instructions
History instructions lets you create a console report that logs the alarms
or changes for activity points, lists, and batches. There are three history
instructions:

J POINT HISTORY — Prints the alarm history or the change history of

an activity point.

J LIST HISTORY — Prints the alarm history or the change history of

the activity points defined in a point list instruction.

J BATCH HISTORY — Prints the alarm history or the change history of

a batch processed by an activity point. This information is printed
only if the report is a batch end report and the report is printed by a
batch log statement in a procedure.

Figure 7-8 shows an example of each instruction.

Revision H — July 1996 UM6.1:SW3151

 7-26 Using the Language Editor

POINT HISTORY (
ALARM or CHANGE >> _________
activity point name >> _________
comment >> _________

LIST HISTORY (
ALARM or CHANGE >> _________
point list name >> _________
comment >> _________

BATCH ALARM HISTORY (

ALARM or CHANGE >> _________

7 comment >> _________

EV194

Figure 7-8 Example History Instructions

For example:

To print the alarm history of point ACT 121, the instruction would read:

POINT HISTORY (ALARM, ACT 121)

To print the change history of point ACT 121, the instruction would read:

POINT HISTORY (CHANGE, ACT 121)

UM6.1:SW3151 Revision H — July 1996

 Using the Language Editor 7-27

7.13.3 REPEAT, NEXT, UNTIL, and UNTIL END Instructions

The REPEAT, NEXT, UNTIL, and UNTIL END instructions enable you to
create a report that repeats a block of instructions. You can create as
many as four nested REPEAT-and-UNTIL loops. The following
paragraphs describe the instructions.

REPEAT — Marks the beginning of the block of instructions you want to

repeat.

NEXT — Selects the next element of a point list or phrase list for use by
PRINT instructions.

UNTIL — Marks the end of a series of instructions that begin with a

REPEAT instruction. The instructions between the REPEAT instruction
and the UNTIL instruction repeat until the condition specified in the
UNTIL instruction is true.

UNTIL END — Marks the end of a series of instructions that begin with a
REPEAT instruction. The instructions between the REPEAT instruction 7
and the UNTIL END instruction repeat until the system reaches the end
of the point list or phrase list. Include a NEXT instruction in the loop to
step through the list.

7.13.4 Additional Instructions

The following instructions are also valid when creating a console report:

J PHRASE LIST — Creates a named list of as many as 10 character

strings that you can print with subsequent print instructions. Use the list
name when referring to the list you want printed in PRINT instructions.

J POINT LIST — Names an equipment list so that you can refer to

point tags in the list from a PRINT instruction.

J BLANK LINES — Prints the number of blank lines you specify.

J FORM FEED — Advances the paper to the top of the next page.

Revision H — July 1996 UM6.1:SW3151

 7-28 Using the Language Editor

7.13.5 Previewing a Report

At any point as you create your report, you may want to see how it will
look when printed. To preview a report, press the PREVIEW key. The
software displays an 80-column, read-only report that approximates the
layout of the hardcopy. PREVIEW appears on the status line. To view
columns off the screen to the right, press the NEXT FIELD key. Pressing
the PREVIOUS FIELD key tabs to the left until column one is visible.

Previewing displays the following:

J LAYOUT instruction

J REPEAT instruction

J UNTIL instruction

J UNTIL END instruction

7 J blank lines

J form feed

To return to editing, press the EXIT key or the PREVIEW key. The cursor
returns to where it was. You can move the cursor around the preview
screen. If you move the cursor around and press EXIT or the PREVIEW
key, the software returns you to the instruction you were on before
previewing. If you move the cursor on to an instruction in the preview
version and press the Select key, the software takes you to the
corresponding instruction in the edit session.

UM6.1:SW3151 Revision H — July 1996

 Using the Language Editor 7-29

7.13.6 Example Report

Figure 7-9 is an example of an edit display for a console report.

PHRASE LIST (PHRASE, TAG, DESCRIPTION, PV)

POINT LIST (ALIAS1, AQUIP1)

LAYOUT
====-====-1====-====2====-====3====-====4====-====5====-====6====-====7==
The time is @@@@@@@@@@@@@@@@@
=========================================================================
PRINT (TIME DATE, LEFT, UNDERLINE)
LAYOUT
====-====-1====-====2====-====3====-====4====-====5====-====6====-====7==
TAG DESCRIPTION PV SP %OUTPUT
7
=========================================================================
REPEAT
LAYOUT
====-====-1====-====2====-====3====-====4====-====5====-====6====-====7==
@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@ @@@@.@@ @@@@.@@ @@@@.@@
=========================================================================
PRINT (LIST TAG:ALIAS1, LEFT, NOUNDERLINE)
PRINT (LIST DSCR:ALIAS1, LEFT, NOUNDERLINE)
PRINT (LIST PV:ALIAS1, LEFT, NOUNDERLINE)
PRINT (LIST %OUTPUT:ALIAS1, LEFT, NOUNDERLINE)
PRINT (LIST SP:ALIAS1, LEFT, NOUNDERLINE)
NEXT (LIST ALIAS1)
UNTIL END (LIST ALIAS1)

----------------v----------------------------------------------------------

----------------^----------------------------------------------------------
Figure 7-9 Example Console Reports Edit Display

Revision H — July 1996 UM6.1:SW3151

 7-30 Using the Language Editor

7.14 Printing ASCII to a Printer or a File

You can print the contents of an editing session to a printer or create an
ASCII file. You can print the entire edit session or highlighted text only.

Press the Print key. The following popup appears:

Print Selected Text

Print All Text
Create File (Selected Text)
Create File (All Text)
Cancel

J Print Selected Text — Prints highlighted text. If no text is

highlighted, nothing is printed.
7 J Print All Text — Prints all the text in the buffer regardless of
highlighting.

J Create File (Selected Text) — Displays a file entry window, enabling

you to enter a file path up to 64 characters long. The option then
creates a file including the selected text. Valid characters are A
through Z, a through z, 0 through 9, /, $, --, _, and period (.). Brackets
([ and ]) are valid for VMS systems only. If no text is selected, the
option does not create a file.

J Create File (All Text) — Displays a file entry window, enabling you to
enter a file path up to 64 characters long. Valid characters are A
through Z, a through z, 0 through 9, /, $, --, _, and . (period). Brackets
([ and ]) are valid for VMS systems only. The option then creates a
file including all the text in the buffer.

J Cancel — Returns you to the main screen.

UM6.1:SW3151 Revision H — July 1996

 Generating Configuration Data 8-1

Figure 8-Table 8

8 Generating Configuration Data

This section describes how to generate configuration data for the
devices on the PROVOXr data highway using the Generation Options
form.

ENVOXr software performs two functions when you request it to

generate a device. First, it checks for errors in any remaining unverified
configuration data in the device. This check ensures that all necessary
information is in the configuration database and that all references from
other devices and their points are configured correctly. Second, and after
checking the data, the software organizes the device’s related data into
a database table. It then processes the data so that it can be
downloaded to the device. Figure 8-1 illustrates how the generation
option works.
8
CONFIGURATION DATABASE
A
CONFIGURATION DATA A
A Configuration
C A N E C A Download Data
GENERATE A for Device A
B A E C A A
D N C B N B
B Configuration
C E N A C B
GENERATE B Download Data
A C E A B B for Device B
B
B A E C D
D N C B N
C E N C A
N
C A N E N GENERATE N Configuration
N Download Data
D E D N
N for Device N
D N
X00319:SW3151-0

Figure 8-1 The Generation Option Organizes Download Data

You need to know what is missing from your configuration before you
request a download. ENVOX software provides errors and warnings
about your configuration data as it generates the configuration data.

Revision H — July 1996 UM6.1:SW3151

 8-2 Generating Configuration Data

8.1 When to Generate Configuration Data

If you modify or add new data to a device’s configuration, you must
successfully generate the device before the modified or new data is
downloaded to the device. If a download is performed before the
modified or new data is generated, then the download data from the last
successful generation is downloaded. The ENVOX software flags all
changes and additions and, at generation time, generates only those
flagged items. Once a device has been successfully generated, you can
download it at any time.

Depending on the device type and the configuration’s complexity, you

may find it advantageous to generate a device in stages. Generating a
device this way allows you to methodically debug errors as you make
modifications or additions.

8.2 Steps in Generating Configuration Data

There are three steps in generating configuration data:
8 J Accessing the Generation Options form

J Specifying the devices to be generated

J Generating the data

The following subsections describe how to do these steps.

UM6.1:SW3151 Revision H — July 1996

 Generating Configuration Data 8-3

8.3 Accessing the Generation Options Form

To access the Generation Options form:
Step 1: Select the More menu from the ENVOX Top Level Form.
Step 2: Select the Generate option from the More menu.

ENVOX TOP LEVEL FORM

X Add Modify! Utilities More Status! Help

Generate
Download ->
Document
Upload
Diagnostics
IAC Trace/Tune
LCP Trace/Tune
Administration 8
Dbase Management ->
Audit Trail

The software displays the Generation Options form (Figure 8-2).

GENERATION OPTIONS
X! Generate Show Errors Utilities Help

Date/time of
Device v last generation Warnings Errors Generation status

Figure 8-2 The Generation Options Form

Revision H — July 1996 UM6.1:SW3151

 8-4 Generating Configuration Data

8.4 Specifying Devices to be Generated

Before generating configuration download data, you must first specify
the devices you want to generate data for.

To specify the devices, you can:

J Manually enter the device tags

J Use the valid entries list

J Use a tag set

J Select all devices

8.4.1 Manually Entering the Device Tags

To enter the device tags, enter a device tag and press Return. The
cursor moves to the next Device field. Continue to enter tags for all the
devices for which you want to generate configuration data. Subsection
8 8.6 describes how to generate data for the devices you list.

8.4.2 Using the Values List

The software provides a list of valid entries for all devices for which you
can generate a configuration download file. The list also displays the
tags of tag set items. To display the valid entries list, press the Values
List key. After the list appears, move the cursor to the desired entry and
press Return. The entry is automatically written into the field, and the
valid entries list is exited.

When you call up a list of valid entries, the software appends a device
type name after each device name listed. For example, if you named a
unit operations controller BATCH10, the software displays it as
BATCH10-UOC in the valid entry list. This feature helps you recognize
PROVOX device types. Other device type names include IFC (interactive
function controller), PROVUE, and so on.

Subsection 8.6 describes how to generate data for the devices you list.

UM6.1:SW3151 Revision H — July 1996

 Generating Configuration Data 8-5

8.4.3 Using a Tag Set

To enter device tags using a tag set, do the following:

Step 1: Enter the tag set name.

Step 2: Press Return. The software displays a form containing the

device tags from the tag set (if any). When you exit this tag
set, the software prompts you to apply or cancel:

J Apply — Copies all the device tags in the tag set to the
Generation Options form. You can generate configuration
data for these devices, or edit the list first.

J Cancel — Displays the Generation Options form again

Subsection 8.6 describes how to generate data for the devices you list.

8.4.4 Selecting All Devices

To load all of the device tags of all devices into the database into the 8
Generation Options form, do the following:

Step 1: Select Utilities from the Generation Options form.

Step 2: Select the Select All Devices option from the pull-down menu.

GENERATION OPTIONS
X! Generate Show Errors Utilities Help

Select All Devices

Clear List
Show Batch Queue
Status Update

Note
The Select All Devices option does not load
device tags for DC5500-Series large database
consoles (LCONs) because ENVOX software
cannot generate configuration data for LCONs.

Revision H — July 1996 UM6.1:SW3151

 8-6 Generating Configuration Data

8.4.5 Clearing the Device List

To erase the devices listed in the Generation Options form do the
following:

Step 1: Select Utilities from the Generation Options form.

Step 2: Select the Clear List option.

GENERATION OPTIONS
X! Generate Show Errors Utilities Help

Select All Devices

Clear List
Show Batch Queue
Status Update

UM6.1:SW3151 Revision H — July 1996

 Generating Configuration Data 8-7

8.5 Generation Options Form Contents

Each time you enter a device name or load a tag set into the Generation
Options form, the software supplies information about the last generation
for that device. Figure 8-3 shows a completed Generation Options form.

GENERATION OPTIONS
X! Generate Show Errors Utilities Help

Date/time of
Device v last generation Warnings Errors Generation status

UOC-01 03-May-1990 10:46:01 0 4 Errors detected

CONSOLE-18 03-May-1990 10:46:01 1 0 Completed

Figure 8-3 Completed Generation Options Form 8

8.5.1 Updating the Form Information

To update the complete Generation Options form, select the Status
Update option from the Utilities pull-down menu. To update the details of
a single device to reflect its current status, tab over the device tag.

8.5.2 Understanding the Form Contents

The paragraphs that follow describe the generation information fields:
Date/time of last generation — The completion time and date of the
most recent generation for the device. If no user has ever requested a
generation for the device or if the device is locked, the field is blank. A
device is locked when another user has recently requested a generation
and the software does not have consistent information about the device.
If the device tag is highlighted, it requires generation.
Warnings — The number of warnings produced by this device during
the last generation
Errors — The number of errors produced by this device during the last
generation
Generation status — Can be one of the following:
J Never generated — No user has requested a generation for this
device.
J Errors detected — This device produced verification errors during its
last generation.

Revision H — July 1996 UM6.1:SW3151

 8-8 Generating Configuration Data

J Completed — The software successfully generated a download file

for this device.

J Device is locked — Another user is currently generating the device.

The information is not available.

J No generate priv — The user does not have the generate privilege.

J Bad security area — An invalid security tag set was defined when
configuring the user privileges.

J No priv on device — The user does not have the privilege to

generate this device.

UM6.1:SW3151 Revision H — July 1996

 Generating Configuration Data 8-9

8.6 Generating the Data

Once you have entered the names for the devices for which you want to
generate configuration data, select the type of generation you want.
There are two types:

J Batch

J Interactive

Caution
Once a batch or interactive device
generation starts, the software prevents
you from adding or modifying any data on
a form which affects the device that the
software is currently generating. Some
devices take several hours to generate.
Because a device generation cannot be
8
aborted, data in other devices can be
effectively locked against modification or
addition until the current generation is
complete.

Note
Download data for a device is not altered until the
device generate completes successfully. Even if
the generate is interrupted, the download data is
not altered.

If the Verify mode ON/OFF is currently set to OFF, you cannot run
Generate from the menu. Refer to The System Manager’s Guide to
ENVOX Configuration Data SM1.0:SW3151, for information on the Verify
Mode ON/OFF function.

Revision H — July 1996 UM6.1:SW3151

 8-10 Generating Configuration Data

8.6.1 Batch Generation

A batch configuration generation lets you put several generation
requests in the batch queue and continue using your computer for other
things while you wait for the software to complete the generations. When
you request a batch generation, you assign a job name to the generation
request. If you do not specify a name, the software names the job for
you. The software puts the job in the database’s batch queue. The
system keeps logs of the generation requests so that you can check the
status of each generation job (see subsection 8.6.1.1).

To start a batch configuration generation, do the following:

Step 1: Display the Generation Options form with all the devices for
which you want to generate configuration data.

Step 2: Select the Generate menu.

Step 3: Select the Batch option from the Generate pull-down menu.

8
GENERATION OPTIONS
X! Generate Show Errors Utilities Help

Batch
Interactive

Step 4: The software prompts you to enter a job name. Enter a name,
as many as 12 characters, to identify this batch job. The valid
characters are 0 through 9, A through Z, and hyphen (--). The
software converts alpha characters to upper-case, and any
not-valid characters to a hyphen. If you press Return rather
than entering a name, the software accepts your request and
gives the job a name made up of the first 12 characters of
your ENVOX forms system username.

You can view your batch job file names through the Batch
Generation Queue Status form. See Step 5 below. This form
identifies the time and date of the generation so you don’t
need to identify the current date and time within your batch
job file name. It may be useful to include your initials or user
name in the batch job file name in addition to some particular
characteristic of the generation request.

Step 5: To view the status of the generation requests, select the

Show Batch Queue option from the Utilities pull-down menu
on the Generation Options form.

UM6.1:SW3151 Revision H — July 1996

 Generating Configuration Data 8-11

GENERATION OPTIONS
X! Generate Utilities Help
Show Errors Utilities

Select All Devices

Clear List
Show Batch Queue
Status Update

The software displays the Batch Generation Queue Status

form (Figure 8-4).

BATCH GENERATION QUEUE STATUS

X! Job Details! Abort Job Utilities Help

No. Job name User name Date submitted Status

8
6 JONES JONES 03-May-1990 19:09:01 Pending
5 STEVENSON STEVENSON 03-May-1990 19:09:01 Pending
4 ALL_UOCS SMITH 03-May-1990 18:10:10 Pending
3 STEVENSON STEVENSON 02-May-1990 00:00:00 Executing
2 STEVENSON STEVENSON 01-May-1990 23:59:48 Aborted
1 CONSOLE_8_15 JONES 31-Apr-1990 08:09:01 Complete

Figure 8-4 Example of a Batch Generation Queue Status Form

To update the information on this form, select the Status Update option
from the Utilities pull-down menu.

Note
Do not attempt to delete a batch generate request
from the queue. If you need to abort a batch file
job, see subsection 8.6.1.3.

Revision H — July 1996 UM6.1:SW3151

 8-12 Generating Configuration Data

8.6.1.1 Reviewing the Status of Batch Generation Jobs

ENVOX software allows you to:

J Review a specific job

J Review all of the jobs in the queue

The Batch Generation Queue Status form and the Batch Generation Job
Status form provide information about all of the batch generation jobs
submitted during the last seven days. The ENVOX system may have
several databases, and each database may have its own batch queues.
Your login identification determines the database you work on and the
batch queue you can access. Your ENVOX system manager can help
you access other databases and batch queues.

To review a specific batch generation job, do the following:

Step 1: On the Batch Generation Queue Status form, move the

cursor to the job for which you want detailed information.

Step 2: Select the Job Details! option from the menu bar.
8

BATCH GENERATION QUEUE STATUS

X! Job Details!
Job Details! Abort Job Utilities Help

Step 3: The software displays the Batch Generation Job Status form
(Figure 8-5). This form is read-only, and includes a database
field which Identifies the database to which this batch job
belongs.

UM6.1:SW3151 Revision H — July 1996

 Generating Configuration Data 8-13

BATCH GENERATION JOB STATUS

X! Show Current Errors Help
Database is
Date/Time of
Device last generation Warnings Errors Generation status

Generation summary is ____ devices generated, ____with warnings

____ devices not generated or locked

Figure 8-5 Batch Generation Job Status Form

8
8.6.1.2 Viewing the Batch Jobs Status
The queue for batch generation requests also supports other batch jobs,
such as batch uploading and documentation requests. To view all batch
jobs, do the following:

Step 1: Select the Utilities option from the menu bar of the Batch
Generation Queue Status form.

BATCH GENERATION QUEUE STATUS

X! Job Details! Utilities Help
Abort Job Utilities

Whole Queue
Status Update

Step 2: Select the Whole Queue option from the pull-down menu. The
software displays the Batch Jobs Status form (Figure 8-6).

Revision H — July 1996 UM6.1:SW3151

 8-14 Generating Configuration Data

BATCH JOBS STATUS

X! Abort
Abort Job
Job Help

Database ENVOXDB
Job
No. Job name User Task Status Mode

3 IMPORT PROFLEX IMPORT Pending Batch

2 JONES JONES GENERATE Pending Batch
1 SMITH SMITH UPLOAD Pending Batch
6 UPLOAD TARQUIN UPLOAD Executing Batch

Figure 8-6 Batch Jobs Status Form

The Batch Jobs Status form is read-only. If more jobs exist than can be
displayed on the screen, the groups can be scrolled. In the menu bar,
8 you may select Help or X! (exit) , but the Abort Job menu is not
selectable in this form. The information on the form automatically
updates every three seconds.

UM6.1:SW3151 Revision H — July 1996

 Generating Configuration Data 8-15

8.6.1.3 Aborting a Batch File Generation

You can abort a batch job when it is pending or being executed. When
you request an abort, the software completes the generation for the
device on which it is currently working.

Caution
Do not attempt to delete a batch
generation from the batch queue from the
command line. It continues to appear as
Executing on the Batch Jobs Status form.

To abort a batch-generation request, do the following:

Step 1: Select the Utilities menu option from the Generation Options
form.
Step 2: Select the Show Batch Queue option from the Utilities menu.
8

GENERATION OPTIONS
X! Generate Show Errors Utilities Help
Utilities

Select All Devices

Clear List
Show Batch Queue
Status Update

Figure 8-7 Batch Generation Queue Status Form

The software displays the Batch Generation Queue Status form

(Figure 8-7).
Step 3: Move the cursor to the batch job you want to abort.
Step 4: Select the Abort Job option from the upper window.

BATCH GENERATION QUEUE STATUS

X! Abort Job
Job Details! Abort Job Utilities Help

No
Yes

Revision H — July 1996 UM6.1:SW3151

 8-16 Generating Configuration Data

8.6.2 Interactive Generation

For short jobs, you may want to generate configuration data interactively.
Interactive generation begins more quickly than batch generation.
However, interactive generation ties up your terminal and is probably
inappropriate for long lists of devices.

You perform interactive generation through the Interactive Generate

form, which you access through the Generation Options form.

Note
If you are accessing the computer that hosts
ENVOX software through a SET HOST
command, you must use a batch generation.

8
To start an interactive generation, do the following:

Step 1: Display the Generation Options form with all the devices you
want to generate.

Step 2: Select the Generate option.

Step 3: Select the Interactive option on the Generate pull-down

menu. The software starts the generation. You can abort an
interactive generation by pressing the Exit key. Note that
aborting the generation does not abort the generation for the
current device, but does abort the generation for all
subsequent devices on the form.

GENERATION OPTIONS
X! Generate Show Errors Utilities Help

Batch
Interactive

Step 4: The software displays the Interactive Generate form, shown in

Figure 8-8, with the list of highlighted devices from the
Generation Options form.

UM6.1:SW3151 Revision H — July 1996

 Generating Configuration Data 8-17

INTERACTIVE GENERATE
X! Show Errors
Show Errors Help

Date/time of
Device last generation Warnings Errors Generation status

Generation summary is ____ devices generated, ____with warnings

____ devices not generated or locked

8
Figure 8-8 Interactive Generate Form

When the ENVOX software interactively generates a list of devices, it

updates the Generation Status field as it processes each device, starting
with the first device on the form. The Generation Status field displays
these messages in the order given:

1. Pending (indicates the ENVOX software is processing the device)

2. Verifying (indicates the ENVOX software is verifying the configuration

data for the device)

3. Errors (indicates the device configuration data contains errors)

Or

Generated and Completed (indicates the data was successfully

generated)

Or

Generating followed by Completed (indicates the data was

successfully completed)

After generating a device, the ENVOX software completes the three

remaining fields—Date/Time of Last Generation, Warnings, Errors—for
that device and then begins generating the next device on the list. After
processing all devices listed on the form, the software completes the
generation summary fields at the bottom of the form.

Revision H — July 1996 UM6.1:SW3151

 8-18 Generating Configuration Data

8.7 Reviewing Generation Errors and

Warnings
To modify your configuration database so that each device supports a
successful generation, you need to know the problems that prevent the
device from generating successfully. The steps for reviewing errors and
warnings for batch generations are different from those for interactive
generations.

8.7.1 Reviewing Errors and Warnings—Batch Generation

You can review errors, warnings or both for batch jobs using the Batch
Generation Job Status form:

Step 1: With the Batch Generation Job Status form displayed, select
Show Current Errors.

Step 2: Select either the All Devices in List or Current Device option.
Subsection 8.7.2 describes these options.
8

BATCH GENERATION JOB STATUS

X! Show Current Errors Help

All Devices in List ->

Current Device ->

Step 3: If you want to copy all the items that failed generation to a tag
set, select Save to Tag Set! from the Generate Errors form.
This tag set makes it easier to edit the items that require
changes.

GENERATE ERRORS
X! Print! Save To
Save To Tag
Tag Set!
Set! Help

UM6.1:SW3151 Revision H — July 1996

 Generating Configuration Data 8-19

8.7.2 Reviewing Errors and Warnings—Interactive Generation

You can review detailed verification and generation information about the
devices that were most recently interactively generated through the
Show Errors option on the Generation Options form. Show Errors is
available only after the ENVOX software finishes processing the last
device on the generation list.
You also can use the Show Errors option on either the Interactive
Generate form or the Generation Options form to view or print
configuration messages. To review errors and warnings, do the following:
Step 1: With the Generation Options form displayed, select the Show
Errors option.

GENERATION OPTIONS
X Generate Show Errors
Show Errors Utilities Help

All Devices in List ->

8
Current Device ->

Step 2: Each of these options provides a slide-off menu of additional

choices. Select of the options.
J Current Device options — Display the Generate Errors
form, like the one in Figure 8-9, for the device the cursor
was resting on in the Generation Options form. This report
can include the errors only, warnings only, or both errors
and warnings, depending on which option you select.
J All Devices options — Display the Generate Errors form, like
the one in Figure 8-9, for all the devices in the Generation
Options form. This report can include the errors only, warnings
only, or both errors and warnings, depending on which option
you select. Press Page Down to see the entire list. The form
lists the items that caused the errors or warnings and explains
why they occurred.
The time on the form is the start time of the generation. Scroll
through the Generate Errors form using Next Screen or Prev
Screen. If the Generation complete message is not at the
bottom of the final page, the generation is still in progress.
The Find Row key feature may be helpful for searching for
specific data. The field in the Generate Errors form is a long
string, you may want to search for a substring. For example,
use the wildcard character (%) on either side of the string:
%FIC-1001%.

Revision H — July 1996 UM6.1:SW3151

 8-20 Generating Configuration Data

GENERATE ERRORS
X! Print! Save To Tag Set! Help
Report Type - Current Device, Exclude Warnings
UOC-01 03-Nov-1988 10:46:01

DCD-302 V0106: Point is incomplete in the database

Form: DCD POINT, Field: Failsafe SP Enbl
Form: DCD POINT, Field: Failsafe SP

LT-21 V0214: Instrument signal AREA1-TMP4 has no card

data defined for this device

Generation complete with 0 warnings, 4 errors

Device not generated

8
Figure 8-9 Generate Errors Form

Step 3: If you want to copy all the items that failed generation to a tag
set, select Save to Tag Set! from the Generate Errors form.

To review errors and warnings for specific devices, do the following:

Step 1: On the Generation Options form, enter the names of the

devices for which you want error and warning information.

Step 2: Select the Show Errors option.

Step 3: Select All Devices in List or Current Device.

Step 4: If you want to copy all the items that failed generation to a tag
set, select Save to Tag Set! from the Generate Errors form.

GENERATE ERRORS
X! Print! Save To
Save To Tag
Tag Set!
Set! Help

UM6.1:SW3151 Revision H — July 1996

 Generating Configuration Data 8-21

8.7.3 Viewing Item-Form Errors

You can view the configuration generation errors caused by an item
while you are in the item form.

To view the generation errors while in the item form, do the following:

Step 1: Select the Utilities option from the form-level menu.

Step 2: Select the Show Errors option.

PCI POINT
X! Edit Utilities Extra Data Target! Help

Save
Print
Show Errors
Show Errors
Ad Hoc Tag Set 8

8.7.4 Printing Generation Errors and Warnings

The Generate Errors form provides an option that prints the form and its
contents. To obtain a hard copy of the current form and contents, select
the Print option:

GENERATE ERRORS
X Print! Save To Tag Set! Help
Print!

8.7.5 Correcting Incomplete-Data Errors

If you omit a required piece of configuration data from one of the
configuration forms, the generate error message provides the form and
field name relating to the incomplete data. To complete the configuration,
use the Modify option to access the forms and fields listed in the
generation error.

Revision H — July 1996 UM6.1:SW3151

 8-22 Generating Configuration Data

This page intentionally left blank.

UM6.1:SW3151 Revision H — July 1996

 Downloading Configuration Data 9-1

Figure 9-Table 9

9 Downloading Configuration
Data
Downloading sends configuration download data to devices on the
highway. By downloading configured data to a device, you program the
various functions in that device to operate in a specific manner.

ENVOXr SOFTWARE

A B N
A B N
A B N
A B N
A B N
A B N

Device Device Device

A B N

X00320:SW3151-0

Figure 9-1 Downloading Configuration Download Data to Devices

This section describes how to download configuration download data to

the devices, report on the success of the backup, create backups of the
configuration download data for future use, and perform an emergency
download when access to the ENVOXr database is not possible.

9.1 Tasks Required to Download Data

To download data to a device, perform the following steps:
1. Access the Download Options form.
2. Create a list of devices for a download.
3. Start the download.
This subsection describes how to perform each of these tasks.

Revision H — July 1996 UM6.1:SW3151

 9-2 Downloading Configuration Data

9.1.1 Accessing the Download Options Form

To access the Download Options form:

Step 1: Select the More menu from the ENVOX Top Level Form.

Step 2: Select the Download option from the pull-down menu, and
then select the Download slide-off option.

ENVOX TOP LEVEL FORM

X Add Modify! Utilities More Status! Help

Generate
Download
Download
Download ->->
->
Document
Upload
Diagnostics
IAC Trace/Tune Download!
Download
LCP Trace/Tune Download Backup
INSTRUMENT SIGNAL
9 Administration Backup All Devices
Dbase Management -> Backup to ED Files->
Audit Trail
EV096

DOWNLOAD OPTIONS
X! Download! Show Report Utilities Help

Download type Date/Time of last

Device v required v Successful Download Download Status

EV097

Figure 9-2 Download Options Form

UM6.1:SW3151 Revision H — July 1996

 Downloading Configuration Data 9-3

9.1.2 Creating a List of Devices

Use the Download Options form to create a list of devices to which you
want to download configuration data. There are three ways you can enter
device names in this form:
J One at a time
J By selecting all devices
J By entering tag set names

9.1.2.1 Entering Device Names One At a Time

You can enter one device at a time manually in the Device v fields. To do
this, type the names of the devices if you know them, or select a device
name from the list of valid device names (displayed when you press the
Values List key).

9.1.2.2 Selecting All Devices

To enter all device names that exist in the database:
Step 1: Select the Utilities menu from the Download Options form.
9
Step 2: Select the Select All Devices option.

DOWNLOAD OPTIONS
X! Download! Show Report Utilities Help

Select all
All devices
Devices
Clear list
EV111

9.1.2.3 Entering One or More Tag Set Names

You can also create a list of devices indirectly with tag set names. To do
this:
Step 1: Enter the name of the tag set in the Device v field. The
software displays the device names associated with the tag
set.
Step 2: To enter the device names in the download list, select Exit and
Apply. The software overwrites the tag set names with the
valid device names. You can edit the download list to remove
any name. If you do not want the device names from this tag
set in the download list, select Exit and Quit.

Revision H — July 1996 UM6.1:SW3151

 9-4 Downloading Configuration Data

9.1.2.4 Clearing the Download Options List

If you do not like the list you created, you can clear all the entries and
start again. To do this:

Step 1: Select the Utilities menu from the Download Options form.

Step 2: Select the Clear List option.

DOWNLOAD OPTIONS
X! Download! Show Report Utilities Help

Select all devices

Clear list
EV112

9.1.2.5 Download Options Form Information Fields

Once you enter a device name or once the software creates a list of all
9 devices, information associated with the device is displayed in the three
remaining fields on the form. These fields are Download type required,
Date/Time of last Successful Download, and Download Status.

J Download type required — Displays the minimum download type

required for the associated device based on previous downloads.
Download types are:

total — Sends all the related configuration data to the device. This
type is for devices other than the SR90 controllers. You can
change a total to none.

partial — Sends only the device configuration data that has

changed since the last download for the device. This type is for
devices other than the SR90 controllers. You can change a partial
to total.

none — Does not send any data. No download is required

because no changes have been made. You can change none to
total.

I-total (total initializing download) — Sends all related

configuration data to the device. This download type is used for
SR90 controllers. When the controller receives an I-total
download, the controller (and its backup, if present), sets its state
to initialized and clears its configuration memory. The download
drives the initial setpoints in the controller and sets the points to
their initial configured states.

UM6.1:SW3151 Revision H — July 1996

 Downloading Configuration Data 9-5

M-total (total matching download) — Is similar to an I-total

download except that the download does not drive the outputs.
After a total matching download, all loop points are set to
MANUAL and all LCPs are set to the IDLE state to prevent
unpredictable control action. You must set loops and LCPs to their
proper states based on process conditions.

M-partial — This type is used for SR90 controllers. An M-partial

type downloads only the items which have changed. The
controller merges the changed items. Points not affected by
changes continue executing during the download. Points that are
affected resume operation when the download is complete. Refer
to the controller configuration engineering manual for more
information.

For further information about I-total, M-total, and M-partial downloads, see
the configuration engineering manual for your SR90-family controllers.

Note
Before performing an M-partial download to a
running plant, check the actual changes that will
be transmitted by looking through the download
9
information file (refer to subsection 14.2.5).

If another user generates a device from another terminal, the

download type will not change on the Download Options form at your
terminal. If another user may have downloaded an associated device,
exit the Download Options form and access it again.

J Date/Time of Last Successful Download — Indicates when the last

successful download for this device occurred, if ever.

J Download Status — Describes the status of the most recent

download for this device. Table 9-1 lists the possible download status
words.

Revision H — July 1996 UM6.1:SW3151

 9-6 Downloading Configuration Data

Table 9-1 Download Status Words

Status Words Meaning
BACKUP A download backup image was used for the most recent
DOWNLOADED download to this device. The software requires a total
download for the next download to this device.
DEVICE WAS LOCKED The software could not access the device information for
the most recent download attempt.
DOWNLOAD FAILED The last download was unsuccessful.
DOWNLOADED The most recent download was successful.
IN PROGRESS The software is currently downloading configuration
download data to this device.
NEVER DOWNLOADED No download data has ever been sent to this device.
NO PRIVILEGE You do not have a privilege level sufficient to download
data to this device.
NOT A DEVICE There is no device in the database matching the name in
the list.
NOT DOWNLOADED The device was not downloaded from this list. The
message occurs in a situation where user X requests a
partial download for the device. At the time the user
included this device in the download list, the request was
valid. But, by the time the software attempts to perform a
partial download, the software has already performed a
partial download from user Z’s request. The message
9 also occurs if you aborted the download.
NOT DOWNLOADABLE The system administrator set the device to
non-downloadable.
NOT GENERATED No generated download data exists for this device.
PENDING The software downloads the device as soon as possible.

UM6.1:SW3151 Revision H — July 1996

 Downloading Configuration Data 9-7

9.1.3 Starting the Download

After you have completed the list of devices, start the download. To do
this:
Step 1: Select the Download option from the Download Options form.

DOWNLOAD OPTIONS
X! Download! Show Report Utilities Help

EV113

The software displays a Confirm Action form.

Step 2: Select CONFIRM to start the download. The Download
Interactive form appears as shown in Figure 9-3.
This is a dynamic form that shows the changing status of your
download requests. Note that aborting does not abort the
download for the current device, but does abort the download
for all subsequent devices on the form.

9
DOWNLOAD INTERACTIVE
X! Show Report Help

Download type Date/Time of last

Device v required v Successful Download Download Status

Download summary is ____ devices failed to download or

locked ____ devices downloaded successfully

Press F10 <EXIT> key to abort download

EV089

Figure 9-3 Download Interactive Form

Revision H — July 1996 UM6.1:SW3151

 9-8 Downloading Configuration Data

9.2 Viewing Download-Related Information

Once the software attempts to send all the download data, you can create
a download report, which shows information about the success of the
download.

This report shows the ENVOX database from which you made the
download request, the number of devices not downloaded or locked, and
the total number of devices that downloaded successfully. The report also
includes for each device:

J The device name

J The date and time the download attempt occurred

J An error message for failed downloads

J The packet number that caused the failure

J Warning messages, if any

To obtain a report for your most recent download:

Step 1: Select the Show Report option from the Download Options
9 form or from the Download Interactive form.

DOWNLOAD OPTIONS
X! Download! Show Report Utilities Help

All
AllDevices
DevicesIn List
In List
Current Device

EV114

A pull-down menu is displayed showing two options.

UM6.1:SW3151 Revision H — July 1996

 Downloading Configuration Data 9-9

Step 2: Select an option from the menu.

All Devices In List — Displays a report for all the devices on

the form.

Current Device — Displays a report for the device the cursor

is currently on.

The Download Report is displayed. Figure 9-4 is an example

of this report.

Step 3: The field in the Download Report form is a long string. You
may want to use the Find Row key to search for a substring.
For example, use the wildcard character (%) on either side of
the string: %PROVUE%.

Step 4: To return from a download report to the Download Options or

Download Interactive form, exit the report.

DOWNLOAD REPORT
X! Print! Help
9
UOC-1 03-Nov-1988 12:45:23
Download complete
PROVUE-21 03-Nov-1988 12:50:16
Response timeout
Download failed : packet number 1200

EV098

Figure 9-4 Example Download Report

Revision H — July 1996 UM6.1:SW3151

 9-10 Downloading Configuration Data

9.3 Backing Up Downloaded Data

Once you verify that a download for an entire system works, you may
want to make a backup copy of the associated configuration download
data. Having a backup ensures that you have a dependable copy of your
current configuration. Note that you cannot back up a single device only,
you must backup all devices at one time.

After you create a backup image of the configuration download data, you
can download data from the image when necessary. This subsection
describes how to do both of these tasks.

9.3.1 Creating a Backup Image

When you request a backup image, the software creates a copy of all
existing generated download data for all devices. You can then download
from these images. To create the backup image:

Step 1: Select the Backup All Devices option from the Download
slide-off menu. The software displays a pop-up form.

9
ENVOX TOP LEVEL FORM
X Add Modify! Utilities More
More Status! Help

Generate
Download
Download ->
Document
Upload
Diagnostics
IAC Trace/Tune Download
LCP Trace/Tune Download Backup
Administration Backup All Devices
Dbase Management -> Backup to ED Files ->
Audit Trail
EV115

Step 2: Read the message on the form and confirm or cancel the
request.

UM6.1:SW3151 Revision H — July 1996

 Downloading Configuration Data 9-11

CONFIRM ACTION
CONFIRM! CANCEL! Help

Backing up of the download data for all devices can take a considerable
amount of time. During this time no devices can be generated, however,
devices can be downloaded (both from backed up or normal download data)

Select CONFIRM to backup the download data for all devices

Select CANCEL to abort the request

EV099

Upon confirming, the software takes you to the ENVOX Top

Level form and displays a message indicating the backup is
taking place.

9.3.2 Downloading from a Backup Image

The subsection describes how to download from a backup image you 9
created previously through the Backup All Devices menu option. To
download one device at a time from the backup image, do the following:
Step 1: Select the Download option from the top-level More menu.
Step 2: Select Download Backup option. The software displays the
Download Backup version of the Download options form.
Figure 9-5 shows the form.

ENVOX TOP LEVEL FORM

X Add Modify! Utilities More
More Status! Help

Generate
Download
Download ->
Document
Upload
Diagnostics
IAC Trace/Tune Download
LCP Trace/Tune Download Backup
Administration Backup All Devices
Dbase Management -> Backup to ED Files ->
Audit Trail

Revision H — July 1996 UM6.1:SW3151

 9-12 Downloading Configuration Data

DOWNLOAD OPTIONS
X! Download! Show Report Utilities Help
DOWNLOAD BACKUP
Download type Date/Time of last
Device v required v Successful Download Download Status

Figure 9-5 Download Options Form (Download Backup Version)

Step 3: Enter the devices you want to download from the backup
9 image in the Device field on the Download Backup form.

Step 4: Select the Download option.

Step 5: The software displays a Confirm action form.

Note
After a download from backup, the next download
of that device from the current database must be a
total download.

UM6.1:SW3151 Revision H — July 1996

 Downloading Configuration Data 9-13

9.4 Emergency Downloading

The emergency download feature enables you to:

J Create emergency download files containing download data for a

single device or all devices

J Download a device from the emergency download file if the SYBASE

server is not available or if your ENVOX database is suspect.

CHIP must be running to be able to perform either task. In addition, only

total downloads are possible. For SR90 and SRx devices, both initializing
and matching total downloads are possible. The audit trail does not
record emergency downloads.

9.4.1 Creating an ED File

You can create an emergency download (ED) file by either of two ways:

J Using an ENVOX form

J Using a command at the system prompt.

Emergency download files are placed in the ENVOX$DISK:[ENVOX.ED] 9

directory for VMS machines and $ENVOX/ed for UNIX machines. To
name the download files, use the following convention:

device_tag_yyyymmddhhmm.DWN

The device_tag uses the same naming convention as CDV file names
when display tags contain characters that cannot be used in regular file
names. For example:

J VMS Filename

ENVOX$DISK:[ENVOX.ED]PROVUE_199202041524.DWN

J UNIX Filename

$ENVOX_DISK/envox/ed/provue_199202061524.dwn

or,

$ENVOX/ed/provue_199202061524.dwn

Emergency download files have a unique file format for ENVOX software,
beginning with version P3.0. For example, the file format for a device,
PROVUE-1, is:

J VMS Filename

PROVUE-1_____LLLLLLDH_199302041524.DWN

Revision H — July 1996 UM6.1:SW3151

 9-14 Downloading Configuration Data

J UNIX Filename

provue-1_____lllllldh_199302041524.dwn

ENVOX software, version P2.0 files are supported for emergency

download, but they are not in the unique format. In addition, if
Download-from-ED specifies a device for which both P2.0 and P3.0 files
exist, the P3.0 format file takes precedence.

Note that when downloading data from an emergency download file, the
system does not make sure that the device can accept a download or that
a user has download privilege. The system administrator must, therefore,
set any necessary protection on files so that only certain users can
download from them.

In addition, the system administrator should perform certain ED file

maintenance activities. This maintenance includes purging and deleting
old ED files and log files and, for data protection, copying ED files onto
tape, another disk, or another machine on the network.

9.4.1.1 Creating an ED File Using ENVOX Software

You can create an ED file through the ENVOX forms interface for all
9 devices or for one device. To create an emergency download file from
ENVOX software:

Step 1: Select the Download option from the top-level More menu.

Step 2: Select the Backup to ED Files option. The software displays a

slide-off menu that lists two options: All Devices and Single
Device.

ENVOX TOP LEVEL FORM

X Add Modify! Utilities More Status! Help

Generate
Download ->
Document
Upload
Download
Diagnostics
Download Backup
IAC Trace/Tune
Backup All Devices
LCP Trace/Tune
Backup to ED Files->
Administration
Dbase Management ->
All Devices
Audit Trail
Single Device

UM6.1:SW3151 Revision H — July 1996

 Downloading Configuration Data 9-15

J All Devices — Create a backup of the download data for

all devices
J Single Device — Create a backup of the download data
for the specified device
Step 3: Select a backup option.
If you selected All Devices, a Confirm form is displayed. If you
selected Single Device, a Device Tag prompt is displayed.
Step 4: At the Confirm form, select CONFIRM. The system backs up
the .exe download data for all devices and places the backups
in ED files (one file for each device, all having the same date
and time stamp).
or
At the Device Tag prompt, enter the name of the device for
which you want to back up download data. For a list of valid
devices, press the Values List key. The system creates the
backup of the specified device and places it in an ED file.

9.4.1.2 Creating an ED File from the Command Line

You can also create an ED file at the system prompt level, one device at a 9
time. To create an emergency download file from the command line, type
the commands below at the system prompt. Note that for VMS machines,
mcr envox$application:dlexec.exe resides in the ENVOX.EXECUTABLES
subdirectory. For UNIX machines, dlexec.exe resides in the
$ENVOX/executables subdirectory.
J VMS Command
$ mcr envox$application:dlexec.exe “device_tag” “TO-ED” “envox” “db_name”
J UNIX Command
$ dlexec.exe “device_tag” “TO-ED” “envox” “db_name”
where device_name is the name of the device for which you want to back
up download data and db_name is the name of the ENVOX database.
For example:
J VMS Command
$ mcr envox$application:dlexec.exe “PROVUE123” “TO-ED” “envox” “ENVOXDB”

J UNIX Command
$ dlexec.exe “PROVUE123” “TO-ED” “envox” “ENVOXDB”
The system backs up the download data for the specified device and
places it in an ED file.

Revision H — July 1996 UM6.1:SW3151

 9-16 Downloading Configuration Data

9.4.2 Downloading From an ED File

Downloading data from an emergency download file is possible only from
the DCL command level. To download an ED file, type the commands
below at the system prompt. Note that on VMS machines, mcr
envox$application:dlexec.exe resides in the ENVOX.EXECUTABLES
subdirectory, and on UNIX machines, dlexec.exe resides in the
$ENVOX/executables subdirectory.

J VMS Command

$ mcr envox$application:dlexec.exe “device_tag”-

_$ “FROM-ED”[“SR90_download_type”] [“date_time_stamp”]

J UNIX Command

$ dlexec.exe “device_tag” “FROM-ED”[“SR90_download_type”] [“date_time_stamp”]

where:

device_tag is the name of the device for which you want to back up
download data.

SR90_download_type is either M-total (default) or I-total; this is an

9 optional parameter used for SR90 devices only.

date_time_stamp is the date and time the ED file was created. This
parameter is optional. If you do not specify a value, the default value is
the date and time of the most recent ED file for the device. For example,

J VMS Command

$ mcr envox$application:dlexec.exe “PROVUE123” “FROM-ED” “”-

_$ “1992_02_04_15_24”

$ mcr envox$application:dlexec.exe “SR-90XYZ” “FROM-ED” “I-total”

$ mcr envox$application:dlexec.exe “CHIP-1” “FROM-ED”

J UNIX Command

$ dlexec.exe “PROVUE123” “FROM-ED” “” “1992_02_04_15_24”

$ dlexec.exe “SR-90XYZ” “FROM-ED” “I-total”

$ dlexec.exe “CHIP-1” “FROM-ED”

The default download type is total for non-SR90 devices and M-total for
SR90 devices.

The date/time stamp format is the same as the format used in the ED file
name (that is, yyy_mm_dd_hh_mm). To find out the date/time stamp for a
device, use one of the commands below depending on your machine:

UM6.1:SW3151 Revision H — July 1996

 Downloading Configuration Data 9-17

J VMS Command
$ DIRECTORY ENVOX$ED:device_tag*.DWN
J UNIX Command
$ ls $ENVOX_ED/device_tag*.dwn
If the system does not find the specified file in the ENVOX$ED directory
(VMS machine) or the $ENVOX_ED directory (UNIX machine), an error
message is displayed. A message is also displayed if the download is
rejected or successful.
In addition, a log file is created in the ENVOX$ED directory
(VMS machine) or the $ENVOX_ED directory (UNIX machine). The file
has the same name as the ED file from which the download was
performed, but with a .LOG file extension for the VMS machine and a .log
file extension for the UNIX machine. The log files have the following
format:
J VMS Filename
ENVOX$ED:PROVUE123____LLLLLLDDD_199202041524.LOG
J UNIX Filename
$ENVOX_ED/provue123____llllllddd_199202041524.log 9
This file is in the same format as the download report.

9.4.3 Emergency Downloading Without ENVOX or SYBASE

Software
You can perform an emergency download on a machine that does not
have either ENVOX software or SYBASE installed. Using this method:
J Allows for an emergency download even if the main ENVOX
workstation goes down completely.
J Requires only a fraction of the disk space that would be required to
install SYBASE and ENVOX software — about 100 blocks plus the
space required for the emergency download files.
Note that CHIP software must be installed on the machine as well as the
most current version of the operating system.
To set up for and execute an emergency download for a VMS machine
only, do the following:
Step 1: Create a directory for the required ENVOX files and the ED
files as follows:
J VMS Command
$ CREATE/DIR device:[directory]

Revision H — July 1996 UM6.1:SW3151

 9-18 Downloading Configuration Data

J UNIX Command

$ mkdir /directory_name

Step 2: Copy the required ENVOX files from the machine where
ENVOX software is installed to the emergency download
machine.

J For VMS machines, use the following commands:

$ SET DEF device:[directory]

$ COPY node ”ENVOX password”::ENVOX$APPLICATION:DLEXEC_ED.EXE DLEXEC.EXE

J For UNIX machines, use ftp or a similar method to copy

dlexec_ed.exe to dlexec.exe on the backup machine.

Step 3: Copy the required ED files to the backup machine.

J For VMS machines, use the following command as an

example:

$ COPY node“ENVOX password”::ENVOX$ED:*.DWN/SIN=1-JUL-1992 *

J For UNIX machines, use ftp or a similar method.

9
Step 4: Define the required ENVOX logicals or environment variables
as follows:

J VMS Command

$ DEFINE ENVOX$ED device:[directory]

$ dlexec == ”$device:[directory]dlexec.exe”

J UNIX Command

$ ENVOX_ED=/directory_name
$ export ENVOX_ED

$ PATH=$PATH:/directory_name
$ export PATH

Step 5: To perform an emergency download enter the following:

J VMS Command

$ dlexec “device_tag” “FROM-ED”

J UNIX Command

$ dlexec.exe ”device_tag” ”FROM-ED”

UM6.1:SW3151 Revision H — July 1996

 Uploading Configuration Data 10-1

Figure 10-Table 10

10 Uploading Configuration Data

This section describes how to use the upload form to upload the values of
detail display parameters (DDPs) from a configured PROVOXr device to
an ENVOXr database, and how to determine the status of upload
requests.
After a successful download, console operators and configuration
engineers tune the process by changing configuration data in the devices
until the process runs smoothly. The configuration data that the operators
and engineers change are the values of detail display parameters
(DDPs).
As a result of tuning, your process control system eventually has two
configurations:
J The source database configuration — The configuration data you
created and downloaded using the ENVOX software. This
configuration is stored on disk.
J The on-line configuration — The dynamic, tuned configuration data
running in the PROVOX devices
The ENVOX upload utility enables you to replace data in the
configuration database with data retrieved directly from on-line 10
devices. Later, in the event of a process shutdown, you can rely on
the database to provide current configuration data to the devices.
Figure 10-1 illustrates how uploading on-line device data updates the
configuration database.

Operator ENVOXr Host

Console On-Line Computer
On-Line
Tuning Tuning Source Database
Changes Changes
(Configuration)

PROVOXr
Device

GENERATION
Download
On-Line Database
Configuration

DOWNLOAD

X00321:SW3151-0

Figure 10-1 Making Tuning Changes Part of the Database

Revision H — July 1996 UM6.1:SW3151

 10-2 Uploading Configuration Data

Only points from interactive controllers (IACs), computing controllers,

configurable controllers, multiplexers, unit operations controllers (UOCs),
and SR90 and SRx controllers are uploadable. Table 10-1 lists the
uploadable point types for these devices and Table 10-2 lists the
uploadable DDPs for each point type. These tables are located in
subsection 10.8.

There are some items you cannot upload:

J Displays

J Device definitions

J Global items (such as templates)

J Items sourced in the Computer/Highway Interface Package (CHIP)

and PROVUEr consoles

J Points from devices from which the user has no privilege to upload

In addition, the ENVOX software does not upload certain DDPs:

J DDPs the ENVOX software has not configured (for example, UTIMR)

J DDPs that are not tunable, only configurable

J DDPs used for some temporary purpose during plant operation that
10 should not be permanently included in the database. (REM OFS
exemplifies this type of DDP. Normally a point is tuned off scan to get
around some temporary problem, such as a faulty transmitter, and it is
not desirable to upload this data.)

J DDPs that are dynamic values, subject to frequent change by an FST,

operation, or CHIP during normal operation. (In these cases,
uploading a value that may only be meaningful for a brief period of
time is inappropriate.)

Also, you can upload IAC and computing controller AUX EUs if an FST
references them. As a result, they appear in the DDP list of a point. AUX
EUs are really part of the device definition, so you must upload a point
that references them to get the new values.

DDP values for pre-SR90, SR90 and SRx family controllers have certain
limitations on uploading. If a DDP value in the controller differs from the
database value by more than 0.001 percent, the software uploads that
DDP value only if it has been tuned. This limitation prevents upload of
spurious values. If the controller DDP value differs by less than 0.001
percent, the ENVOX software does not upload the DDP value. Changing
a DDP value in the controller has no effect on whether that value gets
uploaded if the point is uploaded.

UM6.1:SW3151 Revision H — July 1996

 Uploading Configuration Data 10-3

10.1 Upload Procedure

To upload an item you must first access the Upload form by doing the
following:

Step 1: Select the More option from the ENVOX Top Level Form.

Step 2: Select the Upload option from the pull-down menu.

ENVOX TOP LEVEL FORM

X Add Modify! Utilities More Status! Help

Generate
Download ->
Document
Upload
Diagnostics
IAC Trace/Tune
LCP Trace/Tune
Administration
Dbase Management ->
Audit Trail

EV157 10
The software displays the Upload form like the one shown in Figure 10-2.

UPLOAD
X! Upload View Log! Status! Help

Enter tag of item v :

WARNING: Uploading an item will update

the database, but not the download data.
After uploading, you must generate all
devices affected by the uploaded changes

EV118

Figure 10-2 Upload Form

Revision H — July 1996 UM6.1:SW3151

 10-4 Uploading Configuration Data

To upload an item:

Step 3: Enter item or tag set name into the form. You can type them in
or press the Values List key to access a list of valid entires.
Subsection 4.3.4 describes the valid-entries feature. The
Upload menu option becomes selectable once you have
entered an item.

Step 4: Select the Upload option from the Upload form. The Batch and
Interactive options appear on a pull-down menu. Subsections
10.1.1 and 10.1.2 describe these options.

UPLOAD
X! Upload
Upload View Log! Status! Help

Batch
Interactive
EV158

10 Note
Upload ignores NULL DDP fields that were not
previously configured in the database. Therefore,
if you tune controller DDPs that are NULL in the
configuration database, the ENVOX software does
not upload them.

UM6.1:SW3151 Revision H — July 1996

 Uploading Configuration Data 10-5

10.1.1 Batch Uploading

For a batch upload request, the software compares the device data for
the selected item with the configuration database data. If the device data
differs by more than the tolerance, the utility writes the data to the
configuration database. A batch upload has this advantage: it enables
you to upload without tying up your terminal, so you can do other work at
the same time. However, a batch upload does not enable you to compare
the device data to the configuration database data before proceeding with
the upload.

To upload an item in batch mode:

Step 1: Select the Batch option from the Upload menu. The software
prompts you to enter a job name.

Step 2: Enter as many as 12 characters to identify this batch job, and

press Return.

All tag characters are valid. If you press Return rather than
entering a name, the software accepts your request and gives
the job the same name as the name of the item.

Note
10
The batch job names you select can later be
accessed through the Status option on Upload
form. The Batch Upload Status! form provides the
time and date of the upload request and the user
that requested the upload. You don’t need to
identify these things in your batch job file name.
You may want to name the job to identify particular
characteristics of the upload request.

Revision H — July 1996 UM6.1:SW3151

 10-6 Uploading Configuration Data

10.1.1.1 Viewing the Status of Batch Upload Requests

Batch upload requests wait in a queue until processed by the software. To
look at the batch upload requests in the queue, select the Status! option
from the Upload form.

UPLOAD
X! Upload View Log! Status! Help
EV159

The software displays the Batch Upload Status form (Figure 10-3).

BATCH UPLOAD STATUS

X! Abort Job Whole Queue! Help

Number Job name User name Date submitted Status

1 SMITH SMITH Jan 20 1990 17:02PM Pending

6 UPLOAD TARQUIN Jan 20 1990 18:32PM Executing
10 8
102
POINT_UPL
POINT_UPL
MASON
MASON
Jan
Jan
19
19
1990
1990
12:23PM
10:12PM
Aborted
Completed

EV117

Figure 10-3 Batch Upload Status Form

UM6.1:SW3151 Revision H — July 1996

 Uploading Configuration Data 10-7

10.1.1.2 Aborting a Batch Upload

Select the Abort Job menu to abort any points not yet uploaded (typically
used for a tag set). The ENVOX software terminates the upload process
at this point. View the upload log to determine which points were
uploaded.

BATCH UPLOAD STATUS

X! Abort Job
Abort Job Whole Queue! Help
EV160

10.1.1.3 Viewing the Whole Queue

The queue for batch upload requests also supports other batch jobs, such
as batch generation and migration requests. You can view all batch jobs
by selecting the Whole Queue! option.

BATCH UPLOAD STATUS

X! Abort Job Whole Queue!
Whole Queue! Help
10
EV161

Figure 8-6 in subsection 8.6.1.2 shows an example of the Batch Jobs

Status form displayed when you select the Whole Queue! option.

Revision H — July 1996 UM6.1:SW3151

 10-8 Uploading Configuration Data

10.1.2 Interactive Uploading

Select Interactive from the Upload menu on the Upload form to compare or
replace the configuration database data with the current device data. When
you select Interactive, the ENVOX software displays the Interactive Upload
form (Figure 10-4). The form displays both the database, stored value, and
controller resident, upload value, uploadable DDPs for either the point or the
first point in the tag set you are uploading. The software lists the DDPs in
ascending occurrence number. The paragraphs that follow the figure describe
the items in the figure.

INTERACTIVE UPLOAD
X! Print! Help

Tag : POINT1 Type : UOC AO Source Device : UOC 1

DDP.OCC Mnemonic Stored Value Upload Value

1.0 EU 0% 100.000 75.000
2.0 EU 100% 200.000 100.000

10
EV119

Figure 10-4 Interactive Upload Form

Tag — The tag of the item you selected for this upload.
Type — The item type.
Source Device — The device this item is sourced in.
DDP.OCC — The fields below this column contain the DDP number. All
DDP types have a unique number that is consistent for all device types.
DDP is the actual DDP number, OCC is the occurrence of that DDP
number.
Mnemonic — The mnemonic for the DDP. Each DDP type has a unique
mnemonic, consistent for all device types.
Stored Value — The parameter value in the ENVOX database.
Upload Value — The parameter value in the source device.
This form lets you compare the values in the devices with corresponding
values in the database to help you determine whether to update the
configuration database.

UM6.1:SW3151 Revision H — July 1996

 Uploading Configuration Data 10-9

10.1.2.1 Uploading Device Data into the Database

To upload the current device data listed on the Interactive Upload form,
press the Exit key to exit the form and select Apply, Skip, Quit, or All
Remaining:

J Apply — Replaces the database data for this item with the on-line
data. If the item is not a tag set, the software displays the Upload
form. If you selected the item through a tag set, the software displays
the next item in the tag set on the Interactive Upload form.

J Skip — Does not replace the database data with the on-line values.
When using a tag set, the software displays the next item in the set in
the Interactive Upload form.

J Quit — Does not replace the database data with the on-line values.
Displays the Upload form. When using a tag set, quit effectively
cancels upload for all remaining items in the tag set.

J All Remaining — Replaces the database data for this item with the
on-line data. When you are working with a tag set, this option uploads
all the remaining items in the tag set.

10.1.2.2 Printing Interactive Upload Information

The ENVOX software automatically prints a log for each upload. To print
an additional upload log for the interactively uploaded items, select the 10
Print option from the Interactive Upload form. Subsection 10.7 describes
upload logs.

INTERACTIVE UPLOAD
X! Print! Help
EV162

Revision H — July 1996 UM6.1:SW3151

 10-10 Uploading Configuration Data

10.2 Generating Devices After Upload

Uploading modifies only the configuration database, not download data.
You must regenerate the devices after uploading to ensure that the
download data is current. Note that the ENVOX software provides a
warning message on the upload form, indicating that you should perform
a generate before the next download.

Note
If you upload a point whose DDPs are transmitted
to other devices, such as engineering unit (EU)
values, you must eventually regenerate that
controller and any other device to which the data
is reported. Examples are points that are sourced
in one device and are virtual in another.

10.3 Upload Privileges

The system administrator provides you with the privilege to upload
10 devices in the database. You must have upload privilege for the primary
device from which you wish to upload and for the (virtual) devices to
which the primary device reports information. The ENVOX software
displays error messages to indicate when you do not have sufficient
privilege to perform uploads. The printer logs the messages.

10.4 Upload Failures

If the ENVOX software loses communications during an upload because
of highway failure, highway disconnection, power loss to a device, or
device failure, the upload utility either finishes uploading or is terminated.
If the upload utility has completed reading the DDPs before the failure,
then the upload can proceed. If the failure occurs while the upload utility
is reading the DDPs, then the upload of that point fails without changing
that point in the database.

If communications are lost during the upload of a tag set, the following
occurs:

J If all the points in the tag set reside in the same controller, only those
points uploaded before the failure are updated.

J If the tag set consists of points residing in multiple controllers and

communications to one controller is lost:

UM6.1:SW3151 Revision H — July 1996

 Uploading Configuration Data 10-11

Points that have not already been uploaded in the lost controller
are not uploaded.

The remaining points in the tag set residing in the other controllers
are uploaded.

Upload error messages are handled on a point-by-point basis. The

ENVOX software writes an error message in the upload log to indicate
that uploads to the current point failed. If all the uploadable points in a tag
set are in one controller and a failure affects several points in the
controller, then the software reports an error for each affected point. Also,
when uploading in the interactive mode, the ENVOX software writes an
error message to the screen noting the failed upload point.

10.5 Uploads to LCP Registers

Only logic control point (LCP) registers with initial values are uploadable.
This gives you a flexible and simple way of using registers:

J Local registers, excluding the SVA, SVD, and SVP, are configurable,
tunable parameters to the FST. These registers are uploadable, if they
had initial values configured in the database.

J Depending on how you write your FST, you may not want all of your
local registers to be uploaded. For example, a boolean register might
have an initial value of TRUE, which directs the FST to perform a 10
special action on the first execution after download. (An example of
this special action would be initialization of an accumulation
calculation). After the FST has performed the special action, it may
reset the register to FALSE to avoid doing the special action again. In
this case, you would not want the value FALSE to be uploaded;
otherwise, your special action would not be performed after the next
download.

If you are using registers in this way, you may not wish to use Upload
on the LCPs. Alternatively, you could modify your FST so that you
avoid this effect, possibly by using the DLR or DLS instruction to
detect the first execution after download.

J Global LCP registers can be used as working registers whose value

changes as the FST calculation proceeds. These registers do not
have configured initial values and are therefore not uploadable.

Revision H — July 1996 UM6.1:SW3151

 10-12 Uploading Configuration Data

10.6 Upload Data Precision

Uploading may produce values in the database that differ slightly from the
values in the controllers.

The ENVOX software stores all floating-point numbers in double

precision, while the controllers store them in highway percent.
Consequently, some numbers may change slightly when uploaded. You
can compare the device value and database value to determine whether
the device value should be uploaded.

For example, if you request an upload of a point without having changed

its parameters in the controller, you may observe some minor differences
between the device values and the database values of the DDPs, as
illustrated below:

ddp attribute description observed value in

value in the database
device after upload
14.0 ALM DBND alarm 4.9992 4.99219
deadband

10.7 Upload Logs

10
Whether an upload was successful or failed, the ENVOX software
automatically creates an upload log. The log displays the differences
between device and database DDP values for all the items in the upload.
The log always prints in order to document those points affected by the
upload. This log is printed even if you quit an interactive upload because
other points in a tag set could have been previously uploaded.

You can view a log of the most recent (or currently processing) upload
through the View Log! option on the Upload form. Batch upload jobs can
access the log while an upload takes place. Interactive uploads must be
completed first before you can access the Upload form again. Logs
remain in the database until the next upload, at which time they are
replaced.

One of the following messages appears in the log just below each point
updated in the database:

U2943: INFORMATION - Item updated in database

Or

U3041: INFORMATION - Operator selected skip or quit,

item NOT updated in database

UM6.1:SW3151 Revision H — July 1996

 Uploading Configuration Data 10-13

Figure 10-5 illustrates an upload log. The paragraphs that follow the
figure describe each field on the log.

UPLOAD LOG
UPLOAD requested by BLOGGS JAN 11 1990 11:14PM
database DEFAULT
Tag : UOC-AO-1
Type : AO Source Device : UOC 1
U2943: INFORMATION -- Item updated in database
DDP.OCC Mnemonic Stored Value Upload Value
1.0 EU 0% 0.000 0.000
2.0 EU 100% 10.000 110.000
Tag : UOC-AI-2 Type : AI Source Device : UOC 1
U2943: INFORMATION -- Item updated in database
DDP.OCC Mnemonic Stored Value Upload Value
2.0 EU 100% 75.300 114.300
Tag : UOC-AI-3 Type : AI Source Device : UOC 1
No data to upload

Tag : UOC-AI-5 Type : AI Source Device : UOC 1

Upload failed : Device timeout

Figure 10-5 Upload Log

Tag — The tag of the item you selected for this upload.
10
Type — The item type.
Source Device — The device this item is sourced in.
DDP.OCC — The DDP numbers. All DDP types have a unique number,
consistent for all device types.
Mnemonic — The mnemonic for the DDP. Each DDP type has a unique
mnemonic, consistent for all device types.
Stored Value — The parameter value in the ENVOX database.
Upload Value — The parameter value in the source device.
Upload failed — The reason for failure (if any).
To view a log on the screen of the currently executing upload, select the
View Log! option from the Upload form.

UPLOAD
X! Upload View Log! Status! Help
EV163

Revision H — July 1996 UM6.1:SW3151

 10-14 Uploading Configuration Data

10.8 Uploadable Points and Their DDPs

Table 10-1 lists the uploadable point types for the IACs; computing and
configurable controllers; UOC family of controllers; multiplexers; and
SR90 and SRx controllers.

Table 10-1 Uploadable Point Types

AI EPCI MUX DI
AO GROUP MUX EXT AI
CONFIGURABLE DCP IAC ANALOG ICP MUX EXT AO
DCD IAC DCP MUX EXT DO
DI IAC DISCRETE ICP MUX STD AO
DM LCP PCI
DO LOOP PDO

Table 10-2 lists the uploadable DDPs for each point type in numerical
order. Each cell of the mnemonic-and-name column shows a DDP
mnemonic in boldface type and the name in regular type. Your program
may tune most DDPs; the boldface words Not tunable denote the DDPs
your program may not tune. The last column in the table shows the
devices to which the DDPs pertain.
Occurrence numbers follow some entries in the DDP number column. For
10 example, 187, 1—31 indicates that DDP 187 has 31 possible occurrence
numbers, 1 through 31.

Table 10-2 Uploadable Detail Display Parameters (1)

DDP
Number(2) Mnemonic and Name Devices(3)
1 EU 0% CFG, IAC, MUX,
Engineering units 0 percent value UOC, CHIP
2 EU 100% CFG, IAC, MUX,
Engineering units 100 percent value UOC, CHIP
3 GAIN CFG, IAC, MUX,
Gain UOC, CHIP
4 GAIN LM IAC
Gain limit error squared
5 RESET CFG, IAC, UOC,
Reset (or integral) CHIP
6 RATE CFG, IAC, UOC,
Rate (or derivative) CHIP
7 RAMP TIM CFG, IAC
Transfer ramp time
8 PV FTIM CFG, MUX, UOC,
PV filter time constant CHIP
9 REV ACT? CFG, IAC, UOC,
Reverse/direct control action CHIP

UM6.1:SW3151 Revision H — July 1996

 Uploading Configuration Data 10-15

Table 10-2 Uploadable Detail Display Parameters (1) (Continued)

DDP
Number(2) Mnemonic and Name Devices(3)
10 INC CLO? CFG, IAC, MUX,
Increase opens, increase closes UOC
11 ALM A TR CFG, IAC, UOC,
Alarm A trip point CHIP
12 ALM B TR CFG, IAC, MUX,
Alarm B trip point UOC, CHIP
13 ALM C TR CFG, IAC, MUX,
Alarm C trip point UOC, CHIP
14 ALM DBND CFG, IAC, MUX,
Alarm deadband UOC, CHIP
16 SP LO LM CFG, IAC, UOC,
Setpoint low limit CHIP
17 SP HI LM CFG, IAC, UOC,
Setpoint high limit CHIP
18 VO LO LM CFG, IAC, UOC,
Valve close limit CHIP
19 VO HI LM CFG, IAC, UOC,
Valve open limit CHIP
20 ARW LOLM CFG, IAC,, UOC,
Antireset windup low limit CHIP
21 ARW HILM CFG, IAC, UOC,
Antireset windup high limit CHIP
22 FF GAIN CFG, UOC 10
Feedforward gain
23 FF REV? CFG, UOC
Feedforward reverse/direct action
24 FF FTIM CFG, UOC
Feedforward filter time constant
25 TK FTIM CFG, UOC
Track filter time constant
26 WDOG TIM IAC
Watchdog timer timeout
27 BCKUP MD IAC
DDC or supervisory backup mode selection
28 RST MD CFG, IAC, UOC
Restart mode
29 RST VO CFG, IAC, UOC
Restart valve position
30 RST SP CFG, IAC, UOC
Restart setpoint
31 RST BIAS CFG, IAC, UOC
Restart bias
32 RST RAT IAC
Restart ratio
33 NTC LOBP IAC
Notch low breakpoint

Revision H — July 1996 UM6.1:SW3151

 10-16 Uploading Configuration Data

Table 10-2 Uploadable Detail Display Parameters (1) (Continued)

DDP
Number(2) Mnemonic and Name Devices(3)
34 NTC HIBP IAC
Notch high breakpoint
35 NTC RAT IAC
Notch ratio
36 PV LOBP IAC
PV low breakpoint
37 PV HIBP IAC
PV high breakpoint
38 PV LOGF IAC
PV gain factor low
39 PV HIGF IAC
PV gain factor high
40 DEV LOBP IAC
Deviation low breakpoint
41 DEV HIBP IAC
Deviation high breakpoint
42 DEV LOGF IAC
Deviation low gain factor
43 DEV HIGF IAC
Deviation high gain factor
44 VO LOBP IAC
Valve position low breakpoint
10 45 VO HIBP IAC
Valve position high breakpoint
46 VO LOGF IAC
Valve position low gain factor
47 VO HIGF IAC
Valve position high gain factor
48 DURATION Not UOC
Momentary duration for DO points tunable
49 DEADBAND Not UOC
TPO deadband for AO points tunable
50 BASE PER Not UOC
TPO base period for AO points tunable
51 AV LOBP IAC
Analog value low breakpoint
52 AV HIBP IAC
Analog value high breakpoint
53 AV LOGF IAC
Analog value low gain factor
54 AV HIGF IAC
Analog value high gain factor
55 DSC GF IAC
Discrete gain factor
56 DTC GAIN IAC
DTC process gain

UM6.1:SW3151 Revision H — July 1996

 Uploading Configuration Data 10-17

Table 10-2 Uploadable Detail Display Parameters (1) (Continued)

DDP
Number(2) Mnemonic and Name Devices(3)
57 DTC TIM IAC
DTC process time constant
58 DTC DTIM IAC
DTC process deadline
59 GCI ON IAC
GCI time on
60 GCI OFF IAC
GCI time off
61 FF MULT? IAC
Feedforward multiplier enable
62 FF MGAIN IAC
Feedforward multiplier gain
63 FF MREV? IAC
Feedforward multiplier reverse/direct
64 FF SUM? IAC
Feedforward summer enable
65 FF SGAIN IAC
Feedforward summer gain
66 FF SREV? IAC
Feedforward summer reverse/direct
70 FILT TIM IAC
First order digital filter time constant
71 INT GAIN IAC 10
Integrator gain
72 VEL LM IAC
Velocity limiter
73 DEAD TIM IAC
Dead time
74 TIMR TIM IAC
Timer time
75 CNT/RMP IAC
Counter/ramp time
76 LL GAIN IAC
Lead/lag gain
77 LL LEAD IAC
Lead/lag lead time
78 LL LAG IAC
Lead/lag lag time
79 MRNG ALM IAC
Mid-selector range alarm
80 X3 COEF IAC
Polynomial coefficient x3
81 X2 COEF IAC
Polynomial coefficient x2
82 X1 COEF IAC
Polynomial coefficient x1

Revision H — July 1996 UM6.1:SW3151

 10-18 Uploading Configuration Data

Table 10-2 Uploadable Detail Display Parameters (1) (Continued)

DDP
Number(2) Mnemonic and Name Devices(3)
83 X0 COEF IAC
Polynomial coefficient x0
99 0% AEU IAC
Auxiliary engineering units 0 percent endpoint
100 100% AEU IAC
Auxiliary engineering units 100 percent end point
105 BCD CNV? UOC
Binary-coded-decimal/binary conversion
106 MCOR UOC
Model correction type
107 MDTM UOC
Model deadtime
108 MGAIN UOC
Model gain
109 MLIM UOC
Model correction limit
111 MTIM UOC
Model time constant
112 RATIO UOC
Ratio of setpoint
113 BHLO UOC
Alarm B high or low?
10 114 CHLO UOC
Alarm C high or low?
115 TRPB UOC
Alarm B trip point
116 TRPC UOC
Alarm C trip point
117 ALM EN? UOC
Discrete input alarm enable
119 ALM VAL UOC
Discrete input alarm value
120 CONFK UOC
Pulse count conversation constant
121 FAILSAFE Not UOC
Group/DCD failsafe setpoint tunable
121 FAILSAFE UOC
Discrete output/PDO failsafe value
124 FAILSAFE UOC
Loop/analog output failsafe value
127 TRANTIME UOC
Transition time
128 RTRYCNTR UOC
Retry counter
130 INVERT? UOC
Discrete invert

UM6.1:SW3151 Revision H — July 1996

 Uploading Configuration Data 10-19

Table 10-2 Uploadable Detail Display Parameters (1) (Continued)

DDP
Number(2) Mnemonic and Name Devices(3)
148, 1—4 EA ENA? UOC
Extended alarms enable
149, 1—4 EREF UOC
Extended alarm reference value
151, 1—4 DI INV? MUX
Discrete input invert
160 AO FS VL MUX
Analog output failsafe value
161 AO FS TM MUX
Analog output failsafe timer
162, 1—4 DO FS VL MUX
Discrete output failsafe value
163 DO FS TM MUX
Discrete output failsafe timer
187, 1—31 BOOL REG UOC
LCP Boolean register
188, 1—31 INT REG UOC
LCP integer register
189, 1—31 FP REG UOC
LCP floating-point register
200 AO DBI UOC
Analog output database index
208 WDT MODE UOC 10
Supervisory loop watch dog timer timeout mode
209 WDT TIME UOC
Supervisory loop watch dog timer timeout time
224 TCALHI UOC
HART transmitter high scale value
225 TCALLO UOC
HART transmitter low scale value
226 PCALHI UOC
HART process high scale value

Revision H — July 1996 UM6.1:SW3151

 10-20 Uploading Configuration Data

Table 10-2 Uploadable Detail Display Parameters (1) (Continued)

DDP
Number(2) Mnemonic and Name Devices(3)
227 PCALLO UOC
HART process low scale value
239 IOFVAL UOC
Input fail action configured value
251, 1—8 CONVAL UOC
DCD conditions condition operand 2
253, 1—8 CONTIM UOC
DCD conditions condition timer
1. All DDPs are tunable unless otherwise noted in the Mnemonic/Name column.
2. This column also shows the ranges of possible occurrence numbers.
3. Devices to which the DDP pertains:
CFG = configurable controller (via a data concentrator)
CHIP = Computer/Highway Interface Package
IAC = computing or interactive controller (via a data concentrator)
MUX = multiplexer
UOC = unit operations controller, integrated function controller, SR90 controller, SRx controller, or
microPROVOXä automation system

10

UM6.1:SW3151 Revision H — July 1996

 Using the Trace/Tune Utilities 11-1

Figure 11-Table 11

11 Using the Trace/Tune Utilities

There are two utilities that give you the capability to examine or trace
controller operations and to change or tune controller parameter values.
The interactive controller (IAC) trace/tune utility is described beginning in
subsection 11.1. The logic control point (LCP) trace/tune utility is
described beginning in subsection 11.4.

11.1 Using the IAC Trace/Tune Utility

The IAC trace/tune utility enables you to do two things:

J Debug a control strategy by enabling you to set up trace points within

a function sequence table (FST)

J See the analog and discrete signals resulting from the function block
execution at the various trace points

The utility allows you to examine the execution results in a WINDOW

mode without affecting control loop execution. The principal trace
functionality supports controllers that have FSTs: interactive controllers
(IAC), computing controllers, and the family of unit operations controllers 11
(UOCs).

In addition, you can display and change controller loop and FST tuning
parameter values while using the trace/tune utility.

Note
Before using the trace/tune utility in BREAKPOINT
mode or making changes that may adversely
impact control operations, make sure that the
controller is in the MANUAL mode.

Revision H — July 1996 UM6.1:SW3151

 11-2 Using the Trace/Tune Utilities

11.2 IAC Trace Modes

There are three trace modes:

J NORMAL — In this mode, a controller runs as usual. Trace points

may not be set, and all input and output is in NORMAL mode.

J BREAKPOINT — This mode enables you to set trace points at as

many as 10 steps in the controller FST. This mode is normally
not used if the controller is in use, since control execution of the FST
stops when a breakpoint is reached. When the controller reaches a
trace point:

The function at the trace point is executed

FST execution stops (The information from control execution also

stops.)

The controller status AT BREAKPOINT shows in the display

header

The utility backlights the display line for the particular FST step

The utility updates the step accumulator values

J WINDOW — This mode allows setting trace points at as many as 10

steps in the controller FST. In the WINDOW mode, the controller does
not stop at trace points, but the utility updates the accumulator values
displayed on the screen as the utility passes each trace point.
11
The first time the utility traces a controller, the controller mode is normal.
Otherwise, its mode is the last mode you set. Normally, before you exit a
controller trace session, the mode is set back to NORMAL. This clears
the FSTs breakpoints and virtual I/O assignments.

UM6.1:SW3151 Revision H — July 1996

 Using the Trace/Tune Utilities 11-3

11.3 Starting the IAC Trace/Tune Utility

Step 1: Select the More option from the ENVOXr Top Level Form.

Step 2: Select the IAC Trace/Tune option from the pull-down menu.

ENVOX TOP LEVEL FORM

X Add Modify! Utilities More
More Status! Help

Generate
Download ->
Document
Upload
Diagnostics
IAC Trace/Tune
LCP Trace/Tune
Administration
Dbase Management ->
Audit Trail

The software displays the following:

11
TRACE/TUNE (IAC)
X! DEFINE CONT! I/O ACCUM! REG! TUNE! NEXT! PRINT!

X!
ENTER HIGHWAY # (0: NETWORK 1-8:LOCAL) :

Step 3: Enter the highway number of the device that is host to the FST
with which you want to work and press Return. The software
builds this additional prompt:

X!
ENTER HIGHWAY # (0 :NETWORK 1-8:LOCAL) :
ENTER DEVICE # (1-6: NETWORK 1-30: LOCAL) :

Revision H — July 1996 UM6.1:SW3151

 11-4 Using the Trace/Tune Utilities

Step 4: Enter the device number and press Return. The following
prompt appears:

X!
ENTER HIGHWAY # (0 :NETWORK 1-8:LOCAL) :
ENTER DEVICE # (1-6:NETWORK 1-30: LOCAL) :
ENTER PORT NUMBER :

Step 5: Enter the port number you want to trace. The software
displays a form like the one in Figure 11-1.

TRACE/TUNE (IAC)
X! DEFINE CONT! I/O ACCUM! REG! TUNE! NEXT! PRINT!

TRACE POINTS DISPLAY DEV TYPE: IAC-2 2 MAY 1995 14:16:10

Display
HWY # : 3 DEV # : 13 PORT # : 2 header
CONTROLLER TRACE MODE : NORMAL CONTROLLER STATUS : RUNNING

STEP PROGRAM ANALOG SIGNAL DISCRETE SIGNAL Trace mode and

NUMBER MNEMONIC ACCUMULATOR ACCUMULATOR controller status

Trace display
area

11
Controller values
Warning/error message line

Figure 11-1 IAC Trace/Tune Form Layout

The following list describes the components of the trace points display:
J Display header — Consists of the display title, the control address,
the date and time, and the port number. The header also lists
communications errors.
J Trace mode and controller status line — Shows the trace mode
(NORMAL, WINDOW, or BREAKPOINT), and the trace status of the
controller (RUNNING or AT BREAKPOINT).
J Trace display area — Shows either the list of trace points or the
current input/output (I/O) setup.
J Controller values display line — Displays user-selected controller
values.
J Warning/error message line — Displays warnings and error
messages.

UM6.1:SW3151 Revision H — July 1996

 Using the Trace/Tune Utilities 11-5

11.3.1 Changing Trace Mode

To change the trace mode, from the top-level menu select DEFINE ®
CHANGE TRACE MODE. Then select one of the modes. Subsection
11.2 describes the modes.

11.3.2 Setting Trace Points

You can set or clear trace points in WINDOWS or BREAKPOINT mode
while in the trace point display. Set trace points in one of these ways:
individually or in a range.

To set trace points, select DEFINE ® SET/CLEAR TRACE POINTS ®

SET TRACE POINTS.

The utility displays the following:

X!

ENTER STEP NUMBER(S), (I OR I,J) :

To set an individual trace point, enter the FST step number. The step
number, program mnemonic, and accumulator values appear in the trace
point display. Enter additional numbers if desired. When you’ve entered
all the step numbers you want, select X! from the menu.

To set a group of trace points, enter the number of the beginning and
ending FST steps of interest, separated by a comma. The utility sets trace
11
points at each step until the utility reaches the end of the range, or until
the utility sets the 10th trace point, whichever comes first. Select X! from
the menu when finished.

11.3.3 Clearing Trace Points

To clear a single trace point:

Step 1: Select DEFINE ® SET/CLEAR TRACE POINTS ®

CLEAR ONE TRACE POINT.

The utility displays the following in a dialog box:

X!

ENTER FST STEP NUMBER :

Step 2: Enter the number associated with the trace point you want to
clear.

Revision H — July 1996 UM6.1:SW3151

 11-6 Using the Trace/Tune Utilities

Step 3: Exit the dialog box.

To clear all trace points from a trace display select DEFINE ®

SET/CLEAR TRACE POINTS ® CLEAR ALL TRACE POINTS.

11.3.4 Continuing from Breakpoint

When a controller is AT BREAKPOINT, execution stops each time FST
execution comes to a trace point. Note that the execution stops after the
controller executes the step.

To continue from a BREAKPOINT, select CONT!.

11.3.5 Examining I/O Setup

To examine the I/O mode of each controller channel, select the
NEXT!.option from the menu. The software displays I/O CHANNEL
information in the trace display area of the screen as shown in
Figure 11-2.

TRACE/TUNE (IAC)
X! DEFINE CONT! I/O ACCUM! REG! TUNE! NEXT! PRINT!

I/O SET-UP DISPLAY DEV TYPE: IAC-4 05 MAY 95 13:50:22

HWY # : 1 DEV # : 22 PORT # : 8 POLLING : AI 4
CONTROLLER TRACE MODE : WINDOW CONTROLLER STATUS : RUNNING
11
CHANNEL NUMBER: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

ANALOG INPUTS: N N N N N N N N N N N N N N N N N N
ANALOG OUTPUTS: N N N N N N
DISCRETE INPUTS: N N N N N N N N
N = NORMAL
DISCRETE OUTPUTS: N N N N V = VIRTUAL

Figure 11-2 I/O Setup Display

Note that the utility identifies inputs and outputs as either N (normal) or V
(virtual). The utility polls all input and output channels continuously for
their status. The utility updates N or V codes as mode changes occur; as
the utility polls each channel, the code appears in the display header.

UM6.1:SW3151 Revision H — July 1996

 Using the Trace/Tune Utilities 11-7

In the VIRTUAL mode the utility temporarily suspends input and output
channels to allow you to monitor the effect of specific values without
affecting the process.
If an input channel is in the VIRTUAL mode, an input function of the FST
reads a virtual register instead of the input channel. This means that the
FST function reads your input rather than the actual input.
If an output channel is in the VIRTUAL mode, an output function of the
FST places its output into a virtual register instead of the output channel.
You can send a fixed value to the output channel.
Subsection 11.3.7.2 describes how to change the mode of an I/O
channel.

11.3.6 Selecting a New Device

You can change the device in either the trace points display or the I/O
set-up display without exiting the utility. When you change the device you
also have an option to clear all trace points and I/O overrides.
To change the device, select DEFINE ® CHANGE DEVICE NAME. The
utility builds the following prompts, enter each one:

X!
ENTER HIGHWAY # (0 :NETWORK 1-8:LOCAL) :
ENTER DEVICE # (1-6:NETWORK 1-30: LOCAL) :
ENTER PORT NUMBER :

11
11.3.7 Displaying and Changing Tuning Values
You can display and change several tuning values through the
trace-utility. Subsections 11.3.7.1 through 11.3.7.4 explain these options.
If one of these options is in progress when you select a new one, the
trace utility exits the option in progress and starts the new option.

11.3.7.1 Tuning Controller DDPs

The tune option is valid for points in any type of continuous controller.
However, it is the only trace utility option available for configurable
controller points. You must be in the trace points display to tune DDPs.
To tune controller DDPs:
Step 1: In the trace points display, select the TUNE! menu option. The
software displays the following:

X!

ENTER POINT NUMBER :

Revision H — July 1996 UM6.1:SW3151

 11-8 Using the Trace/Tune Utilities

Step 2: Enter the number of the point of interest. The utility displays
the mnemonic and value of the point’s first DDP and the
following prompt:

X!

SELECT NEXT DDP, OR PRESS <ENTER> TO CHANGE VALUE

Step 3: Enter the DDP number. The software prompts you for a new
DDP value:

X!

SELECT NEXT DDP, OR PRESS <ENTER> TO CHANGE VALUE

ENTER NEW VALUE :

11.3.7.2 Examining and Changing Controller I/O

You can examine and change I/O from either the trace points display or
the I/O set-up display in WINDOW or BREAKPOINT mode. To examine
and change the I/O:
Step 1: Select the I/O menu option followed by ANALOG I/O or
DISCRETE I/O. The software provides the following slide-off
menu choices:
J USE ACTUAL INPUT
11 J USE VIRTUAL INPUT
J SET INPUT
J USE ACTUAL OUTPUT
J USE VIRTUAL OUTPUT
J SET OUTPUT
Step 2: In order to select SET INPUT or SET OUTPUT you must first
select USE VIRTUAL INPUT or OUTPUT because the utility
does not permit changes to the actual inputs and outputs.
When you select an option, the utility prompts for the channel
number:

X!

ENTER CHANNEL NUMBER :

Step 3: Enter a valid channel number. The utility shows the channel
number, type, and actual value (if the I/O channel is in the
VIRTUAL mode, the utility displays the virtual value as well).

UM6.1:SW3151 Revision H — July 1996

 Using the Trace/Tune Utilities 11-9

Step 4: If you select SET INPUT or SET OUTPUT and you are using
virtual values, the software displays the following:

X!

ENTER NEW VALUE :

Step 5: Enter a new value. The utility incorporates the value into the
screen display.

Note
When the trace mode is normal, the utility displays
the actual value of a channel. To use virtual I/O or
to change an I/O value, the trace mode must be
WINDOW or BREAKPOINT.

11.3.7.3 Examining and Changing General Registers

You must be in the trace points display to examine or change the values
general registers. To examine or change general register values:
Step 1: Put the utility into the WINDOW or BREAKPOINT trace mode.
Step 2: Select the REG! menu option.
11
X!

ENTER GENERAL REGISTER NUMBER :

Step 3: Enter the register number. The screen display shows current
values of the general register: its number, analog value, and
discrete value. The utility displays a new prompt:

X!

ENTER NEW VALUE (ANALOG, DISCRETE)

Step 4: Enter a new analog value, a comma, and then a new discrete
value. To enter only a new analog value, press Return
immediately after the analog value; do not enter either a
comma or a discrete value. To enter only a discrete value,
enter a comma and the discrete value, then press Return; do
not enter an analog value before the comma.
The utility incorporates new values into the screen display.

Revision H — July 1996 UM6.1:SW3151

 11-10 Using the Trace/Tune Utilities

11.3.7.4 Examining and Changing the Accumulator

You must be in the trace points display in BREAKPOINT mode at a
breakpoint in order to examine or change the accumulator. To change the
accumulator:

Step 1: In BREAKPOINT mode at a breakpoint, select the ACCUM!

menu option. The software displays the following:

X!

ENTER A NEW VALUE (ANALOG, DISCRETE) :

Step 2: Enter a new analog value, a comma, and then a new discrete
value. To enter only a new analog value, press Return
immediately after the analog value; do not enter either a
comma or a discrete value. To enter only a discrete value,
enter a comma and the discrete value, then press Return; do
not enter an analog value before the comma.

The utility incorporates new values into the screen display.

11.3.8 Printing
The print option enables you to print the current display. To print, select
the PRINT! top-level menu.
11

UM6.1:SW3151 Revision H — July 1996

 Using the Trace/Tune Utilities 11-11

11.4 Using the LCP Trace/Tune Utility

The logic control point (LCP) trace/tune utility enables you to do two
things:

J Debug a control strategy by stepping though a function sequence

table (FST) of an LCP

J See the analog and discrete signals resulting from the function block
execution at the various trace points

The utility allows you to examine the execution results in a WINDOW

mode without affecting FST executions. When the device is off line,
process inputs and outputs may be changed in a virtual mode of
operation. Also, controller execution may be suspended at specific
breakpoints when the trace utility is used in BREAKPOINT mode.
Figure 11-3 shows how the trace utility works in this BREAKPOINT mode.

Process Inputs

Normal Input

Interrupt
Override Input

Trace Utility
FST

Calculated Output
11
Override Output

Interrupt
Normal Calculated
Output

Process Outputs
X00016:SW3151-0

Figure 11-3 The Trace Utility

In addition, you can display and change tuning parameters for points
while using the tune portion of the utility.

You control the trace utility by entering appropriate keywords. While in the
trace utility, certain keys and keywords have special control uses.

Revision H — July 1996 UM6.1:SW3151

 11-12 Using the Trace/Tune Utilities

Note
Two sets of mnemonics in the trace window
appear different from the mnemonics entered
during configuration.

The first set is the following percent-related

mnemonics: ADDP, SUBP, LIMITP, LDSVP, DIVP,
MULP, and BRAP.

Although these instructions are executed using a

percent factor, the mnemonics appear without the
percent character P. That is, they appear in the
trace utility as ADD, SUB, LIM, LDSV, DIV, MUL,
and BRA.

The second set is the following math-related

mnemonics: SQRT, SIN, COS, LN, EXP, and ABS.

These mnemonics do not appear in the trace

window; rather, the label MATH appears to
indicate any of the math mnemonics.

11

UM6.1:SW3151 Revision H — July 1996

 Using the Trace/Tune Utilities 11-13

11.5 LCP Trace Modes

There are three trace modes:

J NORMAL — In this mode, the system clears all selected LCP trace
points and resumes normal LCP execution. The LCP trace mode
status affects neither the I/O channel override status nor other LCPs.

J BREAKPOINT — This mode enables you to set trace points at as

many as 10 steps in the controller FST, and to single step the LCP.
This mode is not used if the LCP/FST is in use, because execution of
that LCP stops when a breakpoint is reached.

Breakpoint is not available for loop LCPs. (You can tune the LCP type
to be continuous at the console in order to debug it, but this disables
the coordination between the LCP and its associated loop.) When the
selected LCP reaches a trace point (or the next step if single
stepping) the following occurs:

The STEP line is updated like a trace point, in single-step

execution.

The LCP function at the trace point is executed, then LCP

execution stops.

The LCP trace status shows AT BREAKPOINT in the display

header.

The display line for the particular controller step is backlit.

11
The system updates accumulator values for the step.

At a breakpoint, you may not set the accumulator values using the
ACCUMULATOR command. The step function allows execution to
continue to the next breakpoint whenever the LCP stops (AT
BREAKPOINT or SINGLE STEP) in the BREAKPOINT mode.

J WINDOW — This mode allows setting trace points at as many as

10 steps in the controller LCP FSTs. In the WINDOW mode, the
controller does not stop at trace points. Instead, the system updates
the accumulator values displayed on the screen as the utility passes
each trace point.

The first time the utility traces an LCP after download, the LCPs mode is
NORMAL. Otherwise, when the trace mode is exited and reentered, it is
the last mode set. Normally, before you exit a controller trace session, the
mode is set back to NORMAL. This clears the FST breakpoints and
virtual I/O assignments.

Revision H — July 1996 UM6.1:SW3151

 11-14 Using the Trace/Tune Utilities

11.6 Starting the LCP Trace/Tune Utility

To start the trace/tune utility:

Step 1: Select the LCP Trace/Tune option from the More menu on the
ENVOX Top Level Form.

ENVOX TOP LEVEL FORM

X Add Modify! Utilities More Status! Help

Generate
Download ->
Document
Upload
Diagnostics
IAC Trace/Tune
LCP Trace/Tune
LCP Trace/Tune
Administration
Dbase Management ->
Audit Trail
EV196

The software displays the following:

11

TRACE/TUNE (LCP)
X! DEFINE DEBUG OPERATE ACCUM REGISTER NEXT! PRINT!

X!
ENTER DEVICE NAME :
ENTER LCP POINT TAG OR PRESS <ENTER>:

Step 2: Enter the device name and the LCP tag. To be valid, an LCP
tag must be the tag of an LCP in the controller and in the
ENVOX database you are working in. The software displays
the trace-points display for the LCP you selected. For
example:

UM6.1:SW3151 Revision H — July 1996

 Using the Trace/Tune Utilities 11-15

TRACE/TUNE (LCP)
X! DEFINE DEBUG OPERATE ACCUM REGISTER NEXT! PRINT!

TRACE POINTS HWY: 8 DEV: 15 DEV NAME: SR90-8-15 02-OCT-1994 09:94:04

LCP POINT TAG: LCP-1 LCP MODE: MAN
Display header
LCP TRACE MODE: NORMAL LCP TRACE STATUS: RUNNING
FST TAG STEP MNEMONIC SVA SVP SVI SVD

LCP trace mode

and LCP status
line

Trace
display
area

Controller values display line

Warning/error message line

Figure 11-4 LCP Trace/Tune Form Layout

The following list describes the components of the trace points display:

Display header — Consists of the display title, the control address,

J
the date and time, the LCP tag, and the LCP mode. The header also 11
lists communications errors.

J LCP trace mode and LCP trace status line — Shows the trace
mode (NORMAL, WINDOW, or BREAKPOINT), as well as the trace
status of the controller (RUNNING, AT BREAKPOINT, SINGLE STEP,
IDLE, or OUT OF SERVICE).

J Trace display area — Shows either the list of trace points or the
current input/output (I/O) setup.

J Controller values display line — Displays user-selected controller

values.

J Warning/error message line — Displays user-entered keywords.

Revision H — July 1996 UM6.1:SW3151

 11-16 Using the Trace/Tune Utilities

Figure 11-5 shows an example of a trace points display.

TRACE/TUNE (LCP)
X! DEFINE DEBUG OPERATE ACCUM REGISTER NEXT! PRINT!

TRACE POINTS HWY: 8 DEV: 15 DEV NAME: SR90-8-15 02-OCT-1994 09:94:04

LCP POINT TAG: LCP-1 LCP MODE: MAN
LCP TRACE MODE: NORMAL LCP TRACE STATUS: RUNNING

FST TAG STEP MNEMONIC SVA SVP SVI SVD

LOOPIN 0001 LDSV XXXXXXXXXXX XXX.XX XXXXXX X

LOOPIN 0002 BRA XXXXXXXXXXX XXX.XX XXXXXX x
LOOPIN 0003 LDSV XXXXXXXXXXX XXX.XX XXXXXX X

FST Tag
FST Step Number
Accumulator Values
Instruction Mnemonics

Figure 11-5 Example Trace Points Display

11
11.6.1 Changing the LCP Trace Mode
To change the trace mode, from the top-level menu select DEFINE ®
CHANGE TRACE MODE. Then select one of the modes.

Note
Before using the trace/tune utility in BREAKPOINT
mode and making changes that adversely impact
control operation, make sure the associated
control loop or loops are in MANUAL mode.

UM6.1:SW3151 Revision H — July 1996

 Using the Trace/Tune Utilities 11-17

11.6.2 Setting LCP Trace Points

Trace points can be set or cleared while the LCP is in the WINDOWS or
BREAKPOINT modes.

To set trace points:

Step 1: Select DEFINE ® SET/CLEAR TRACE POINTS ®

SET TRACE POINTS.

The utility displays the following in a dialog box:

X!

ENTER ”FST TAG, FIRST—LAST” STEPS TO SET :

ENTER ”FST TAG, FIRST-LAST” STEPS TO SET :

Step 2: Enter the FST tag, followed by a single step or a range of

steps. For example, to set a trace point on a single step:

X!

FST23, 16

FST23, 16 11
To set trace points for a range of steps:

X!

FST23, 16—43

FST23, 16-43

Step 3: Exit the dialog box.

Note
When you are setting and clearing trace points,
omitting the FST name defaults to the last-entered
FST name.

Revision H — July 1996 UM6.1:SW3151

 11-18 Using the Trace/Tune Utilities

11.6.3 Clearing Specific LCP Trace Points

To clear trace points:

Step 1: Select DEFINE ® SET/CLEAR TRACE POINTS ®

CLEAR TRACE POINTS.

The utility displays the following in a dialog box:

X!

ENTER ”FST TAG, FIRST—LAST” STEPS TO CLEAR :

Step 2: Enter the FST tag, followed by a single step or a range of

steps. When you are setting and clearing trace points, omitting
the FST name defaults to the last-entered FST name.

Step 3: Exit the dialog box.

11.6.4 Clearing All LCP Trace Points

To clear all trace points from a trace display select DEFINE ®
SET/CLEAR TRACE POINTS ® CLEAR ALL TRACE POINTS.

11.6.5 Selecting a New Device

11
You can change the device without exiting the utility. When you change
the device you also have an option to clear all trace points and I/O
overrides, if the utility is in WINDOW or BREAKPOINT mode.

To change the device:

Step 1: Select DEFINE ® CHANGE DEVICE NAME.

The following is displayed if the utility is in WINDOW or

BREAKPOINT mode:

RESTORE LCPS AND I/O CHANS TO NORM <1-YES 2-NO> :

(If the utility is in NORMAL mode, you are prompted for a new
device name and LCP point tag.)

Step 2: Type 1 to clear all trace points and I/O overrides. The utility
displays a restored device message and returns to the main
trace function.

The utility prompts you for a new device name and LCP point
tag.

UM6.1:SW3151 Revision H — July 1996

 Using the Trace/Tune Utilities 11-19

11.6.6 Changing the LCP Point Tag

To select a new LCP for the Trace Points Display:

Step 1: Select DEFINE ® CHANGE LCP POINT TAG.

The utility displays the following dialog box:

X!

ENTER LCP POINT TAG :

Step 2: Enter a tag name. The utility updates the Trace Points Display.

11.6.7 Stepping through an FST

The STEP function enables you to step through an FST as though a trace
point were at every step. The STEP function causes one FST step to be
executed whether or not it is a trace point. The STEP function is valid in
the BREAKPOINT mode.

To step through an FST, select DEBUG ® STEP.

If a currently selected LCP is at BREAKPOINT or SINGLE STEP, the FST

execution resumes, then stops after the next FST step to be executed. IF
the current step is a branch instruction, the system executes and displays
the next FST step according to normal rules of FST operation. 11

11.6.8 Continuing From Breakpoint

When a controller is in the BREAKPOINT MODE, execution stops each
time FST execution comes to a trace point. Note that the execution stops
after the controller executes the step.

To continue from BREAKPOINT, select DEBUG ® CONT.

Revision H — July 1996 UM6.1:SW3151

 11-20 Using the Trace/Tune Utilities

11.6.9 Running an LCP

Running an LCP forces execution of a currently idle LCP. The term
currently idle LCP refers to LCPs that are executed in a one-shot fashion
and depend on other LCPs for initiation, and newly configured LCPs that
are not scheduled. The option of running an LCP is valid in any trace
mode. Although intended for idle LCPs, this option may be used with
caution for scheduled LCPs or those associated with direct control points.

To run an LCP:

Step 1: Select DEBUG ® RUN.

The utility displays the following dialog box:

X!

ENTER TAG OF LCP TO RUN :

Step 2: Enter the tag. The utility starts the LCP.

11.6.10 Stopping an LCP

The STOP option suspends execution of an LCP. It is for LCPs that are
currently continuously executing. It may be used with caution for
11 scheduled LCPs associated with direct control points.

To stop an LCP

Step 1: Select DEBUG ® STOP.

The utility displays the following dialog box:

X!

ENTER TAG OF LCP TO STOP :

Step 2: Enter the tag. The utility stops the LCP.

UM6.1:SW3151 Revision H — July 1996

 Using the Trace/Tune Utilities 11-21

11.6.11 Clearing All Trace Points from a Device

The RESTORE function clears all trace functions from the current device,
including all trace points from all LCPs and all overrides from all I/O
channels. It is valid at any time.

To clear all the trace points and I/O overrides for a device:

Step 1: Select DEBUG ® RESTORE.

The utility displays the following dialog:

RESTORE LCPS & I/O CHANS TO NORM <1-YES 2-NO> :

Step 2: Press 1 to clear the trace points.

11.6.12 Examining and Changing the Accumulator

You can update the accumulator only when the controller is being held at
a breakpoint or is being single-stepped. You can then examine and
change the accumulator’s analog, integer, and discrete values.

To change the accumulator, select the ACCUM top level menu. Then,
select one of the following options:

J SVA — the analog accumulator signal value (the floating-point

accumulator)

SVP/SVI — the SVI is the integer accumulator signal value. The SVP
J
is the SVI in highway percent format (SVP = SVI divided by 256). 11
This menu option has these additional choices. The utility accepts
values in the ranges shown:

INTEGER: --32,768 through 32,767

PERCENT: --128 through 127.996

FILE--CARD--CHANNEL: file--card--channel format

hexadecimal: 2-byte hexadecimal format

J SVD — the discrete accumulator signal value (accepts values of

0 or 1)

When you select any of these options, the utility prompts you for a value.
You can enter a value or press Return to examine the current value.

Revision H — July 1996 UM6.1:SW3151

 11-22 Using the Trace/Tune Utilities

11.6.13 Examining and Changing Registers

To examine or change the values of any of the local or global registers,
select REGISTER. Then, select one of the following options:

J LOCAL REAL — allows you to examine or change any local real

register values

J LOCAL INTEGER/PERCENT — allows you to examine or change any

of the following local register types through these additional options.
The utility accepts values in the ranges shown:

INTEGER: --32,768 through 32,767

PERCENT: --128 through 127.996

FILE--CARD--CHANNEL: file--card--channel format

hexadecimal: 2-byte hexadecimal format

J LOCAL BOOLEAN — allows you to examine or change any global

real register values. Accepts values of 0 or 1.

J GLOBAL REAL — allows you to examine or change any global real

register values

J GLOBAL INTEGER/PERCENT — allows you to examine any of the

global register types. This option includes the same additional options
as the LOCAL INTEGER/PERCENT option.
11 J GLOBAL BOOLEAN — allows you to examine or change any global
real register values. Accepts values of 0 or 1.

For any of these choices, the utility provides the following dialog box:

X!

ENTER NEXT REGISTER NUMBER OR PRESS <ENTER> :

The utility displays the current value of the register at the bottom of the
form.

ENTER NEW VALUE :

For the first prompt, enter the register number or press Enter to examine
or change the last selected register number. If this is the first time you
have called up the display, pressing Enter calls up the first register in the
device.

For the second prompt, enter a new value.

UM6.1:SW3151 Revision H — July 1996

 Using the Trace/Tune Utilities 11-23

11.6.14 Examining and Overriding I/O

The ability to examine and override controller I/O allows you to display
and override the current value of any controller process I/O channel. In
this way, you can specify I/O values and monitor their effects on LCP
operation.

When an entered value overrides an input channel or pseudo I/O value,

then an input function of any IFC or UOC+ point reads the override value.
The override value appears in the display with an asterisk. The asterisk
indicates an override condition.

When an entered value overrides an output channel, the computed output

value of the channel remains in the display, although the override value is
output to the process. When a value overrides an output, the calculated
value appears in the display with an asterisk, which indicates an override
condition on inputs and output.

Step 1: To examine or override I/O, select OPERATE ® I/O.

The utility displays the following dialog box:

X!

SELECT NEXT F-C-C OR PRESS <ENTER> :

Step 2: For the first prompt, enter a file--card--channel or press Enter

to examine or change the last selected file--card--channel
11
override value.

The utility displays the override value at the bottom of the

screen and displays the following in the dialog box:

X!

ENTER NEW VALUE OR TYPE C TO CLEAR OVERRIDE :

Step 3: Enter a new override value or press Enter to examine the

current override value, or type C to clear the override status.
The utility displays the override value at the bottom of the
form.

Revision H — July 1996 UM6.1:SW3151

 11-24 Using the Trace/Tune Utilities

11.6.15 Tuning Controller DDPs

The Tune function allows the user to display and change DDPs on any
IFC, UOC+, or SR90 point.
To tune a DDP:
Step 1: Select OPERATE ® TUNE.
The utility displays the following dialog box:

X!

ENTER TAG OF POINT TO TUNE :

Step 2: Enter a tag. The utility displays the tag, the DDP number and
its mnemonic at the bottom of the form. The utility displays the
following in the dialog box:
ENTER NEXT DDP OR PRESS <ENTER> :
ENTER NEW VALUE :
Step 3: Enter a DDP number and a value.

11.6.16 Monitoring I/O Channels

The NEXT! menu option toggles between the trace points display and the
I/O setup display. The I/O setup display shows the card types and current
value of each input and output channel of an I/O file.
Figure 11-6 shows a setup display.
11

TRACE/TUNE (LCP)
X! DEFINE DEBUG OPERATE ACCUM REGISTER NEXT! PRINT!

I/O VALUES HWY: 8 DEV: 15 DEV NAME: SR90-8-15 18-MAY-1995 15:45:32

LCP POINT TAG: LCP-1 LCP MODE: MAN
LCP TRACE MODE: NORMAL LCP TRACE STATUS: RUNNING

CARD ADDRESS: 1-2 CARD TYPE: DIO

CH# 1 DO LAT 1 CH# 9 DO LAT 1
CH# 2 DO LAT 0 CH# 10 DO LAT 0
CH# 3 DO LAT 0 CH# 11 DO LAT 0
CH# 4 DO LAT 0 CH# 12 DO LAT 0
CH# 5 DO LAT 0 CH# 13 DO LAT 0
CH# 6 DO LAT 0 CH# 14 DO LAT 0
CH# 7 DO LAT 0 CH# 15 DO LAT 0
CH# 8 DO LAT 0 CH# 16 DO LAT 0

“*” = channel overridden

Figure 11-6 I/O Setup Display

UM6.1:SW3151 Revision H — July 1996

 Using the Trace/Tune Utilities 11-25

Channel values appear in percent for analog I/O, in raw count for pulse
count inputs, and as 0 or 1 for discrete values. An asterisk appears to the
right of the value of an overridden channel.

Input and output channels in the OVERRIDE mode are temporarily

suspended, so that a you can monitor the effect of specific values, without
affecting the process.

If an input channel is in the OVERRIDE mode, an input function of the

FST reads an override location instead of the input channel. This means
that the FST function accepts user input rather than the actual input of the
overall system. You can also examine the actual system input.

If an output channel is in the OVERRIDE mode, an output function of the

FST puts its output into an override location instead of the output channel.

To show the display:

Step 1: Select NEXT!.

The utility displays the following dialog box:

X!

ENTER ”FILE-CARD” NUMBER OR PRESS <ENTER> :

Step 2: Enter the file--card address. The utility builds an I/O setup
display for the file. 11
Select NEXT! to switch back to the trace points display.

11.6.17 Printing
The print option enables you to print the current display. To print, select
the PRINT! top-level menu.

Revision H — July 1996 UM6.1:SW3151

 11-26 Using the Trace/Tune Utilities

This page intentionally left blank.

11

UM6.1:SW3151 Revision H — July 1996

 Using the HART Instrument Locator Tool 12-1

Figure 12-Table 12

12 Using the HART Instrument

Locator Tool
The HART Instrument Locator Tool (HILT) is a standalone utility that
gathers information about all smart field devices (HART-compatible)
connected to a PROVOXr system through configured controllers. This
information is stored in a Comma Delimited Values (CDV) file that you
specify to the utility so that you can correctly address Asset Management
Solutions (AMS) instruments when the need arises. The data is also
stored in your ENVOXr database. For a fully configured PROVOX
system, every HART channel in the network regardless of whether it
actually has a smart field device (HART-compatible) connected to it will
have data stored in the ENVOX database.
The HILT utility is run through a command issued from your ENVOX
system for VAX/VMS, AXP/VMS, and HP-UX systems (i.e., all ENVOX
platforms). The ENVOX forms system is not used.
The HILT utility enables you:
J to create a list of HART instruments configured as connected to the
PROVOX system
J to create updated lists when additions or deletions occur.

12.1 Starting the HILT Utility

The HILT utility is started when you issue the following command at the
command prompt:
12
$ hilt ”filename” ”username” ”dbname”
This command applies to all platforms.
The HILT utility command requires you to enter three arguments:
1. the name of the file to which the HILT output is written
2. the name of the ENVOX user
3. the name of the database on which the utility is to run.

Note
You should use quotes to enclose the file, user,
and database names that you are entering on the
command line to avoid com_login failures.

Revision H — July 1996 UM6.1:SW3151

 12-2 Using the HART Instrument Locator Tool

If you require some help, you may enter the following command at the
prompt:

$ hilt -h

HILT then displays the following information:

HILT Revision 1
Arguments should be <filename> <usernames> <dbname>

Enter the names for the file, user, and database in the command line.

When the utility begins, it displays the following information:

**Hart Instrument Locator Tool (HILT) Revision 1 **

Creating ”filename” from ”dbname”, user ”username”

Processing Device ’@x-yy’ : ’ff-cc-ch’

where
filename, dbname and username are the same as the command line
arguments, and
x the highway number
yy the device number of the device being processed.
ff the I/O file number
cc the card number
ch channel number currently being processed.

HILT notifies you if you have entered an incorrect command argument.

Re-enter the necessary names.

When the utility has completed its processing, it returns you to the
12 command prompt. The output from the HILT processing is stored in a
Comma Delimited Values (CDV) format in the filename you specified on
the command line.

12.2 HILT Operation

The HILT utility performs the following steps during its operation:

1. Logs on to the SYBASE server as the user you specified on the

command line.

2. Uses the database you specified on the command line.

3. Initializes CHIP.

4. Gets a list of all HART channels and their associated instrument

signal tags (ISTs) from your named database.

5. For each channel in the list, the utility polls the address to get the
instrument’s unique identifier (id).

UM6.1:SW3151 Revision H — July 1996

 Using the HART Instrument Locator Tool 12-3

6. For each found HART instrument, the utility polls the address to get
the instrument’s tag.

7. Opens the file you named on the command line.

8. For each instrument found to exist, writes one CDV sentence

containing highway number, device number, file number, card number,
channel number, IST, unique id, and instrument tag from the HART
instrument.

9. Closes the CDV file.

12.3 HILT Output

HILT produces a Comma Delimited Values (CDV) file that is stored in the
file named by the user through the command line. This file, in sentence
format, contains the following fields in the order listed:

J Five-part PROVOX address consisting of the following:

Highway number — decimal integer

Device number — decimal integer

File number — decimal integer

Card number — decimal integer

Channel number — decimal integer

J Instrument Signal Tag (IST) of an instrument’s channel configured for

that address — string of up to 12 characters enclosed in double 12
quotes. No ISTs or several ISTs may be configured for each HART
channel.

J HART Unique Identifier consisting of the following:

Address size — decimal integer

Unique address — list of hexadecimal integers

J Instrument Tag from the HART instrument — string of exactly 8

characters enclosed in double quotes

The sentence format of the CDV file contains the following:

1. The initial sentence contains a single integer value that indicates the
revision level of HILT followed by zero or more keywords.

2. There is one sentence for each combination of the PROVOX address,

IST, HART unique id, and HART instrument tag for each instrument
configured as connected to the system.

Revision H — July 1996 UM6.1:SW3151

 12-4 Using the HART Instrument Locator Tool

3. Each sentence including the first is terminated by a period.

4. The fields in a sentence are separated by commas.

The following example illustrates how the information collected by HILT is

stored in the CDV file:

1,DuplicateHartTags=TRUE,DuplicateIstAddresses=TRUE.
4,22,9,1,1,”IST42291”,5,26034C649F, ”HILTI ”.
4,22,9,1,1,”IST422911”,5,26034C649F,”ANOTHER ”.
4,22,9,1,3,”IST422913”,5,2603000400,” ”.
4,22,9,1,4,”IST422914”,5,26031EBE1E,”@@@@@@@@”.
4,22,9,1,5,”IST422915”,5,2603B74132,”FT11534 ”.
4,22,9,1,6,”IST422916”,5,260604E2F0,”FTC—1348”.
4,22,9,1,7,””,5,260D007080,”FCT—8934”.
4,22,9,1,8,””,5,26035CDCD0,” ”.
4,22,9,1,10,””,5,26031EBED7,” ”.
4,22,9,1,11,””,5,26037A177B,”FTTC ”.
4,22,9,1,12,”IST4229112”,4,02004ECE,”TEMP ”.

Notice that address 4-22-9-1-1 appears twice with two different ISTs. In
addition, several addresses have no IST defined, which gives you the null
strings.

12.4 Browsing HILT CDV Files

When the HILT utility has completed its processing, it returns you to the
command prompt. The file containing the HILT information can then be
edited, listed, and printed using the normal system commands.

12 The ENVOX database also contains the information collected by the HILT
utility in the ENVOX table named hart_instruments. If you wish to access
the information in the ENVOX table, use the simple select command to
obtain the same information that is also contained in the CDV file.

UM6.1:SW3151 Revision H — July 1996

 Using the Diagnostics Utility 13-1

Figure 13-Table 13

13 Using the Diagnostics Utility

The diagnostics utility provides displays that show the integrity of
instrumentation system highways and highway devices. Once you have
selected a diagnostic display, the diagnostic information is continuously
updated so that you can monitor and troubleshoot the system. In displays,
you have several utility operation options that you can implement by using
pull-down menus and by pressing dedicated keys. This section:

J Explains how to activate the utility

J Describes the displays

J Describes the pull-down menus and the dedicated keys that operate
the utility

The diagnostics utility can be executed as either a character terminal or

X-window application.

13.1 Activating the Diagnostics Utility

The diagnostics utility has two modes of operation:

J the ENVOXr forms system mode (X-window or character terminal)

J the command line mode

13

Revision H — July 1996 UM6.1:SW3151

 13-2 Using the Diagnostics Utility

13.1.1 Activating With the ENVOX Forms System

To activate the diagnostics utility through the ENVOX forms system:

Step 1: Select the More option from the ENVOX Top Level Form.
Step 2: Select the Diagnostics option from the pull-down menu.

ENVOX TOP LEVEL FORM

X Add Modify! More Status!
Utilities More Help

Generate
Download ->
Document
Upload
Diagnostics
IAC Trace/Tune
LCP Trace/Tune
Administration
Dbase Management ->
Audit Trail
EV165

The software displays the Diagnostics Executive form (Figure 13-1). This
form is the starting point for a hierarchy of device and highway-specific
displays.

13.1.2 Activating Via the Command Line

You can activate either the character version or the X-windows version by
calling the required executable from the command line.
13 J VMS Command

To invoke the character version, use the following:

$ MCR envox$application:diags.exe

To invoke the X-terminal version, use the following:

$ MCR envox$application:x_diags.exe
J UNIX Command
To invoke the character version, use the following:

$ diags.exe
To invoke the X-terminal version, use the following:

$ x_diags.exe

UM6.1:SW3151 Revision H — July 1996

 Using the Diagnostics Utility 13-3

When the diagnostics utility is executed from the command line, you must
set up the local environment. For example,

J VMS Command

$ DEFINE sybase_term vt100

$ SET Terminal/device_type=vt100

J UNIX Command

$ SYBASE_TERM=vt100

$ export SYBASE_TERM

When the command is entered, the software displays the Diagnostics

Executive form (Figure 13-1). This form is the starting point for a
hierarchy of device and highway-specific displays.

DIAGNOSTICS EXECUTIVE
X! Print!

@Copyright Fisher-Rosemount Systems, Inc. 1980, 1996

1. System Integrity
2. Local Area Integ.
3. Device Integrity
4. Device Rev. Info.
5. Traffic Statistic
6. Unsolicited Data
13

Figure 13-1 Diagnostics Executive Form

Revision H — July 1996 UM6.1:SW3151

 13-4 Using the Diagnostics Utility

13.2 Diagnostics Utility Menu Hierarchy

There is logical progression, by means of a hierarchy of displays, through
the diagnostics utility. Figure 13-2 shows an overview of the hierarchy for
accessing the displays.

As seen in Figure 13-1, you have six selections in a menu from which you
start moving through the hierarchy. Some of these selections take you
directly to the display; others prompt you for a highway number and a
device number; and beyond that, in some cases, further selections are
offered. These prompts and further selections are explained in later
subsections.

Up to eighty displays are available depending on the types of devices in

your PROVOXr system. The information in this section describes how to
navigate to diagnostic displays. Refer to the PROVOX product
maintenance manuals for detailed information about the contents of a
particular diagnostic display.

13

UM6.1:SW3151 Revision H — July 1996

 Using the Diagnostics Utility 13-5

CHIP
1. System Integrity
2. Local Area Integrity 1. Console Integrity
3. Device Integrity Console 2. Activities
4. Device Revision Information 3. Accumulations
5. Traffic Statistics
6. Unsolicited Data Control 1. UOC Integrity
2. I/O Status
Series 10 UOC
3. Control Unit Parameters
4. Card Types

SIU 1. SIU Integrity

2. Computer Status

1. Controller Integrity
2. I/O Status -- Device
3. I/O Status -- File
UOC/IFC/SR90 4. I/O Status -- Card
5. Controller Parameters
6. Communications Status
7. Traffic Statistics

UOC/IFC/SR90 Backup

1. Controller Integrity
2. Driver Status
3. I/O Status -- Dev.
4. I/O Status -- File
SRx
5. I/O Status -- Card
6. Controller Param.
7. Comms Status
8. Traffic Statistics

SRx Backup
1. Controller Integ.
2. Controller param.
13
1. NIU Integrity
NIU
2. Logical Link Device Integrity

1. DCU Integrity
DCU 2. Controller Types
3. Controller Status

1. Trend Unit Integrity

Trend
2. Add Slot Status

1. All Devices In System

2. All Devices In Area
3. Single Device and Sub Device
4. Single Device or Sub Device

Figure 13-2 Diagnostics Utility Menu Hierarchy

Revision H — July 1996 UM6.1:SW3151

 13-6 Using the Diagnostics Utility

13.3 Navigating in The Diagnostics Utility

Navigating in the diagnostics utility is very similar to the rest of ENVOX
navigation. You may use a mouse or the keyboard in an X-windows
application, and use the keyboard to highlight the menu option in a
character terminal application. Pull-down menus that appear after one
keystroke, highlighted character keys for menu selection, and arrow keys
are used.

Figure 13-1 shows the menu bar for the diagnostics executive form. Use
the mouse or the Gold key to toggle between the menu bar and the work
area menu. In the menu bar, press r to print the screen or X! to exit the
utility. You may also use the mouse or the right and left arrow keys, and
Return, to make these selections.

In the work area of the diagnostics executive form, use the mouse or the
up and down arrow keys to move the cursor to the option you want, and
press Return. Or, enter the number of the option you want. When the
number is entered, the next display in the hierarchy comes up.

In diagnostic displays, the menu bar looks like that shown in Figure 13-3.
To navigate in the menu bar, select the item using the mouse or pressing
the character key for the highlighted (boldface) letter or symbol. Or, you
may use the right and left arrow keys and press Return to make the
selection. The figure also shows the pull-down menu options when you
select one of the menus.

(Display Name)
X! Page Action Print!

13 Next
Previous
Main Menu selections with a ! following the menu
name do not have a pull-down menu; select-
Logging ing the menu takes you directly to the opera-
Time tion.
Switchover
Enable Switch
Disable Switch

Figure 13-3 Diagnostic Display Menu Bar and Pull-Down Menu Options

UM6.1:SW3151 Revision H — July 1996

 Using the Diagnostics Utility 13-7

The menu bar items are:

J X! — Returns to the previous display in the hierarchy

J Page — Navigates through displays, as described below

J Action — Allows certain interactions with highway devices, as

described below

J Print! — Prints the display on your printer

When you select a menu bar item that includes a pull-down menu, the
pull-down menu automatically appears upon item selection. Then, you
can select the desired pull-down menu option by pressing the character
key for the option, or you may move the black highlighter bar with the up
and down arrow keys and press Return.

The pull-down menu options are:

J Page Menu

Next — Brings up the next page in a multi-page diagnostic display,

Including wrap-around

Previous — Brings up the previous page in a multi-page

diagnostic display

Main — Returns the utility to the diagnostics executive menu

J Action Menu

Logging — Toggles the screen logging function. Logging is

explained in subsection 13.5.

Time — Allows you to set the date and time on a trend unit

Switchover — Toggles between the primary and backup units in a

13
redundant scheme

Enable Switchover — Enables automatic switchover for backup

units

Disable Switchover — Disables automatic switchover for backup

units

Certain function keys can be used to navigate in the displays. Table C-5
lists these keys.

Revision H — July 1996 UM6.1:SW3151

 13-8 Using the Diagnostics Utility

13.4 Diagnostics Displays

Each page of a diagnostics display follows the same general layout.
Figure 13-4 shows the system integrity display and the general areas of a
diagnostic display.

SYSTEM INTEGRITY
X! Page Action Print!

HWY : 0 LOG : OFF 12-APR-1990 15:46:30 Header

POLLING HWY 0 DEV 2

LOCAL AREAS NETWORK DEVICES

ACT ACT STB STB
COMPOSITE PRI SEC DEV PRI SEC PRI SEC
AREA INTEGRITY COMM COMM # TYPE INTEG COMM COMM COMM COMM

1 BAD GOOD BAD 1 SIU BAD GOOD BAD

2 BAD BAD BAD 2
3 3 Body
4 BAD GOOD BAD 4
5 5
6 6
7 BAD GOOD BAD
8 BAD GOOD BAD
NET GOOD GOOD BAD

Figure 13-4 System Integrity Display

The following paragraphs describe the work area of the system integrity
13 display. The work area is similar on all displays.
J Header — The header includes the time, date, title, and page number.
The header also indicates which device the utility is currently polling.
J Body — This portion of a display page contains the diagnostic
information specific for the display.

Note
The status word BAD does not necessarily mean
the device or highway is defective. It may mean
that the device has not been configured, or that
the device has not been selected on an associated
highway interface device (for example, the SIU).

UM6.1:SW3151 Revision H — July 1996

 Using the Diagnostics Utility 13-9

The following subsections describe the general types of diagnostics

displays.

13.4.1 System Integrity Display

The system integrity display shows the status of different devices on the
network highway. To obtain the display, start at the Diagnostics Executive
form. In the form, select:

1. System Integrity

The system integrity display appears. Figure 13-4 is an example of a

system integrity display.

13.4.2 Local Area Integrity Display

The local area integrity display shows the status of any of the local
highway devices. To navigate to the local area integrity display, do the
following:

Step 1: In the Diagnostics Executive form, select:

2. Local Area Integ.

A subform appears at the bottom of the Diagnostics Executive

form.

Step 2: In the subform, enter the highway number (1 through 8), and
press Return. The local area integrity display appears.

X!

ENTER HIGHWAY NUMBER (1-8) : __ 13

Figure 13-5 shows an example of a local area integrity display.

Revision H — July 1996 UM6.1:SW3151

 13-10 Using the Diagnostics Utility

LOCAL AREA INTEGRITY

X! Page Action Print!
HWY : 1 LOG : OFF 12-APR-1990 15:46:30
POLLING HWY 1 DEV 2
DEV ACT ACT STB STB DEV ACT ACT STB
# TYPE INTEG PRI SEC PRI SEC # TYPE INTEG PRI SEC PRI
1 ??? 16 ???
2 ??? 17 UOC GOOD GOOD GOOD
3 OPCON GOOD GOOD GOOD 18 UOC GOOD GOOD GOOD
4 OPCON BAD GOOD BAD 19 UOC BAD GOOD GOOD
5 SIU GOOD GOOD GOOD 20 IFC GOOD GOOD GOOD
6 ??? 21 ???
7 ??? 22 ???
8 ??? 23 ???
9 ??? 24 ???
10 UOC BAD GOOD BAD 25 PCIU BAD GOOD GOOD
11 UOC GOOD GOOD GOOD 26 CHIP GOOD GOOD GOOD
12 ??? 27 ???
13 ??? 28 MCU GOOD GOOD GOOD
14 ??? 29 DCU GOOD GOOD GOOD GOOD
15 ??? 30 ???
LTD/BRIDGE GOOD GOOD BAD

Figure 13-5 Local Area Integrity Display

13.4.3 Device Integrity Displays

Some devices have a single integrity display and some have multiple
integrity displays. Selecting a device with a single integrity display calls up
the display. Devices with one integrity display are:

13 J Highway interface unit (HIU)

J Computer/Highway Interface Package (CHIP)

J Network traffic director (NTD)

J Local traffic director (LTD)

Selecting a device with multiple displays calls a submenu for the displays.
Figure 13-2 shows these submenus and their related devices.

To navigate to a device integrity display, do the following:

Step 1: In the Diagnostics Executive form, select:

3. Device Integrity

A subform appears at the bottom of the Diagnostics Executive

form.

UM6.1:SW3151 Revision H — July 1996

 Using the Diagnostics Utility 13-11

Step 2: In the subform, enter the highway number (1 through 8), and
press Return. Another line appears in the subform.

X!

ENTER HIGHWAY NUMBER (0:NETWORK, 1-8:LOCAL) : __

Step 3: In the additional line, enter the local device number (0 through
30), and press Return. If the device contains multiple display
calls, a form appears in the work area showing a submenu
which provides you with further options selections. Otherwise,
the device integrity display appears.

X!

ENTER HIGHWAY NUMBER (1-8) : __

ENTER LOCAL DEVICE NUMBER (0-30) : __

Step 4: If a form appears showing a submenu, select the desired

option using the mouse or cursor keys, and press Return. Or,
enter the number of the option you want. The device integrity
display appears.

DIAGNOSTICS - UOC
X! Print!

@Copyright Fisher Controls 1980, 1993

13
1. UOC Integrity
2. I/O Status
3. Ctrl Unit Para.
4. Card Types

Revision H — July 1996 UM6.1:SW3151

 13-12 Using the Diagnostics Utility

Figure 13-6 shows an example of a device integrity display for a unit

operations controller (UOC).

UOC INTEGRITY
X! Page Action Print!

HWY : 8 DEV : 15 LOG : OFF 12-APR-1990 15:46:30

POLLING HWY 0 DEV 2
STATUS INDICATOR STATUS ADDIONAL STATUS
INDICATIONS
Primary CIA GOOD : OK
Secondary CIA GOOD 00 = MPU : OK
Memory GOOD 10 = CIA1 : OK
I/O drive GOOD 20 = CIA2 : OK
User config AVAILBL 30 = OFF BOARD MEMORY : OK
I/O config INVALID 40 = I/O DRIVE : INVALID
SIMPLEX/PRI/SEC SIMPLEX 45 = I/O DRIIVE CARD CFG : INVALID
Active state CONFIGD(C) 46 = I/O DRIVE CARD STATUS : OK
Auto switch N/A 50 = SERIAL LINK
Standby MPU N/A
Standby I/O drive N/A
Standby state N/A

Figure 13-6 Device Integrity Display

13

UM6.1:SW3151 Revision H — July 1996

 Using the Diagnostics Utility 13-13

13.4.4 Device Revision Information Displays

The device revision displays provide the revision levels of some of the
device on the highways, not all devices support the revision information
display.

To navigate to a device revision display, do the following:

Step 1: In the Diagnostics Executive form, select:

4. Device Rev. Info.

A form appears showing a submenu in the work area which

provides you with further options selections.

Step 2: In the submenu, select the desired option using the mouse or
cursor keys, and press Return. Or, enter the number of the
option you want. A subform appears at the bottom of the form.

DIAGNOSTICS - UOC
X! Print!

@Copyright Fisher Controls 1980, 1993

1. All Dev In System

2. All Dev In Area
3. Single and Subdev
4. Single or Subdev

Step 3: In the subform, enter P for printer, S for screen, or F for file
13
depending on where you want to view the revision information,
and press Return. The revision information display appears.

X!

OUTPUT TO (P)RINTER, (S)REEN, OR (F)ILE : _

Revision H — July 1996 UM6.1:SW3151

 13-14 Using the Diagnostics Utility

Figure 13-7 shows an example display. Since the display has several
pages, use the Page menu to view more device revision information.

Device Revision Information

X! Page Action Print!
Next LOG : UNAV 12-APR-1990 15:46:30
** LOCALPrevious
Main
@0-0
NTD - REVISION INFORMATION REPORTING NOT SUPPORTED

@0-1
CHIP
SOFTWARE RELEASE 11B8542 P3.1

** LOCAL AREA 1 **

@0-1
LTD - REVISION INFORMATION REPORTING NOT SUPPORTED

@1-3
PROVUE(R) CONSOLE SIMPLEX
SOFTWARE RELEASE 12B1286X032 P5.2

Figure 13-7 Device Revision Display

13

UM6.1:SW3151 Revision H — July 1996

 Using the Diagnostics Utility 13-15

13.4.5 Traffic Statistics Displays

Traffic statistics displays provide information for network and local area
highways. For each device on the highway that you select, the utility
shows the number of data packets received and sent by the LTD, and all
the packets sent by the LTD, but not received by the device.
To obtain the traffic statistics display:
Step 1: In the Diagnostics Executive form, select:
5. Traffic Statistics
A subform appears at the bottom of the Diagnostics Executive
form.
Step 2: In the subform, enter the highway number (0 for network) or
(1 through 8 for local), and press Return.

X!

ENTER HIGHWAY NUMBER (0:NETWORK, 1-8:LOCAL) : __

The system integrity display appears. Figure 13-8 is an example of a

traffic statistics display.

LTD TRAFFIC STATISTICS

X! Page Action Print!
HWY : 1 LOG : OFF 12-APR-1990 15:46:30
POLLING HWY 1 DEV 0
DEV PKTS RCVD BUSY DEV PKTS RCVD BUSY DEV PKTS RCVD BUSY
# RCVD SENT SENT # RCVD SENT SENT # RCVD SENT SENT

1 2 2 0 11 2 2 0 21 4 4 0
13
2 0 0 0 12 0 0 0 22 0 0 0
3 0 0 0 13 0 0 0 23 0 0 0
4 0 0 0 14 3 3 0 24 0 0 0
5 0 0 0 15 0 0 0 25 2 2 0
6 0 0 0 16 0 0 0 26 0 0 0
7 0 0 0 17 0 0 0 27 0 0 0
8 0 0 0 18 0 0 0 28 0 0 0
9 0 0 0 19 0 0 0 29 0 0 0
10 0 0 0 20 0 0 0 30 0 0 0

LTD TO LOCAL HWY PKTS : 10 GLOBAL NETWORK TO LTD PKTS : 0

LTD TO NETWORK HWY PKTS : 0 NON GLOBAL NETWORK TO LTD PKTS : 0
GLOBAL LOCAL HWY TO LTD PKTS : 0 LOCAL TO OUTPUT QUEUE SIZE : 0
NON GLOBAL LOCAL HWY TO LTD PKTS : 0 NETWORK TO OUTPUT QUEUE SIZE : 0
STATISTICS INTERVAL (MSEC) : 1000 AVERAGE SCAN TIME (MSEC) : 100

Figure 13-8 Traffic Statistics Display (for an LTD)

Revision H — July 1996 UM6.1:SW3151

 13-16 Using the Diagnostics Utility

13.4.6 Unsolicited Data Control Displays

The unsolicited data control display indicates whether or not each device
in the area is available to receive unsolicited data from a device in
another local area. To navigate to the unsolicited data control display, do
the following:

Step 1: In the Diagnostics Executive form, select:

6. Unsolicited Data

A subform appears at the bottom of the Diagnostics Executive

form.

Step 2: In the subform, enter the highway number (0 for network, 1

through 8 for local), and press Return. The unsolicited data
control display appears.

X!

ENTER HIGHWAY NUMBER (0:NETWORK, 1-8:LOCAL) : __

Figure 13-9 is an example of an unsolicited data control display.

UNSOLICITED DATA CONTROL

X! Page Action Print!
HWY : 1 LOG : OFF 12-APR-1990 15:46:30

DEV ACT STB DEV ACT STB DEV ACT STB DEV ACT STB LTD
# P S P S # P S P S # P S P S # P S P S AFC STATUS
13 1 0 9 0 17 0 25 0
2 0 10 0 18 0 26 0
3 0 11 0 19 0 27 0
4 0 12 0 20 0 28 0
5 0 13 0 21 0 29 0
6 0 14 0 22 0 30 0
7 0 15 0 23 0 LTD 0
8 0 16 0 24 0 --- NEW

0 = AVAILABLE, 1 = BUSY
LTD NEW = SUPPORTS ADVANCED FLOW CONTROL, OLD = DOES NOT
r = REDUNDANT

Figure 13-9 Unsolicited Data Control Display

UM6.1:SW3151 Revision H — July 1996

 Using the Diagnostics Utility 13-17

13.5 Logging Diagnostic Displays

The diagnostics utility can log changes of displayed dynamic fields to a
system printer. Each display which has the Action menu in the menu bar
can perform the logging function.

To turn on the logging feature, select the Action menu in the first display
to obtain the pull-down menu. Select Logging in the pull-down menu.
Logging remains on until you either exit the diagnostics utility or you again
select Logging, which toggles it off. Calling up different displays does not
change your selection; the logging state remains as last set.

As the activity of highway devices changes, a log file of the changes is

created. Logging occurs only for the display being shown. All pages of
multiple displays, however, are logged together. Exiting from the
diagnostics executive menu sends queued log messages to the printer.

In addition to being sent to the printer, the log file is stored as a file (with a
date stamp) in the users home directory, These files are deleted every
seven days by the ENVOX cleanup process.

13

Revision H — July 1996 UM6.1:SW3151

 13-18 Using the Diagnostics Utility

This page intentionally left blank.

13

UM6.1:SW3151 Revision H — July 1996

 Documenting the Database 14-1

Figure 14-Table 14

14 Documenting the Database

ENVOXr configuration software provides an effective means of querying
the relational database and documenting its data and data relationships in
a variety of report formats. These reports provide information about point
configuration, target data, plant process areas (PPAs), plant management
areas (PMAs), instrument signal tags, and so forth.

This section describes the standard ENVOX report building features. In

addition to these features, refer also to the utilities available in ENVOX
software. For VMS machines, see the supporting ZZ_README.DOC file
located in ENVOX$DISK:[ENVOX.UNSUPPORTED_UTILITIES] . For
UNIX machines, look for the zz_readme.doc file located in the
$ENVOX/unsupported_utilities directory.

14.1 Requesting a Report

Report forms are available from the Document form. To access the
Document form, select the Document option from the More menu on the
ENVOX Top Level Form.

ENVOX TOP LEVEL FORM

X Add Modify! More Status!
Utilities More Help

Generate
Download
Document
->
14
Upload
Diagnostics
IAC Trace/Tune
LCP Trace/Tune
Administration
Dbase Management ->
Audit Trail

Revision H — July 1996 UM6.1:SW3151

 14-2 Documenting the Database

The software displays the Document form and prompts you to make a
menu selection. Figure 14-1 shows the menu bar of the form.

DOCUMENT
X! Detail Summary Cross-Ref Other Help

Please Pick the document action from the menu.

Figure 14-1 Example of Document Form

The menus in the menu bar provide pull-down and slide-off menu options
that access various report formats. Subsection 14.2 describes the reports
associated with each menu option. To request a report, select the form
you want, fill out the form, then exit and run the report. Figure 14-2 is an
example of a specific summary report form.

The form appears with the cursor in the first field. To make selections for
each field:

Step 1: Use the arrow keys to move the cursor to the desired choice.

Step 2: With the cursor on the desired choice, press Return..

14 Step 3: Press Tab to move to the next field.

Exit and select the Run option to run the report.

When documenting incomplete items, it is sometimes necessary for the

software to indicate null values, unreferenced items, and items that
contain invalid references. In general, the software displays a blank in
these situations. However, where a blank would be misleading, some
other value appears, such as $null or $wrong.

UM6.1:SW3151 Revision H — July 1996

 Documenting the Database 14-3

2 1

DEVICE TARGET POINTS

X! Ad Hoc Tag Set! Help

This action summarizes the points targeted to a device.

You may select the device(s) as follows:
3
(1) one specified device tag;
(2) a set of device tags defined by a specified tag set;
(3) all targetable devices in your database.

Data Selection: One-Device Tag-Set

Tag-Set All-Devices 4
Enter tag of tag set v :

Results order #1: Device-Tag

Device-Tag As-Tag-Set
5
#2: Point-Index Point-Tag Src-Dev/Pnt-Type/Tag

Output Device: File Printer Screen 6

Figure 14-2 Example Document Form

The following information describes the numbered areas of the form:

1. Form name — The same title as the menu option from which you
selected the form.

2. Ad Hoc Tag Set! menu option — Allows creation of a tag set of

items for use by the report.

3. Form Description — Summarizes the associated report and defines

the choices for the Data Selection field.

4. Data Selection — Determines the scope of the data that the report 14
will contain. This selection may be for a specific device or point, for all
devices or points, and so on. Table 14-1 (located at the end of this
section) defines the possible choices for this field. The selections are
in a visible choice field and depend on the report. Some reports have
only one selection.

Revision H — July 1996 UM6.1:SW3151

 14-4 Documenting the Database

5. Results Order — The order of the output data. Example results order
choices include: by device tag, by device type then by tag, by tag set,
by point tag, and so on. Table 14-2 (located at the end of this section)
defines the possible choices for this field. The selections are in a
visible choice field and depend on the report. Some reports have only
one selection.

6. Output Device — The destination for the output data. Selections are
in a visible choice field and are File, Printer, and Screen.

If you choose File, the software prompts you for the file name. When
you specify a file name, you must also specify a directory reference;
otherwise, the file goes to the default directory. The file is in ASCII
format.

If you choose Printer, the printer file goes to the printer queue, from
which the file is printed.

If you choose Screen, the report is quickly scrolled on the screen so

that you can check the basic format. To stop and start the scrolling,
use your keyboard screen-hold key.

14.2 Report Descriptions

The subsections that follow describe the content of each report.

14.2.1 Detail Reports

There is one report type under the Detail menu: Form-Style. Form-Style
reports are similar in appearance to the configuration forms in the
software. These reports include all configuration data that would be found
on the associated main configuration form and extra data forms. For
forms with group fields, the form image is repeated to accommodate all
the data in the field. For nonforms entry items such as FSTs, the output is
14 in the format of the instruction editor.

UM6.1:SW3151 Revision H — July 1996

 Documenting the Database 14-5

14.2.2 Summary Reports

The Summary menu options offers you a choice of eight reports,
described as follows:

Highway-Devices — Highway-devices forms summarize data for

highway devices. The data include the highway addresses, the device
tags, the device types, the variants (when applicable), the descriptions,
and the comments.

Device-Configuration — Device-configuration reports summarize the

configured items for specified devices. This report is particularly useful for
devices that have large point counts; for example, SR90 and SRx
controllers and operator consoles. The data include the device tags and
item types. For each item type, the report includes the number of this item
type defined, the configured limit, and the maximum allowable for this
device. ISTs and FSTs data are not included.

Device-Target-Points — Device-target-points reports summarize the

points targeted to specified devices. This report is meaningful for operator
consoles, controllers, CHIP, and trend devices. The data include the
target device, the target type (20 Series/SR90 devices), the point index,
the point tag, the point type, and the source device.

Point-Reporting — Point-reporting reports summarize point-to-device

reporting by listing the source and target devices for specified points. The
data include the point tag, the point type, the source device, and the
target device.

Point-Information — Point-information reports provide configuration

data for specified points. The data include the point tag, the point type,
the source device, the point index number, the point description, and the
strategy.

Display-Summary — Display-summary reports summarize all displays in

the database. The data include the display tag, the number of display 14
elements, and the date last modified.

Display-Content — Display-content reports summarize all references in

specified operator console displays. Console displays typically reference
points: tag, attribute, and occurrence. The data include the display name,
the referenced item, the X,Y coordinates and the element type. Most
display elements have only one reference (the primary reference). Where
a display element has two references (primary and secondary), both
references appear in the report.

Display-List — Display-list reports list the displays for specified operator

consoles, identifying each display in the configuration for this specific
console. The data include the device tags, display numbers, display tags,
and each display’s forward and backward display references.

Revision H — July 1996 UM6.1:SW3151

 14-6 Documenting the Database

14.2.3 More Summary Reports

Eight additional summary reports are located under the More slide-off
option menu of the Summary menu options. These reports are described
as follows:

Trend-Information — Trend-information reports summarize trend

information for specified operator consoles. The data include the device
tag and initially configured trend sets. Trend set data include the trend
trace points and their low and high scale values, the trace type, and the
interval.

Alarm-Priorities — Alarm-priorities reports summarize the alarm

priorities. The data include all the alarm priority items in the database,
priority levels for acknowledged and unacknowledged states, horn and
message characteristics, and the active foreground and background
colors.

PPA-States — PPA-states reports summarize plant process states and

corresponding alarm priorities for selected PPAs. The data include the
PPA tags, associated groups, and priority tags for each state.

Plant-Area-List — Plant-area-list reports list all PMAs for specified

operator consoles. The data include the device tags and associated PMA
tags. For each PMA, the data include the PPA tags and their associated
points and point descriptions.

Plant-Area-PMAs — Plant-area-PMAs reports list all PMAs and their

associated alarm displays for specified operator consoles.

Plant-Area-Points — Plant-area-points reports list the database index

(DBI) and tag of each point targeted to specified operator consoles and
relates each point to its alarm display and to the PPA to which it belongs

Plant-Area-PPAs — Plant-area-PPAs reports list all PPAs used by

specified operator consoles and relates each PPA to its associated alarm
display.
14
User-Information — User information reports describe the scope of
access, privileges, and functionality available to a particular console
operator as represented by a User Definition item.

UM6.1:SW3151 Revision H — July 1996

 Documenting the Database 14-7

14.2.4 Cross-Ref Reports

There are five reports under the Cross-Ref menu. The descriptions that
follow identify the contents of each Cross-Ref report.
Template-Usage — Template-usage reports provide a cross-reference of
DCD and group templates, and the database items that reference them.
The data include template tag and type. For each template, the data
include the referencing item tags, their type and source devices.
Item-Usage — Item-usage reports provide the references to specified
points by any item in the database. The data include the point tag and
type, and the tags and types of all the items that reference the point.
Logic-References — Logic-references reports list points referenced by
specified host-logic items. The data include the logic item tags and type,
and the tags and types of the associated referenced items.
Points-Without-DSR — Points-Without-DSR reports list points that do
not have a direct screen reference (DSR). That is, this report lists points
targeted to the device that do not appear in a DSR element on any
display in the display list for the consoles. The data include the console
device tags, the point tags and types, and the associated display tag.
Input-Output Usage — Input-output usage reports provide a
cross-reference of instrument signal tags and file-card-channel values for
devices you specify. The data include the device tag, the FCC, the
associated instrument signal tag (IST), the points that reference the IST,
the displays that reference the points, the point DSR and the point X,Y
coordinates.

14.2.5 Other Reports

Operation-Indices — Operation-indices reports list the operations on a
UOC/SR90/SRx device and the index numbers generated for them by the
ENVOX system. For each device, the data includes the device tag,
operation index, and the operation tag.
14
Download-Information — Download-information reports list the
database items marked as applicable to the next download to a
UOC/SR90/SRx device. The report indicates whether a partial download
is allowed by the ENVOX configuration system. It must be remembered
that events in the on-line system can override this indication. For each
device, the data includes the device tag, the download item type, the item
index number, and the corresponding item tag or a deleted indication.
Highway-Access — Highway-access reports document the Highway
Access Control List (HACL), the system-wide list used to assign a unique
index number to each point. An index number allows a point to be
addressed without ambiguity in online communication between different
highway devices. The report allows users to view and print the list and to
easily find the index numbers of points of interest.

Revision H — July 1996 UM6.1:SW3151

 14-8 Documenting the Database

Table 14-1 Document Data Selection Choices

Choice Uses Data ...
All-Alarm-Priorities From all alarm priority items in the database
All-Devices From all applicable devices in the database
All-Displays From all displays in the database
All-Items From all applicable items in the database
All-Points From all applicable points in the database
All-PPAs From all PPAs in the database
All-Templates From all DCD and group templates
All Usernames From all user names in the database
For-Device From the device, you specify all of the points sourced to
it, or other items referenced by it.
Item-Type From all items of the type you specify
One-Device From the device you specify
One-Display From the display you specify
One-Item Associated with the item you specify
One-Point From the point you specify
One-PPA From the PPA you specify
One-Template From the DCD or group template you specify
One Username From the user name you specify
Point-Type From all the points of the type you specify
Tag-Set From each applicable item or display in the tag set you
specify

Table 14-2 Document Results Order Choices

Choice Sorts by ...

14 Alarm-Priority-Tag
As-Tag-Set
Alarm priority tag
Item, display, or PPA tag based on the order in the tag
set you specified in the data selection field
DBI-Num Point database index number
Device-Tag Device tag
Device-Type/Tag Device type — sort each type by tag
Display-Num Display number
Display-Tag Display tag
FCC/Point/Display File-card-channel — sorts each FCC by point, sorts each
point by display name
Group-Num Group number
Highway-Address Highway number — sorts each highway by device
number, then by port where applicable

UM6.1:SW3151 Revision H — July 1996

 Documenting the Database 14-9

Table 14-2 Document Results Order Choices (Continued)

Choice Sorts by ...
Item-Tag Item tag
Item-Type/Tag Item-type — sort each type by tag
Item-Type/Index UOC download item type — sorts each type by item
index number
Operation-Index Operation index number
PMA PMA in sequence(1) for the device you specify
PMA/PPA/Point-Tag PMA in sequence(1), sorts each PMA by PPA in
sequence(1), sorts each PPA by point tag
Point-Index Point index number(2)
Point-Tag Point tag
Point-Tag/Dsp-Tag Non-DSR point tags — sorts each point tag by host
display tag
Point-Type/Tag Point type — sorts each point type by tag
PPA-Num PPA number
PPA-Tag PPA tag
Referenced-Item The string that represents the referenced item(3)
Refg-Item-Tag Referencing item tag
Refg-Item-Type/Tag Referencing item type — sorts each type by tag
Ref-No Reference number of a point — lets a user order the
Highway Access Report by reference number.
Src-Dev/Pnt-Type/Tag Source device tag — sorts each source device by point
type, sorts each point type by point tag
Template-Tag Template tag
Tgt-Dev-Tag The target device tag
Trend-Set/Trace-Pnt Trend sets in sequence(1) for the device — sorts each
trend set by trace-point sequence(1)
Username Username in the database
X-Y-Coords Screen X, Y coordinates 14
1. This is the logical sequence, not tag order.
2. For UOC points, the point index number is equivalent to a point type and a relative point
index number.
3. The string that represents a referenced item typically consists of a tag, an attribute and an
occurrence number. For the Referenced-Item choice, referenced items appear in ascending
order of: tag, attribute, and occurrence.

Revision H — July 1996 UM6.1:SW3151

 14-10 Documenting the Database

This page intentionally left blank.

14

UM6.1:SW3151 Revision H — July 1996

 Creating Audit Trail Reports 15-1

Figure 15-Table 15

15 Creating Audit Trail Reports

The Audit Trail facility is an ENVOXr feature that records changes made
to the ENVOX database and to the system where the database resides.
The facility also records when the changes were made and who made
them. Often, this change control is important from both safety and
regulatory perspectives (EPA, OSHA, FDA, and so on).

The changes which the Audit Trail facility tracks are called events. An
event is any addition, modification, deletion, or other action performed by
a user including downloads, uploads, exports, imports, and database
administrative functions.

When the Audit Trail facility is turned on, selected data about each event
is collected and placed in a log. You can then view this information
on-line, or create summary or detailed history reports about selected
events for a specified time period.

15.1 Creating Reports

Your system manager sets up and maintains the audit trail. The System
Manager’s Guide to ENVOX Configuration Software, SM1.0:SW3151,
provides detailed information on how the audit trail works and how it is set
up and maintained.

Once the system manager has set up the audit trail and data exists in the
log, you can specify which events to retrieve from the log and then display
and print summary or detailed information about the retrieved events. The
three Audit Trail reporting forms are:

J Audit Trail Search

15
J History Summary

J Event Detail

Figure 15-1 shows the Audit Trail Search form. To access this form, select
More ® Audit Trail from the ENVOX Top Level form menu. Use the form
to specify search criteria the system uses to retrieve event records. The
options in the upper-window menu enable you to perform various
reporting tasks. The search criteria and options are described fully in
subsections 15.1.1 and 15.1.2.

Revision H — July 1996 UM6.1:SW3151

 15-2 Creating Audit Trail Reports

AUDIT TRAIL SEARCH

X! Count! Retrieve! Print Event No.! Help

Date From: Space Used 25.3 Mb

Date To: Events recorded 623145

Event Type v: Log start date 23-Jun-1992

Tag v:

Username v:

Program v:

Device v:

Item Type v:

EV122

Figure 15-1 Example of Audit Trail Search Form

You also use the Audit Trail Search form to access the History Summary
and Event Detail forms. The History Summary form displays summary
information about selected events. The Event Detail form displays all
available information about a particular event. These forms are described
in detail in subsections 15.1.3 and 15.1.4.

Along with the search fields, the Audit Trail Search form displays
view-only status information including the amount of space the log file is
using (in megabytes), the total number of events currently recorded in the
log, and the date of the earliest recorded event.

15.1.1 Search Criteria

There are eight search criteria fields you can use to specify which event
15 records to retrieve from the Audit Trail log. You may enter values in some
or all of the fields. However, to limit the the number of records retrieved,
fill in as many fields as possible. If you do not specify search criteria, all
records in the log are retrieved (up to the system limit). Depending on
how many records exist, the search can use a lot of system resources
and slow down system response time.

UM6.1:SW3151 Revision H — July 1996

 Creating Audit Trail Reports 15-3

15.1.1.1 Date From and Date To

Use these fields to specify a range of time for the system to use when
searching for records. If you specify:

J Both a begin and end date, only those records between the two dates
are retrieved

J No begin or end dates, all records in the log are retrieved (if no other
search criteria is specified)

J Date From only, records recorded after the specified date are
retrieved

J Date To only, records before the specified date are retrieved

The format for the time is:

DD--MMM--YYYY HH:MM

If you do not enter hours and minutes, the time defaults to 00:00 in the
Date From field and to 23:59 in the Date To field.

15.1.1.2 Event Type

The Event Type field enables you to specify the type of event to retrieve.
You normally only specify a value in the Event Type field if you want to
retrieve less common event type records. Most events are of the type
MODIFY ITEM, and a better way to narrow your search is to use the Tag
field instead (see subsection 15.1.1.3). Table 15-1 lists examples of event
types. For a complete list of all of the available event types, press the
Values List key.

Table 15-1 Some Event Types

ADD ITEM ARCHIVE LOG BACKUP DATABASE
BACKUP TO ED COPY FROM DATABASE COPY TO DATABASE
DELETE ITEM DOWNLOAD DEVICE DUMP DATABASE
EXPORT GENERATE DEVICE IMPORT 15
LOAD DATABASE MODIFY DATABASE MODIFY ITEM
OPEN DB POPULATE OPEN DB SYNC RESTORE DATABASE
TRUNCATE LOG UPLOAD

Revision H — July 1996 UM6.1:SW3151

 15-4 Creating Audit Trail Reports

15.1.1.3 Tag
Use the Tag field to retrieve events directly concerned with the specified
item (for example, events about changes to a configuration item or
operations performed on a device). You cannot use this field to retrieve
events which indirectly reference the item.

For example, if the DCD point template tag is updated, then a MODIFY
ITEM event type is recorded. The item tag would be the DCD point tag
and, if Field Update Recording was enabled, the template tag would also
be recorded as extra information for the same event. The event details
would be retrievable using the Audit Trail Search form by entering the
DCD point tag in the Tag field, but it would not be possible to retrieve the
event details by entering the template tag.

You can use standard SYBASE wildcard characters when specifying a

tag, but you may specify only the start of the tag. For example, XXX% is
valid, but %XXX is not.

15.1.1.4 Username and Program

The Username field enables you to retrieve event records based on the
name of the user who requested an event (which can be either the login
name, username, or client username). The Values List key displays a list
of valid usernames.

You can also specify the name of the program that requested an event
with the Program field. The Values List key displays a list of valid program
names.

15.1.1.5 Device
The Device field enables you to specify a device affected by the events
retrieved. This field is only useful if the system manager sets field update
recording to YES. The Values List key displays a list of valid device
names.

15 15.1.1.6 Item Type

In the Item Type field, you can enter an item type; all events directly
concerned with items that are of that type are retrieved. The Values List
key displays a list of valid item types.

UM6.1:SW3151 Revision H — July 1996

 Creating Audit Trail Reports 15-5

15.1.2 Audit Trail Search Form Options

The four Audit Trail Search form options in the upper-window menu
enable you to perform various reporting tasks. They are Count!, Retrieve!,
Print, and Event No.!. The following four subsections describe each of
these options in detail.

15.1.2.1 Count!
When you request a search, you do not know the number of records that
will be retrieved. It may take several minutes to retrieve several thousand
records. The Count option enables you to find out how many event
records qualify for retrieval based on the search criteria you specified
without actually retrieving them.
When you select the Count option, a window pops up showing the
number of qualifying event records.

NUMBER OF RECORDS

X! Retrieve! Help

17 events would be retrieved

EV167

You may exit from this pop-up form and modify the search criteria. You
can also select the Retrieve option from the form. This option functions
identically to the Retrieve option on the Audit Trail Search form described
in the next subsection.

15.1.2.2 Retrieve!
The Retrieve option retrieves events records based on the search criteria
you entered on the Audit Trail Search form. When you select this option,
a window pops up showing the History Summary form, which shows the 15
retrieved records in summary format. For a detailed explanation of the
History Summary form, refer to subsection 15.1.3.
Note that if the number of records you are requesting is greater than the
preset limit (set by your system administrator), then a Confirm form
displays. If you select CONFIRM, depending on how many records are
being retrieved, the retrieval may take a few minutes and may slow the
system down.
If the number of records you are requesting exceeds 9999, an error
message is displayed. You must enter more restrictive search criteria to
reduce the number of records to be retrieved.

Revision H — July 1996 UM6.1:SW3151

 15-6 Creating Audit Trail Reports

15.1.2.3 Print
The Print option enables you to send the information you retrieved to a
printer or to a file. You can print Audit Trail reports in a summary or detail
format. When you select the Print option, a sub-menu displays the
following:

AUDIT TRAIL SEARCH

X! Count! Retrieve! Print Event No.! Help

Add to Batch - >

Now ->
Execute Batch ->
EV168

From this sub-menu, you select a print action. The print actions include:
J Add to Batch — When you select this option, the system displays a
sub-menu where you choose the report type, Summary or Detail.
After you select the report type, the print request is sent to an
intermediate queue. To then submit the job to the default batch print
queue, you must choose the Execute Batch print option.
J Now — When you select this option, the system displays a sub-menu
where you choose the report type, Summary or Detail. After you
select the report type, the system collects the information, formats the
data in the requested format, and submits the job to the default print
queue. This option is useful when you are printing a small amount of
data and require the results immediately.
J Execute Batch — The system displays a sub-menu where you
choose the output medium, Printer or File.

The Printer option sends all prints requests in the intermediate

queue to the default batch print queue. The jobs in the
15 intermediate queue are processed as a single job in the order in
which they are requested.

The File option places the report in a text file. When you select the
File option, a form displays prompting you for a file name. The
default file name is AUDIT_TRAIL.OUT for VMS machines and
audit_trail.out for UNIX machines. The file name is placed in the
SYS$SCRATCH directory on VMS machines and the current
user’s home directory for UNIX machines.
When creating a filename on a UNIX machine, do not use
characters that have special meaning in UNIX shell scripts
because the operating system may not create the file name

UM6.1:SW3151 Revision H — July 1996

 Creating Audit Trail Reports 15-7

correctly. For example, the dollar sign character ($) in a file name
can cause the operating system to ignore the characters that
follow the $ because this character denotes the beginning of an
environment variable. The operating system would therefore
interpret the file, audit$search, as audit.

Note that if the number of records you are requesting to print is greater
than the preset limit (set by your system administrator), then a Confirm
form displays to warn you that a large number of records will be printed.

15.1.2.4 Event No.!

Usually, you will not know the event number assigned to the event by the
Audit Trail facility. If you do, however, you can use the Event No. option to
enter a specific event number.

When you select the Event No. option, a window pops up showing the
number of the most recent event.

ENTER EVENT NUMBER

X! Help

Event Number: 3839

EV169

You can type over the default event number and enter the number of the
event in which you are interested. If the event number you entered is
valid, the system displays the Event Detail form, which shows full details
about the specified event. For a detailed explanation of the Event Detail
form, refer to subsection 15.1.4.

15

Revision H — July 1996 UM6.1:SW3151

 15-8 Creating Audit Trail Reports

15.1.3 The History Summary Form

You access the History Summary form from the Audit Trail Search form
using either the Retrieve option or the Count option. This form (see
Figure 15-2) displays summary information about the events you
retrieved. You also use this form to access the Event Detail form, which
displays detailed information, if it exists, about a selected event.

HISTORY SUMMARY
X! Detail! Print Help

Number of Records 335

Date/Time Username Description

Figure 15-2 History Summary Form

The information on the form is displayed chronologically in a tabular

format, one row per event. You can scroll down and up using the scroll
icons if there is more than one screenful of data. Fields on this form are:
J Date/Time — The date the event was recorded.
J Username — The name of the user (which is the SYBASE login
name) who requested the event.
J Description — A textual description of the event.
The Find Row key lets you find all occurrences of any text string
15 (including tags, keywords, or multiple-word strings) within the summary.
To find the occurrences, you must add a percent (%) character to the start
and end of the string you are searching for (for example, %DEVICE%).
Two options are available in the upper-window menu: the Detail option
and the Print option.

15.1.3.1 Detail Option

The Detail option enables you to view detailed information about a
selected event. To view an event’s detail, place the cursor on a particular
event and select the Detail option. The system displays the Event Detail
form. The Event Detail form is described in subsection 15.1.4.

UM6.1:SW3151 Revision H — July 1996

 Creating Audit Trail Reports 15-9

15.1.3.2 Print Option

The Print option enables you to send the information you are viewing to a
printer or to a file. This option is nearly identical to the Print option on the
Audit Trail Search form. When you select the Print option, a sub-menu
displays:

HISTORY SUMMARY
X! Detail! Print Help

Add to Batch - >

Now ->
Execute Batch ->
EV170

From this sub-menu, you select a print action. The print actions include:
J Add to Batch — This option sends the print request to an
intermediate queue. To then submit the job to the default batch print
queue, you must choose the Execute Batch print option.
J Now — The system submits the job to the default print queue. This
option is useful when you are printing a small amount of data and
require the results immediately.
J Execute Batch — The system displays a sub-menu where you
choose the output medium, Printer or File.

The Printer option sends all prints requests in the intermediate

queue to the default batch print queue. The jobs in the
intermediate queue are processed as a single job in the order in
which they are requested.

The File option places the report in a text file. When you select the
File option, a form displays prompting you for a file name. The
default file name is AUDIT_TRAIL.OUT for VMS machines and
audit_trail.out for UNIX machines. The file name is placed in the
15
SYS$SCRATCH directory on VMS machines and the current
user’s home directory for UNIX machines.
When creating a filename on a UNIX machine, do not use
characters that have special meaning in UNIX shell scripts
because the operating system may not create the file name
correctly. For example, the dollar sign character ($) in a file name
can cause the operating system to ignore the characters that
follow the $ because this character denotes the beginning of an
environment variable. The operating system would therefore
interpret the file, audit$search, as audit.

Revision H — July 1996 UM6.1:SW3151

 15-10 Creating Audit Trail Reports

15.1.4 The Event Detail Form

You can access the Event Detail form (see Figure 15-3) one of two ways:

J From the Audit Trail form using the Event No. option.

J From the History Summary form using the Detail option.

EVENT DETAIL
X! Print Previous! Next! Help

Event No. 22-SEP-1994 04:54:30.23

Description

Program Name Login Name

Image Name Username
Host Name Client Username
Process Type Function

EV124

Figure 15-3 Event Detail Form

This form displays several pieces of information. The top two lines on the
form display the event number, the date and time the event took place,
and a description of the event. The next eight fields display information
about the user, the program, and the host machine.

15 The remainder of the form is parameter information associated with the

event. You can scroll up and down in the form if there is more than one
screenful of data. This data can include:

J Job number — The number of the job in the job queue for batch
tasks, for example: data imports, device generations, downloads, and
uploads.

J Completion time — The time at which the event completed. This can
be useful to determine how long a specific device generation took, or
how long it took to generate a set of devices. The software provides
information for generate jobs, device generations OPENDB sync, and
populate.

UM6.1:SW3151 Revision H — July 1996

 Creating Audit Trail Reports 15-11

J Status line — The number of warnings and errors that occurred

within a device generation. This line also includes the overall status of
device generations and downloads.

J Generation ID — The identification number for a specific generate

job.

J Download ID — Nominally the same as the generation ID in that the

download ID identifies the version of the configuration that is held in
the operator console or in CHIP. The download ID reflects the
generation ID of the last requested generation.

J Parameter Changes — The old and new values for item types
(except logic types).

J Devices affected — The list of devices that can be affected by an

ADD, MODIFY, or DELETE item event. This report is the list of
devices that need to be regenerated and downloaded as a result of
the event. The reason a device is affected may not always be obvious
as it is related to the constructs of the data downloaded to each
device type.

J ISQL adhoc updates — The table name and the number of rows
either inserted, updated (modified), or deleted through ISQL.

Three options are available in the upper-window menu: the Print option,
the Next option, and the Previous option.

15.1.4.1 Print Option

The Print option enables you to send the information you are viewing to a
printer or to a file. This option is identical to the Print option on the History
Summary form. Refer to subsection 15.1.3.2 for information about this
option.

15.1.4.2 Next and Previous Options

How the Next and Previous options work depends on how you accessed
15
the Event Detail form. If you reached the Event Detail form using the:

J History Summary form, the Next and Previous options display the
event details of next and previous events in the summary list

J Audit Trail Search form’s Event No. option, the Next and Previous
options displays the event details for the next and previous
sequentially numbered events

You will receive an error message if no next event details or previous

event details exist.

Revision H — July 1996 UM6.1:SW3151

 15-12 Creating Audit Trail Reports

15.1.5 Using the Audit Trail Search Form

Once you understand the search criteria and search form options as
described in subsections 15.1.1 through 15.1.4, accessing the Audit Trail
Search form and entering information is simple.

Step 1: At the ENVOX Top Level Form, select the Audit Trail menu
option from the More option pull-down menu.

ENVOX TOP LEVEL FORM

X Add Modify! Utilities More Status! Help

Generate
Download ->
Document
Upload
Diagnostics
IAC Trace/Tune
LCP Trace/Tune
Administration
Dbase Management ->
Audit Trail

The software displays the Audit Trail Search form.

Step 2: Fill out the search criteria fields as desired.

Step 3: Select and use the necessary options to display and print
summary and detail information about events.

Step 4: Exit the Audit Trail facility.

15

UM6.1:SW3151 Revision H — July 1996

 Import and Export Utilities A-1

Figure A-Table A

Appendix A

A Import and Export Utilities

This appendix describes how to use the Import utility to bring comma
delimited values (CDV)-formatted data into an ENVOXr database, and
how to use the Export utility to move the data from one database to
another. The files holding the CDV data are simply an ASCII version of
ENVOX configuration data.

CDV formatting is done by the export utility and the PROFLEXr migrate
utility, or is created from sources such as spreadsheets and databases.
The CDV data are in a specific order, separated by commas.

A.1 Migrating PROFLEX Configuration Data

To migrate PROFLEX data to an ENVOX database, the existing
PROFLEX software must be at revision level P3.0 or higher. The software
can be upgraded to that level if need be.

In addition, a PROFLEX migration software program is required. The

program is installed into the PROFLEX$DISK:[PROFLEX.SYSTEM]
directory in the PROFLEX software. The program is available from your
Fisher-Rosemount representative or sales office, along with the
PROFLEX migration manual, Migrating PROFLEX Data to an ENVOX
Database, D600462X012.

With the proper software revision level and the program listed above, the
ENVOX import utility described in this appendix can be used to migrate
you PROFLEX data.

Revision H — July 1996 UM6.1:SW3151

 A-2 Import and Export Utilities

A.2 Importing CDV-Format Data

The Import utility, which can be run either from the ENVOX forms system
or from command lines, lets you:

J Load CDV-format data into an empty ENVOX database

J Merge all of the CDV-format data into an ENVOX database that

contains data.

J Abort an import request

J View the status of an import request

A.2.1 Creating a Subdirectory for CDV Files

Before you can import If the CDV files, they must be placed in a
subdirectory under the ENVOX.MIGRATE directory. You must create the
subdirectory if it does not exist. The subdirectory name is limited to 12
alphanumeric characters, and at least one character must be
alphabetical.

A.2.2 Using the Import Form

Note
Note that the Max List Size on the Highway
Access Control List form defaults to 3072.
Increase this number if necessary before loading
the data. Console configuration engineering
manuals describe the form.

A
To access the Import form:

Step 1: From the ENVOX Top Level Form, select the More menu in
the menu bar.

Step 2: Select the Database Management option from the pull-down

menu.

Step 3: Select the Import Utility option from the slide-off menu.

UM6.1:SW3151 Revision H — July 1996

 Import and Export Utilities A-3

ENVOX TOP LEVEL FORM

X Add Modify! Utilities More Status! Help

Generate
Download ->
Document
Upload
Diagnostics
IAC Trace/Tune
LCP Trace/Tune
Administration
Dbase Management ->
-> Export Utility
Audit Trail Import Utility
EV172

The software displays the Import form shown in Figure A-1. The form
prompts you to enter the export set name.

The export set name is the name of the directory containing the CDV files
to be imported. When the Migrate utility is used to create the CDV files,
the user-created subdirectory name is the export-set name. These CDV
files are created using either the PROFLEX Migrate utility or the Export
utility. To access a list of valid export set names, press the Values List
key.

IMPORT
X! Load! Merge! Log Progress Delete! Help

EXPORT SET name v :

WARNING: Importing a device will cause that device and all

its source and target points to be deleted if the device
already exists in the database.

If you are IMPORTING a redundant pair of PROVUE or WPCON consoles

you must ensure they are deleted prior to the IMPORT.
A
EV125

Figure A-1 Example of Import Form

Revision H — July 1996 UM6.1:SW3151

 A-4 Import and Export Utilities

A.2.3 Loading CDV-Format Data

The Load! option moves the CDV-format data for the export set name you
specified to the ENVOX database you are logged on to. For the load
option to work, the ENVOX database can include only tags beginning with
! or & (default tags and ad hoc tag sets).

To load the data, select the Load! option from the Import form, as
highlighted in the figure below.

IMPORT
X! Load! Merge! Log Progress Delete! Help
EV173

The software aborts the load process if there are already configuration
data in the database other than default tags and ad hoc tag sets.

A.2.4 Merging CDV-Format Data

The Merge! option moves all of the CDV-format data to your ENVOX
database. This database can contain configuration data already. If the
Import utility finds that the tag already exists, it deletes the tag if the tag is
of the same type. If the tag is of a different type, the tag is not imported.

To merge CDV-format data, select the Merge! option from the Import
form-level menu, as highlighted in the figure below:

IMPORT
X! Load! Merge!
Merge! Log Progress Delete! Help
EV174

UM6.1:SW3151 Revision H — July 1996

 Import and Export Utilities A-5

A.2.5 Aborting an Import Request

To abort an import request:

Step 1: Select the Progress! option from the Import form menu.

Step 2: Select Abort from the pull-down menu.

Step 3: Select Yes from the slide-off menu.

IMPORT
X! Load! Merge! Log Progress!
Progress Delete! Help

View
Abort ->
No
Whole Queue
Yes
EV175

Revision H — July 1996 UM6.1:SW3151

 A-6 Import and Export Utilities

A.2.6 Tracking the Status of an Import Request

There are three menu options that provide information about import
requests:

J The View Option — Provides one of four progress messages.

J The Log Option — Enables you to view, print, or copy a log to a file.
The log shows you which tags have been entered into the database
and which have been rejected and the reason.

J The Whole Batch Queue Option — Shows you the batch queue for
all batch jobs. This includes generate requests and upload requests
as well as import and export requests.

A.2.6.1 Using the View Option

To obtain a view option message:

Step 1: Select the Progress! option from the Import form menu.

IMPORT
X! Load! Merge! Log Progress!
Progress Delete! Help

View
View
Abort ->
Whole Queue

Step 2: Select the View option from the pull-down menu.

One of the messages listed in Table A-1 appears:

Table A-1 View Option Messages

Message Meaning
No IMPORT in progress or pending No import requests are in the batch queue.

A IMPORT pending
IMPORT executing
One or more import requests are waiting to start.
An import operation is in progress.
IMPORT aborting An import operation is aborting.

UM6.1:SW3151 Revision H — July 1996

 Import and Export Utilities A-7

A.2.6.2 Using the Log Option

To obtain a log:
Step 1: Select the Log option from the Import form-level menu.

IMPORT
X! Load! Merge! Log
Log Progress Delete! Help

View
File
Print

Step 2: Select View, File, or Print.

J View — Displays the Import Log form with a log of the
most recently requested import. The Import Log form
includes the Status Update! menu option. This menu
option updates the import log with the latest information.
J File — Prompts you for a log file name. The software
writes the log to the file you specify.
J Print — Prints the log.
Figure A-2 shows a typical log.

IMPORT UTILITY LOG for 21-FEB-1989 11:23:01

Import initiated by BLOGGS
Import for Export set MIGRATE
From database MIGRATE
To database PROFLEX_1

OPTION - LOAD
STATUS - RUNNING
CURRENT ERROR COUNT - 3
ITEM ITEM
TAG STATUS

1
2
TAG1
TAG2
LOADED
LOADED
A
3 TAG3 LOADED
4 TAG4 INVALID FORMAT
5 TAG1 INVALID FORMAT
6 TAG2 INVALID FORMAT
7 TAG3 INVALID FORMAT
8 TAG5 INVALID FORMAT

Figure A-2 The Import Utility Log

Revision H — July 1996 UM6.1:SW3151

 A-8 Import and Export Utilities

A.2.6.3 Using the Whole Batch Queue Option

To access the whole batch queue:

Step 1: Select the Progress! option from the Import form-level menu.

IMPORT
X! Load! Merge! Log Progress!
Progress Delete! Help

View
Abort ->
Whole Queue

EV178

Step 2: Select the Whole Queue option from the pull-down menu.

The software displays a batch queue. Figure A-3 is an

example.

BATCH JOBS STATUS

X! Abort Job Help

Database ENVOXDB
Job
No. Job name User Task Status Mode

3 IMPORT PROFLEX IMPORT Pending Batch

2 JONES JONES GENERATE Pending Batch
1 SMITH SMITH UPLOAD Pending Batch
6 UPLOAD TARQUIN UPLOAD Executing Batch

EV092

Figure A-3 Batch Jobs Status Form

A

UM6.1:SW3151 Revision H — July 1996

 Import and Export Utilities A-9

A.2.7 Using the IMPORT_SETUP Utility

The import interface is named IMPORT_SETUP and allows an
experienced user to submit import jobs to the selected database job
queue after a specified time or to run an import interactively.
The logical ENVOX$MIGRATE_BASE for VMS or the environment
variable ENVOX_MIGRATE_BASE for UNIX must be set up before using
the IMPORT_SETUP utility.
The utility may be run from system prompts which ask for the required
data or from a single command line.

A.2.7.1 Running IMPORT_SETUP from Prompts

Step 1: Use the following command to run the IMPORT_SETUP utility
from prompts:
J VMS Command
$ MCR ENVOX$APPLICATION:IMPORT_SETUP
J UNIX Command
$ import_setup.exe
Following entry of the command, the utility prompts for the
required parameters. The parameters (given in the order in
which the prompts appear) are listed below. Default values
(except for the export directory name) are used for any
required missing parameters.
1. Export directory name — This is the name of the directory
containing the CDV files to be imported. Entry of a name is required;
there is no default. The name is limited to 12 alphanumeric
characters, one of which must be alphabetical.
2. After time — This is an optional field that allows you to specify a time
before the import utility runs. If this parameter is used, it must be
delimited by quotes and be in valid time format. The VMS DCL
Concepts Manual describes valid time formats. The default for this
field is NOW (that is, run the import without a time delay).
3. Username — This is the name of the user. The field defaults to
A
ENVOX.
4. Database — This is the name of the database. This field defaults to
the user’s default database.
5. Interactive — This field gives the user the option of running the
import either interactively (YES) or on the job queue (NO). When
running the IMPORT_SETUP utility interactively, this field defaults to
NO.

Revision H — July 1996 UM6.1:SW3151

 A-10 Import and Export Utilities

When all the prompts have been answered, the utility displays
the following message:

J VMS Display

Now execute the command @sys$scratch:imp_interactive.com

J UNIX Display

Now execute the command $HOME/imp_interactive.sh

Step 2: Enter the indicated commands:

J VMS Command

$ @sys$scratch:imp_interactive.com

J UNIX Command

$ $HOME/imp_interactive.sh

A.2.7.2 Running IMPORT_SETUP from a Single Command Line

The IMPORT_SETUP utility can be run from a single command line. You
fill in the required parameters directly on the command line without being
prompted. The command line format is:

J VMS Command

$ MCR ENVOX$APPLICATION:IMPORT_SETUP EXPORT_DIRECTORY_NAME AFTER_TIME -

USERNAME INTERACTIVE MODE

J UNIX Command

$ import_setup.exe EXPORT_DIRECTORY_NAME AFTER_TIME USERNAME \

INTERACTIVE MODE

The trailing hyphen (VMS) or the trailing backslash (UNIX) at the end of
the line indicate continuation characters and are only required if the
command does not fit on one line.

The parameters must appear in the order shown below:

A 1. Export directory name — The same as for the prompted

IMPORT_SETUP.

2. After time — The same as for the prompted IMPORT_SETUP.

3. Username — The same as for the prompted IMPORT_SETUP.

4. Database — The same as for the prompted IMPORT_SETUP.

5. Interactive — This field gives the user the option of running the
import either interactively (YES) or on the job queue (NO). When

UM6.1:SW3151 Revision H — July 1996

 Import and Export Utilities A-11

running the IMPORT_SETUP utility from the command line, this field
may be set to INTERACTIVE or with no entry. If you make no entry,
the import runs on the default job queue, sys$batch.

A.2.7.3 Examples for Running IMPORT_SETUP

The following examples show how the IMPORT_SETUP utility can be run
from the command line. The trailing hyphen at the end of the first line
(VMS) or the trailing backslash (UNIX) is the continuation character and is
only needed if the command does not fit on one line.

Example 1. This example submits an import to run at a specified time

via the job queue sys$batch:

J VMS Command

$ MCR ENVOX$APPLICATION:IMPORT_SETUP ERICSDATA_90OCT120938 -

“14-NOV-1993:11:30:20” ERIC DATABASE1 “”

J UNIX Command

$ import_setup.exe ERICSDATA_90OCT120938 - “14-NOV-1993:11:30:20” \

ERIC DATABASE1 “”

Example 2. This example runs an import in interactive mode:

J VMS Command

$ MCR ENVOX$APPLICATION:IMPORT_SETUP ERICSDATA_90OCT120938 “” ERIC —

DATABASE1 “”

J UNIX Command

$ import_setup.exe ERICSDATA_90OCT120938 “” ERIC DATABASE1 “”

Example 3. This example submits an import to run via the job queue
sys$batch and uses the defaults (username=ENVOX and
database = user’s default) database to run NOW on the
sys$batch queue:

J VMS Command

$ MCR ENVOX$APPLICATION:IMPORT_SETUP ERICSDATA_90OCT120938 “” “” “” — A

“” “”

J UNIX Command

$ import_setup.exe ERICSDATA_90OCT120938 “” “” “” — “” “”

Revision H — July 1996 UM6.1:SW3151

 A-12 Import and Export Utilities

A.2.8 Defining The Location Of Imported Data

For clarity, this subsection is divided into VMS system information and
UNIX system information.

A.2.8.1 Defining the Location on VMS Systems

Import uses the logical ENVOX$MIGRATE_BASE to determine where it
looks for the Export Sets containing CDV data to be imported. This logical
is usually in the form of:

“ENVOX$MIGRATE_BASE” = “_DKA300:[ENVOX.MIGRATE.]”

(The disk name DKA300 may be different depending on what disk device
names are valid in your system.)

The actual define command for the logical, ENVOX$MIGRATE_BASE, is

contained in the file ENVOX$APPLICATION:EVX_LOGS.COM.

$ define/nolog/trans=conc envox$migrate_base —
’f$trnlnm(“ENVOX$DISK”)’[envox.migrate.]

Note
Note carefully how the /trans=conc qualifier and
the period character at the end of the directory
specification are implemented. If for any reason
you decide to create your own definition of this
logical, your define command must follow the
same convention.

When Import searches for an Export Set name, it is actually looking for a
sub-directory under ENVOX$MIGRATE_BASE. For example, if you
specify an Export Set name BOILER_AREA, and the
ENVOX$MIGRATE_BASE logical is defined as above, Import expects to
find the CDV data in a directory called:
A _DKA300:[ENVOX.MIGRATE.BOILER_AREA]

UM6.1:SW3151 Revision H — July 1996

 Import and Export Utilities A-13

If you want to change the definition of ENVOX$MIGRATE_BASE to

another directory, you must put the appropriate command into your
LOGIN.COM file. Place it after the line:

$ @envox$application:evx_logs.com

Place it so that it supercedes the default definition. It is strongly

recommended that you do this rather than editing EVX_LOGS.COM
because other users may also be calling these files.

For example, suppose you have the following directory containing the
CDV data:

DKB100:[SMITH.BOILER_AREA]

With this directory, use a command like the following in your LOGIN.COM
file:
$ define/nolog/trans=conc envox$migrate_base dkb100:[smith.]

In this example, The Export Set name that you specify for Import or
IMPORT_SETUP is BOILER_AREA.

It is essential that any logical definition you put into your LOGIN.COM file
follows these rules:

J The disk device name should be given explicitly (for example,

DKA300 or DKB100) rather than as a logical name.

J The /trans=conc qualifier is mandatory.

J The trailing period at the end of the directory name is mandatory.

J Your logical definition must be placed in the LOGIN.COM file in such a

way that it executes when logging on in either batch or interactive
mode.

Revision H — July 1996 UM6.1:SW3151

 A-14 Import and Export Utilities

A.2.8.2 Defining the Location on UNIX Systems

Import uses the environment variable ENVOX_MIGRATE_BASE to
determine where it looks for the Export Sets containing CDV data to be
imported. This environment variable is usually in the form of:

ENVOX_MIGRATE_BASE=$ENVOX/migrate

The define command for the environment variable,

$ENVOX_MIGRATE_BASE, is contained in the file
$ENVOX/executables/evx_setup.sh.

$ ENVOX_MIGRATE_BASE=$ENVOX/migrate

$ export ENVOX_MIGRATE_BASE

When Import searches for an Export Set name, it is actually looking for a
sub-directory under under $ENVOX_MIGRATE_BASE. For example, if
you specify an Export Set name boiler_area, and the
ENVOX_MIGRATE_BASE is defined as above, Import expects to find the
CDV data in a directory called:

$ENVOX_Disk/migrate/boiler_area

If you want to change the definition of ENVOX_MIGRATE_BASE to

another directory, you must put the appropriate command into your
.profile. Place it after the line:

$ ENVOX/executables/evx_setup.sh

Place it so that it supercedes the default definition. It is strongly

recommended that you do this rather than editing evx_setup.sh files,
because other users may also be calling these files.

For example, suppose you have the following directory containing the
CDV data:

/users/smith/boiler_area

With this directory, use a command like the following in your LOGIN.COM
file:

$ ENVOX_MIGRATE_BASE=/users/smith
A
$ export ENVOX_MIGRATE_BASE

In this example, The Export Set name that you specify for Import or
IMPORT_SETUP is boiler_area.

UM6.1:SW3151 Revision H — July 1996

 Import and Export Utilities A-15

A.3 Exporting Configuration Data

An ENVOX configuration system can include several databases. Each
database may contain the configuration data for a single plant or plant
area. A database may contain alternative configuration data used for
special processing. You can duplicate the configuration data in one
database and put it into another using the export and import utilities.
Figure A-4 shows how the Export utility works.

HOST COMPUTER
ENVOXr SOFTWARE

Database
Database
Database

Utility:
Import
Utility:
Export

Format:
CDV

Figure A-4 Export Utility Flow Diagram

Basically, the export utility copies the data to a comma delimited value
(CDV) format. The import utility can import this data into a different
ENVOX database, converting it back to the standard ENVOX format.

The export utility can be initiated from either the ENVOX forms system or
from a command line. The following subsections describe how to run the
utility via either method.

A
Note
Running the export utility from a command line is
only recommended for experienced users. Users
not familiar with the command line system should
use the ENVOX forms system.

Revision H — July 1996 UM6.1:SW3151

 A-16 Import and Export Utilities

A.3.1 Running the Export Utility From ENVOX Forms

The export utility, available from the Export forms system lets you:

J Export all the configuration data in a database to CDV format

J Export only the items you specify to CDV format

J Abort an export request

J View the status of an export request

A.3.1.1 Accessing the Export Form

To access the export form:

Step 1: Select the More menu option from the ENVOX Top Level
Form.

Step 2: Select the Dbase Management option from the pull-down

menu.

Step 3: Select the Export Utility option from the slide-off menu.

UM6.1:SW3151 Revision H — July 1996

 Import and Export Utilities A-17

ENVOX TOP LEVEL FORM

X! Add Modify! Utilities More Status! Help

Generate
Download ->
Document
Upload
Diagnostics
IAC Trace/Tune
LCP Trace/Tune
Administration
Dbase Management ->
->
Export
Export Utility
Utility
Audit Trail
Import Utility
EV179

The software displays the Export form, as shown in Figure A-5. The form
prompts you to enter the tag of the item or the tag set and the export
name.

EXPORT
X! All! Progress Start! Help

Enter tag of item or tag set :

Enter EXPORT name :

EV126

Figure A-5 Example of Export Form A

Revision H — July 1996 UM6.1:SW3151

 A-18 Import and Export Utilities

A.3.1.2 Exporting All Database Data

To export all of the sourced, targeted, and referenced items from the
database you are currently logged on to:
Step 1: After the following prompts, enter the information indicated:
Enter tag of item set : (leave blank)
Enter EXPORT name : export request name
The export request name can be as many as 12 upper-case
characters. If you do not enter a name, the software creates a
name using the first 12 characters of your SQL server name.
The software uses the name as a basis for the name for a new
directory that it creates for your export data. The software
names the directory using the export file name, underscore
characters through the 13th character, and the date and time
of the export request.
Step 2: Select the All! option from the Export form.

EXPORT
X! All!
All! Progress Start! Help
EV180

Step 3: The Confirm Action form is displayed.

J Select Cancel! to return to the Export form.
J Select Confirm! to select the entire database for export.
The software displays a warning indicating that the entire
database will be exported:
F2736: Warning - Export entire database
Step 4: Select the Start! option from the export form.

A EXPORT
X! All! Progress Start! Help
EV181

Step 5: The Confirm Action form is displayed.

J Select Cancel! to return to the Export form.
J Select Confirm! to start the export. If you select Confirm!
the Export form is displayed.

UM6.1:SW3151 Revision H — July 1996

 Import and Export Utilities A-19

A.3.1.3 Exporting Selected Items

You can export single items or items from a tag set. Obviously, if you have
a large number of items you want to export, it is faster to build tag sets for
these items than to export them individually. For each device name, the
software exports all source points, targeted data, and referenced items for
the device.

Target information for points sourced in the device is not exported. To

export this target information, create a tag set of the points sourced in the
device and perform an export of that tag set. The tag set cannot include
the device tag of the source device. For each point tag, the software
exports the source data for the point and its target data.

When you export a UOC/SR90/SRx type device, only ISTs directly

referenced by points are exported. If an IST references a device, but it is
not referenced by a point, it is not included in the export. For example, if
an IST is only indirectly related in an FST, the IST is not exported. The
best way to export a device and ensure that all ISTs are included is to
create a tag set consisting of all of the ISTs associated with the device,
add the device tag into the tag set, and export using the tag set.

To export selected items:

Step 1: After the following prompts, enter the information indicated:

Enter tag of item set : tag of item or tag set

Enter EXPORT name : export request name

The export request name can be as many as 12 upper-case

characters. If you do not enter a name, the software creates a
name using the first 12 characters of your SQL server name.

The software uses the name as a basis for the name for a new
directory that it creates for your export file. The software names
the directory using the export file name, underscore characters
through the 13th character, and the date and time of the export
request.

Step 2: Select the Start! option from the Export form.

A
EXPORT
X! All! Progress Start! Help
EV181

Step 3: The Confirm Action form is displayed. Select Cancel! to return

to the Export form. Select Confirm! to start the export. If you
select Confirm! the Export form is displayed.

Revision H — July 1996 UM6.1:SW3151

 A-20 Import and Export Utilities

A.3.2 Exporting from a Command Line

The export interface utility is named, EXPORT_SETUP. You may use the
built-in prompt system to fill in the required parameters or you may run
the utility directly from a command line. Also, you may select the time
after which you want this utility to run in a batch queue or you may run it
interactively.

Note
The environment variable
ENVOX$MIGRATE_BASE (VMs) or
$ENVOX_MIGRATE_BASE (UNIX) must be set up
before using the EXPORT_SETUP utility.

A.3.2.1 Running EXPORT_SETUP From Prompts

The EXPORT_SETUP utility can be run using a system of built-in
prompts which help you setup the utility. To begin the prompt system,
enter the following command at the prompt.

J VMS Command

$ MCR ENVOX$APPLICATION:EXPORT_SETUP

J UNIX Command

$ export_setup.exe

Following entry of the command, the utility prompts for the required
parameters. Default values are automatically entered for any parameters
not entered.

The required parameters (given in the order in which the prompts appear)
are:

1. Item — Enter the name of the item tag or tag set which you want to
A export. The default is the return key, which you use if you intend to
enter ALL at the mode prompt.

2. Export Set Name — Enter the name of the receiving directory for the
CDV data. Only alphanumeric characters are valid, and the export set
name must contain at least one alphabetic character. The default is
ENVOX.

UM6.1:SW3151 Revision H — July 1996

 Import and Export Utilities A-21

3. After time — For submission to a batch queue, enter the time after
which you want the utility to run. The time must be delimited by
quotation marks and be in the following format:

[DD-MMM-YYYY[:]]HH:MM[:SS.C]

For interactive running, you do not need to enter anything. The default
is NOW.

4. Username — Enter the name of the user. The default is ENVOX.

5. Database — Enter the database name. The default is the user’s

default database.

6. Interactive — For submission to a batch queue, enter NO. For

interactive running, enter YES.

7. Mode — Enter ITEMS if exporting an item or a tag set; enter ALL if

you are exporting the entire contents of the database and you used
the default entry (Return) for the Item field. The default is ITEMS.

When all of the prompts are answered, the utility displays the following
message.

J VMS Message

Now execute the command @sys$scratch:exp_interactive.com

J UNIX Message

Now execute the command $HOME/exp_interactive.sh

To run the EXPORT_SETUP, enter the following command at the prompt:

J VMS Command

$ @sys$scratch:exp_interactive.com

J UNIX Command

$ $HOME/exp_interactive.sh

Revision H — July 1996 UM6.1:SW3151

 A-22 Import and Export Utilities

A.3.2.2 Running EXPORT_SETUP From a Single Command Line

The EXPORT_SETUP utility can be run from a single command line. You
fill in the required parameters directly on the command line without being
prompted. The command line format is.

J VMS Command

$ MCR ENVOX$APPLICATION:EXPORT_SETUP ITEM EXPORT_SET_NAME AFTER_TIME —

USERNAME DATABASE INTERACTIVE MODE

J UNIX Command

$ export_setup.exe ITEM EXPORT_SET_NAME AFTER_TIME USERNAME DATABASE \

INTERACTIVE MODE

The trailing hyphen (VMS) or the trailing backslash (UNIX) at the end of
the line indicate continuation characters and are only required if the
command does not fit on one line.

The parameters must appear in the order shown below. The default for
each parameter is “”.

1. Item — Enter the name of the item tag or tag set which you want to
export. If you want to export the entire contents of the database,
enter “”. If you use the double quotation marks, you must enter ALL
at the mode prompt.

2. Export Set Name — Enter the name of the receiving directory for the
CDV data. Only alphanumeric characters are valid, and the export set
name must contain at least one alphabetic character. Enter “” for the
default, which equates to ENVOX.

3. After time — For submission to a batch queue, enter the time after
which you want the utility to run. The time must be delimited by
quotation marks and be in the proper time format. For interactive
running, enter “”.

4. Username — Enter the name of the user. Enter “” for the default,
which equates to ENVOX.

5. Database — Enter the database name. Enter “” for default, which is

A the user’s default database.

6. Interactive — For submission to a batch queue, enter “”. For

interactive running, enter “INTERACTIVE”.

7. Mode — Enter “ITEMS” if exporting an item or a tag set; enter ALL if

you are exporting the entire contents of the database and you used
the default entry (“”) for the Item field.

UM6.1:SW3151 Revision H — July 1996

 Import and Export Utilities A-23

A.3.2.3 Examples for Running EXPORT_SETUP

The following examples show how the EXPORT_SETUP utility can be run
from the command line:

Example 1. Example of an EXPORT_SETUP utility command line which

submits an export job for specific items to run at a specified
time through a batch job queue

J VMS Command

$ MCR ENVOX$APPLICATION:EXPORT_SETUP “ITEM TAG” ERICSDATA —

“04-NOV-1993:10:25:10” ERIC DATABASE1 “” ITEMS

J UNIX Command

$ export_setup.exe “ITEM TAG” ERICSDATA “04-NOV-1993:10:25:10“ ERIC \

DATABASE1 “” ITEMS

Example 2. Example of an EXPORT_SETUP utility command line which

runs an export job for specific items interactively

J VMS Command

$ MCR ENVOX$APPLICATION:EXPORT_SETUP “ITEM TAG” ERICSDATA “” ERIC —

DATABASE1 INTERACTIVE ITEMS

J UNIX Command

$ export_setup.exe “ITEM TAG” ERICSDATA ERIC DATABASE1 INTERACTIVE ITEMS

Example 3. Example of an EXPORT_SETUP utility command line which

exports the entire contents of a database, and is submitted
immediately to the batch job queue

J VMS Command

$ MCR ENVOX$APPLICATION:EXPORT_SETUP “” ERICSDATA “” ERIC DATABASE1 —

“” ALL

J UNIX Command

$ export_setup.exe “” ERICSDATA “” ERIC DATABASE1 “” ALL

Example 4. Example of an EXPORT_SETUP utility command line which

A
exports the entire contents of a database, and runs
interactively

J VMS Command

$ MCR ENVOX$APPLICATION:EXPORT_SETUP “” ERICSDATA “” ERIC DATABASE1 —

“INTERACTIVE” ALL

J UNIX Command

Revision H — July 1996 UM6.1:SW3151

 A-24 Import and Export Utilities

$ export_setup.exe “” ERICSDATA “” ERIC DATABASE1 “INTERACTIVE” ALL

Example 5. Example of an EXPORT_SETUP utility command line which

exports the entire contents of the user’s default database,
using the user name ENVOX. The export set name is
ENVOX_datetime, where datetime is the current data and
time. The export job will be submitted immediately to the
batch job queue.

J VMS Command

$ MCR ENVOX$APPLICATION:EXPORT_SETUP “” “” “” “” “” “” ALL

J UNIX Command

$ export_setup.exe “” “” “” “” “” “” ALL

UM6.1:SW3151 Revision H — July 1996

 Importing Bulk Data B-1

Figure B-Table B

Appendix B

B Importing Bulk Data

ENVOXr configuration software enables you to import the majority of
your instrument signal, controller point source, and target data from
third-party software — such as a spreadsheet, relational database, or
word processor — into an ENVOX database. Two methods exist for
importing the data:
J Importing instrument signal, controller point source, and target data
with the Open Database Module
J Importing instrument signal data in ASCII code

B.1 Importing Bulk Data with the Open

Database Server Software
The Open Database Server Software, imbedded in ENVOX software
(version P2.0.2 and greater), provides an easy method of importing data
from your spreadsheet, resident on your personal computer, into and out
of your ENVOX database. No triggers, rules, or locking are used.
In addition, Type SW3152 Open Database PC Client Software is available
separately which provides EXCEL worksheets and Q+E query files
structure for the most common PROVOXr point types. For further
information about the open database PC client software, contact your
Fisher-Rosemount Systems representative or sales office. How to use
both the server software and the PC client software is documented in the
user manual, Using the ENVOX Open Database, UM6.2:SW3152.

B.2 Importing Instrument Signal Data in ASCII

Code B
You may import instrument signal data using ASCII code. If, for example,
your instrument signals are in a spreadsheet, you can define an ASCII
output file such that ENVOX software can accept the file. Once the data is
in the database, ENVOX software does not require any modification to it.
The ASCII data must be in a format called comma delimited format
(CDV), described later in this section.

Revision H — July 1996 UM6.1:SW3151

 B-2 Importing Bulk Data

The basic steps for importing ASCII data are as follows:

Step 1: Create ASCII output files of your data following the CDV
format guidelines in this section.
Step 2: Use the import utility to import the ASCII data into an ENVOX
database. Appendix A, subsection A.2, describes the import
utility.

Note
Creating CDV files for import requires that you
understand how the third-party software works.
For example, if your third-party software is a
relational database, you must understand the
structure of the database, how to read the
database, and how to write the CDV files through
a program.

CDV format is a straightforward format for ASCII data. For each type of
database item (instrument signal tags [ISTs], points, templates, and so
on), the CDV format specifies a particular order for the fields associated
with the item, with commas delimiting the values. For example, an IST in
CDV format could look like this:
IST,“FT-107”,,,“INSTRUMENT SIGNAL”
“ANALOG”,“INPUT”,“UOC-PLUS”,,,,“NO”,“NO”,
100.00000,0.00000,“%”,10.00000,“DEV”,“LOW”,10.00000,“LOW”,“H
IGH”,90.00000,“HIGH”,2.00000,“”,“”,0.00000,1,END
Text entries are delimited with quotes (with the exception of IST and
END), numeric entries are not.
IST is in field 1, FT-107 is in field 2, and so on. Note that some of the
fields, such as fields 3 and 4, have null values — the commas have no
values entered. Other fields, such as fields 26 and 27, have blank strings
— the commas include leading and trailing quotes, but no values. In the
example above, fields 3 and 4 were not defined in the third-party source
file. Fields 25 and 26 are discrete ON/OFF words that were defined but
empty.

B Note
If any field is missing or out of sequence, the
importation fails. Make sure you have the proper
number of fields and the field data in the proper
order before attempting to import the data.

UM6.1:SW3151 Revision H — July 1996

 Importing Bulk Data B-3

Table B-1 defines the fields for the IST CDV format. Table B-2 defines the
valid entries for the fields.

Table B-1 Field Definitions for IST CDV Format

Field Database
Number Name Database Type Description
1(1)
2 tag tag_type Tag of instrument signal
3 strategy strategy_type ENVOX strategy field
4 comment comment_type A single line, text
comment
5 user_type user_type_item Type of item as seen by
the user
6 type type_of_signal Determines the type of
signal
7 signal_direction signal_direction_type Determines whether
signal is input, output, or
both
8 device_tag tag_type The tag of the device into
which the signal connects
9 file file_number_type The number of the MUX
file into which the signal
connects
10 card card_number_type The card number of the
MUX into which the signal
connects
11 channel channel_number_type The channel number of
the card into which the
signal connects
12 invert_input yes_no_type Determines whether the
software inverts the input
signal
13 invert_output yes_no_type Determines whether the
software inverts the
output signal
14 high_scale scale_type Determines the signal’s
high scale value
15 low_scale scale_type Determines the signal’s
low scale value
16 units engineering_units_type Determines the
engineering units used for
console display
17 alarm_a_limit analog_type Determines the limit that
trips alarm A
B
18 alarm_a_word alarm_word_type The word displayed when
alarm A is activated
19 alarm_b_type high_low_type Determines whether
alarm B is a high or low
limit alarm
20 alarm_b_limit analog_type Determines the limit that
trips alarm B

Revision H — July 1996 UM6.1:SW3151

 B-4 Importing Bulk Data

Table B-1 Field Definitions for IST CDV Format (Continued)

Field Database
Number Name Database Type Description
21 alarm_b_word alarm_word_type The word displayed when
alarm B is activated
22 alarm_c_type high_low_type Determines whether
alarm C is a high or low
limit alarm
23 alarm_c_limit analog_type Determines the limit that
trips alarm C
24 alarm_c_word alarm_word_type The word displayed when
alarm C is activated
25 alarm_deadband analog_type Deadband for alarm A, B,
and C
26 on_alarm_word alarm_word_type The word displayed when
the discrete signal is
active
27 off_normal_word alarm_word_type The word displayed when
the discrete signal is not
active
28 conv_constant pci_conv_const_type The conversion constant
for PCI and EPCI signals
29 smart_variable smart_variable_ The smart variable
number_type number of the channel
into which the signal
connects.
30(2) none none The key word END. This
ends the CDV IST format.
1. The first field is the identifying field: IST.
2. Field 29 (the word END) closes the CDV string.

UM6.1:SW3151 Revision H — July 1996

 Importing Bulk Data B-5

Table B-2 Database Data Types for Instrument Signal Tags

Database Type Valid Entries or Range
alarm_word_type As many as eight characters and spaces
analog_type Any floating-point number
card_number_type A number 1 through 14
channel_number_type A number 1 through 16
comment_type As many as 75 characters and spaces
engineering_units_type As many as six characters and spaces
file_number_type A number 1 through 16
high_low_type HIGH or LOW (must be uppercase letters)
pci_conv_const_type A floating-point number from 0.1 through 5.0
scale_type Any floating-point number
signal_type ANALOG, DISCRETE, PULSE COUNT, or
PARALLEL DISCRETE, SMART (must be uppercase
letters)
signal_direction_type INPUT, OUTPUT, or INPUT/OUTPUT
strategy_type As many as 16 characters and spaces
tag_type As many as 12 letters and numbers and . , / -- <space>
yes_no_type YES or NO (must be uppercase letters)
smart_variable_number_ A number 1 through 16
type

Revision H — July 1996 UM6.1:SW3151

 B-6 Importing Bulk Data

This page intentionally left blank.

UM6.1:SW3151 Revision H — July 1996

 Keyboard Reference C-1

Figure C-Table C

Appendix C

C Keyboard Reference
This appendix lists keyboard and keyword functions for the forms editor,
language editor, trace/tune utility, and the diagnostics utility.

C.1 Menu Keys

Menu keys are used when you edit forms. A menu key is a single
character key you press to select a menu or menu option. The character
key to use is indicated by underline or reverse video in the option name.
These keys are not case-sensitive; they provide menu selection from
either lower-case or upper-case letters. Figure C-1 shows examples of
menu keys.

ENVOX TOP LEVEL FORM

X Add Modify! Utilities More Status! Help

UOC/IFC/SR90 POINTS ->

CONSOLE POINTS ->
CHIP POINTS ->
OTHER POINTS ->
DEVICES ->
LOGIC ->
INSTRUMENT SIGNAL
INSTRUMENT SIGNAL
GLOBAL ITEMS ->

Figure C-1 Menu Keys Are Shown on the Screen in Reverse Video or
Underline

Revision H — July 1996 UM6.1:SW3151

 C-2 Keyboard Reference

C.2 Forms Navigation Keys

Table C-1 lists control keys, function keys, and other keys, and describes
what they do when you navigate in the ENVOXr forms system.

Table C-1 Keys for Navigating in ENVOXr Forms

Action Ctrl Key
y Function Key Description
p
DEC HP IBM-PC
Menu Ctrl-r GOLD GOLD GOLD Moves the cursor between the menu
Toggle PF1 * (on Numlock bar and work area. Also, typically
number enables split window key functions.
pad), or
Unlabeled
key (1)
Insert/ Ctrl-a ------ ------ ------ Toggles between Insert and Overstrike.
Overstrike
Help ------ PF3 or Unlabeled F11 Provides help information about the
Help key (1) current field.
Display Ctrl-v F7 F1 F1 Calls up a list of valid entries for fields
Values that include the v indicator. Press the
List Return key (or Menu Toggle function
key and Apply), or click on the entry
with the pointing device, to enter a
selected entry into the field; the valid
entries list is automatically exited. Use
the Menu Toggle key and Cancel, or
click on Cancel with the pointing
device, to exit the list if no entry is
desired. Where all of the tags in the
database are valid entries (for example,
at the Modify prompt), you must limit
the list by supplying an initial letter or
wildcard (other than %).
Last Tag ------ F10 F4 F4 When you are adding, modifying, or
viewing tags, enters the previously
entered tag name in the name field of
the ENTER TAG popup form.
Previous Ctrl-b Prev Prev Page Scrolls a group upward.
Screen Screen Up
Next Ctrl-f Next Next Page Scrolls a group downward.
Screen Screen Down
Move ------ A "YB A "YB A "YB Moves the cursor to different fields
Cursor Arrow keys Arrow keys Arrow keys within a form, to different choices in a
visible choice field, or to different
entries in a valid entries list. Up and
down arrow keys highlight the entries in
pull-down and slide-off menus.
C Previous Ctrl-p F12 F6 F6 Moves the cursor to the previous field.
Field
Next Ctrl-i, or Tab or F13 Tab or F7 Tab or F7 Moves the cursor to the next field.
Field Ctrl-n
1. See Figure C-5 for the function of unlabeled keys on the HP-UX keyboard.

UM6.1:SW3151 Revision H — July 1996

 Keyboard Reference C-3

Table C-1 Keys for Navigating in ENVOXr Forms (Continued)

Action Ctrl Key Function Key Description
DEC HP IBM-PC
Next ------ Space Bar Space Bar Space Bar Moves the cursor to the next choice in a
Choice single choice field.
Previous Ctrl-_ ------ ------ ------ Returns the cursor to the previous
Window window.
Find ------ F9 F3 F3 Moves the cursor to the next NULL field
Null on the current form. A NULL field is a
field that does not have any data in it.
This is helpful when trying to find
incomplete fields that may have caused
a configuration file generation to fail.
Delete Ctrl-h, or Backspace, Backspace, Backspace, Deletes previous character in a field.
Character Ctrl-x or Delete or Delete or Delete
Delete Ctrl-u ------ ------ ------ Deletes a field entry from the cursor to
Field the end of the line.
Enter ------ F17 Unlabeled F10 Fills-in the fields in the displayed form
Default key (1) with default values for this item type.
Erase Ctrl-e F20 Unlabeled F12 Erases the entry in the current activated
Entry key (1) field.
Find ------ F8 F2 F2 Finds a row you specify by row number
Row or some other identifier, depending on
the current list.
Insert ------ F11 F5 F5 Inserts a blank row of data in a group.
Row
Erase ------ F14 F8 F8 Deletes a row of data from a group.
Row
Redraw Ctrl-w ------ ------ ------ Redraws the screen. Useful if a VAX
screen mail message is obscuring a form.
Print Ctrl-^ ------ ------ ------ Prints the current form.
Enter Ctrl-m Return Return Return Enter a choice, command, so forth
Interrupt Ctrl-c ------ ------ ------ Interrupts the forms entry, allowing you
to exit the software, or resume.
Exit Ctrl-z F6 ------ ------ Exits ENVOX software to the SYBASE
DCL prompt without interrupting current
processes. Type logout at the prompt
to return to ENVOX software. Ctrl-z
does not work from the ENVOX
Language Editor.
1. See Figure C-5 for the function of unlabeled keys on the HP-UX keyboard.

Revision H — July 1996 UM6.1:SW3151

 C-4 Keyboard Reference

C.3 Language Editor Keys

Table C-2 lists key names and functions for open and closed instructions
for DEC, IBM-PC (as an X-terminal to OpenVMS and UNIX systems), and
HP keyboards.

Table C-2 Language Editor Keys

Key Name
Function for
IBM-PC IBM-PC Closed Function for
DEC HP (VMS) (UNIX) Instructions Open Instructions
GOLD GOLD GOLD GOLD Typically enables split No effect
PF1 KP* Ctrl--g Ctrl-g window key functions.
ENABLE/ ENABLE/ ENABLE/ ENABLE/ A toggle key which No effect
DISABLE DISABLE DISABLE DISABLE causes the process
F18 F10 F10 F10 control system to ignore
the instruction that the
cursor is on by placing a
asterisk in front of the
instruction. If pressed
again, it removes the
asterisk, restoring the
function of the
instruction. If used with
Select, it disables a
range of instructions or
comments. Disabled
instructions cannot be
generated or
downloaded.
MORE MORE MORE MORE Displays a popup No effect
F19 F11 F11 F11 containing the Include
and Learn Sequence
options.
B (Down B (Down B (Down B (Down Moves the cursor to the No effect
arrow) arrow) arrow) arrow) next instruction
END END END END Moves the cursor to the No effect
F14 F8 F8 F8 last line of the instruction
sequence (end-of-buffer
marker)
ERASE ERASE ERASE ERASE Erases the entire Erases the operand the
ENTRY ENTRY ENTRY ENTRY instruction or comment cursor is on. The
Remove, F12 F12 F12 the cursor is on after you software does not ask
F20 confirm that you want to you to confirm the
erase. Also erases a erase.
range of comments,
instructions, or comment
C text backlit with Select
and places them into the
paste buffer.
ERASE ERASE ERASE ERASE At a split window, No effect
WINDOW WINDOW WINDOW WINDOW removes the top
Gold--F20 Gold--F12 Gold--F12 Gold--F12 read-only window.

UM6.1:SW3151 Revision H — July 1996

 Keyboard Reference C-5

Table C-2 Language Editor Keys (Continued)

Key Name
Function for
IBM-PC IBM-PC Closed Function for
DEC HP (VMS) (UNIX) Instructions Open Instructions
EXIT EXIT EXIT EXIT Enables you to save your Closes the instruction.
PF4, F10 F4 Ctrl-d F4 work or exit the language Also, exits from pop-up
editor and return to the windows.
form you entered from by
providing these exit
options: SAVE WITH
CHECK, SAVE
WITHOUT CHECK,
CANCEL, and QUIT.
Subsection 7.12
describes these options.
CANCEL leaves you in
the language editor.
FIND FIND FIND FIND Searches down the No effect in regular
Gold--FIND Gold--KP 7 Gold--KP 7 Gold--KP 7 sequence from the instructions and line
location of the cursor, comments. Active in
looking for a match for a comment instructions.
string you specify. The
search wraps to the top if
allowed. Subsection 7.8
describes how to enter a
string to search for.
FIND NEXT FIND NEXT FIND NEXT FIND NEXT Searches for the string No effect in regular
FIND KP 7 KP 7 KP 7 previously searched for instructions and line
by FIND or FIND & comments. Active in
REPLACE. comment instructions.
FIND & FIND & FIND & FIND & Finds the match for the No effect
REPL REPL REPL REPL search string you specify
F8 F2 Ctrl-b F2 and replaces it with the
replace string you
specify. Subsection 7.8
describes the function.
FIND FIND FIND FIND If you are modifying an No effect
ERROR ERROR ERROR ERROR instruction sequence
F9 F3 Ctrl-c F3 after a failed generation
attempt, this key moves
the cursor to the next
instruction that caused a
generation error. If this
instruction sequence has
not been part of a
generation attempt, and
after all generate errors
have been found, this
key moves the cursor to
the next NULL operand
(an operand with no
value).
HELP HELP HELP HELP Subsection 7.9 provides Subsection 7.9 provides C
PF3 KP + Ctrl-k KP + a description a description
HOME HOME HOME HOME Moves the cursor to the No effect
F11 F5 Ctrl-e F5 first line of the session

Revision H — July 1996 UM6.1:SW3151

 C-6 Keyboard Reference

Table C-2 Language Editor Keys (Continued)

Key Name
Function for
IBM-PC IBM-PC Closed Function for
DEC HP (VMS) (UNIX) Instructions Open Instructions
A " A " A " A " No effect Moves the cursor one
(Left and (Left and (Left and (Left and character in the
right arrow) right arrow) right arrow) right arrow) direction specified within
the operand field.
Wraps within an
operand.
NEXT NEXT NEXT NEXT Moves the cursor to the Moves the cursor to the
FIELD FIELD FIELD FIELD next instruction next operand for regular
F13 F7 F7 F7 instructions or the next
word for comment
instructions
PREV PREV PREV PREV Moves the cursor to the Moves the cursor to the
FIELD FIELD FIELD FIELD previous instruction previous operand for
F12 F6 F6 F6 regular instructions or
the next word for
comment instructions
OPEN/ OPEN/ OPEN/ OPEN/ Opens a closed Closes an open
CLOSE CLOSE CLOSE CLOSE instruction or comment instruction or comment.
F17 F9 F9 F9 For IAC FST loadable
functions, Open/Close
closes the loadable
function leaving the
parent instruction open.
Open/Close closes the
parent instruction.
OTHER OTHER OTHER OTHER In a split window, places No effect
WINDOW WINDOW WINDOW WINDOW the cursor in the other
Gold--F18 Gold--F18 Gold--F18 Gold--F18 window.
Gold--Y Gold--Y Gold--Y Gold--Y
Gold--B Gold--B Gold--B Gold--B
PASTE PASTE PASTE PASTE Inserts the contents of No effect in regular
Insert Here KP 0 KP 0 KP 0 the paste buffer just in instructions. Pastes text
front of the cursor. Paste within an open
does not empty the comment.
buffer, so you can do
multiple inserts.
Prev Prev Page Up Prev Shows the previous No effect in regular
Screen page. instructions. Shows the
previous page in a
comment instruction.
PREVIEW PREVIEW PREVIEW PREVIEW For the PROVUE reports No effect
PF2 KP / Ctrl-j KP / language editor, this key
calls up a preview
window for all the
LAYOUT instructions.
Configuring the PROVUE
C Console
(CE7.0:DC6460)
provides more details on
reports.

UM6.1:SW3151 Revision H — July 1996

 Keyboard Reference C-7

Table C-2 Language Editor Keys (Continued)

Key Name
Function for
IBM-PC IBM-PC Closed Function for
DEC HP (VMS) (UNIX) Instructions Open Instructions
PRINT PRINT PRINT PRINT Displays a popup menu No effect
F7 F1 Ctrl-a F1 that enables you to print
or create a file of all the
text in this editing
session or the
highlighted text.
Next Next Page Next Shows the next page. No effect in regular
Screen Down instructions. Shows the
next page in a comment
instruction.
SELECT SELECT SELECT SELECT Marks an area by No effect except in IAC
Select Select KP 1 Select backlighting it. Backlit FST loadable
text can be manipulated functions—where Select
by Remove and other opens the loadable
keys. Press a key, then function.
move the cursor over
instructions and
comment instructions to
backlight them. Press
Select again to abort the
selection.
SPLIT SPLIT SPLIT SPLIT Splits the language editor No effect
WINDOW WINDOW WINDOW WINDOW window and creates a
Gold- F17 Gold--F9 Gold--F9 Gold--F9 second, read-only
window on the top half.
Both windows display the
current items. You can
use this second window
to include and copy a
block of instructions into
the main editor window.
READ TO READ TO READ TO READ TO Enables you to read a No effect
BUFFER BUFFER BUFFER BUFFER block of instructions from
Gold--F19 Gold--F11 Gold--F11 Gold--F11 another sequence into a
read-only window.
Displays a window
containing a Tag entry
field and, depending on
the language type, an ID
field. See subsection 7.4
for how to include
instructions.
Y Y Y Y Moves the cursor to the No effect
(Up arrow) (Up arrow) (Up arrow) (Up arrow) previous instruction.
Note: KP preceding a symbol or number indicates that the symbol or number on the keypad (number pad) should be
used.
Note: If you are using an IBM-PC standard keyboard and the < or > keys display a , (comma), select the OPTIONS
softkey from the window header bar and select KEYBOARD. Then select COMMA KEY Sends , <. Finally apply
and select OK.
C

Revision H — July 1996 UM6.1:SW3151

 C-8 Keyboard Reference

C.4 Display Editor Keys

Table C-3 lists display editor characters and their descriptions for DEC,
IBM-PC (as an X-terminal to OpenVMS and UNIX systems), and HP
keyboards.

Table C-3 Graphic Display Editor Keys

Key Name
Label or
DEC HP IBM-PC Meaning Description
F7 F1 F1 (S1) softkey 1 White menu option 1
F8 F2 F2 (S2) softkey 2 White menu option 2
F9 F3 F3 (S3) softkey 3 White menu option 3
F10 F4 F4 (S4) softkey 4 White menu option 4
F11 F5 F5 (S5) softkey 5 Yellow menu option 1
F12 F6 F6 (S6) softkey 6 Yellow menu option 2
F13 F7 F7 (S7) softkey 7 Yellow menu option 3
F14 F8 F8 (S8) softkey 8 Yellow menu option 4
F17 No label F9 (S9) softkey 9 Cyan menu option 1
F18 No label F10 (S10) softkey 10 Cyan menu option 2
F19 No label F11 (S11) softkey 11 Cyan menu option 3
F20 No label F12 (S12) softkey 12 Cyan menu option 4
Help Clear line Print Scr ------ Display specific help on current operation
or
View general help displays
Do ------ ------ ------ Same as Enter
PF1 * Pause FILE Select FILE mode
PF2 / / ADD Select ADD mode
PF3 + * EDIT Select EDIT mode
PF4 -- -- SET Select SET defaults
Find Insert char Insert Find Position Move cursor to specified X, Y position
Insert Here Insert line Home Modify Element Modify non-geometric attributes of an
element
or
ISA symbol
or
text element
or
polygon (open/closed)
Remove Delete line Delete Cancel Cancel the current operation
Select Select End Unpick All Deselect all selected elements

C Prev scr Prev Page

Up
Zoom Out / Prev Redraw display at normal size
or
Go to previous option/attribute
Next scr Next Page Zoom In / Next Redraw display at twice current size
Down or
Go to next option/attribute

UM6.1:SW3151 Revision H — July 1996

 Keyboard Reference C-9

Table C-3 Graphic Display Editor Keys (Continued)

Key Name
Label or
DEC HP IBM-PC Meaning Description
Y Y Y Up Move cursor up one pixel
(Up Arrow) (Up Arrow) (Up Arrow) or
Next value for modify field
or
Next menu option
B B B Down Move cursor down one pixel
(Down (Down (Down or
Arrow) Arrow) Arrow) Previous value for modify field
or
Previous menu option
A A A Left Move cursor left one pixel
(Left Arrow) (Left Arrow) (Left Arrow)
" " " Right Move cursor right one pixel
(Right (Right (Right
Arrow) Arrow) Arrow)
KP 7 KP 7 KP 7 North-west Move cursor northwest one character cell
KP 8 KP 8 KP 8 North Move cursor north one character cell
KP 9 KP 9 KP 9 North-east Move cursor northeast one character cell
KP 4 KP 4 KP 4 West Move cursor west one character cell
KP 5 KP 5 KP 5 Home Move cursor to display center
KP 6 KP 6 KP 6 East Move cursor east one character cell
KP 1 KP 1 KP 1 South-west Move cursor southwest one character cell
KP 2 KP 2 KP 2 South Move cursor south one character cell
KP 3 KP 3 KP 3 South-east Move cursor southeast one character cell
KP 0 KP 0 KP 0 Show Cursor Show the current cursor position
KP , KP , KP + Move Move selected element(s)
Tab Tab Tab Unmake conditnl Unmake a conditional element
Enter Enter Enter Enter / Do Take action
or
Start a pick box
Return Return Return Return Same as Enter (except in ADD Text,
where a new line is started)
Delete Delete Delete ------ Delete a character in text operation
Otherwise cancel operation
Ctrl-w Ctrl-w Ctrl-w Refresh Refresh entire screen
(and abort current operation)
Ctrl-a Ctrl-a Ctrl-a Insert/Overstrike Switch between insert and overstrike mode
or when in text operations
Abort Load or
Aborts LoadDis and LoadBuf options
Ctrl-n Ctrl-n Ctrl-n Window Resize Resize Graphic Display Editor window
to next size (choice of four sizes)
C
Note: If you are using an IBM-PC standard keyboard, turn On the NUM LOCK for cursor movement keys; otherwise, you
must use the SHIFT key before each use of a cursor movement key.

Revision H — July 1996 UM6.1:SW3151

 C-10 Keyboard Reference

C.5 Keyboard Layouts

The figures on the following pages show keyboard mapping for each
keyboard type which can be used for ENVOX forms navigation, the
ENVOX language editor, and the ENVOX display editor.
See the following figures for your keyboard layout:
J DEC LK201 Keyboard—Forms Navigation: Figure C-2
J DEC LK201 Keyboard—Language Editor: Figure C-3
J DEC LK201 Keyboard—Display Editor: Figure C-4
J HP Keyboard—Forms Navigation: Figure C-5
J HP Keyboard—Language Editor: Figure C-6
J HP Keyboard—Display Editor: Figure C-7
J IBM-PC Keyboard—Forms Navigation (Accessing OpenVMS or
UNIX): Figure C-8
J IBM-PC Keyboard—Language Editor (Accessing OpenVMS):
Figure C-9
J IBM-PC Keyboard—Language Editor (Accessing UNIX): Figure C-10
J IBM--PC Keyboard—Display Editor (Accessing OpenVMS or UNIX):
Figure C-11

Values Find Find Last Insert Prev Next Erase Enter Erase
Exit List Row Null Tag Row Field Field Row Default Entry

DEC LK201 Keyboard

F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12 F13 F14 Help Do F17 F18 F19 F20

PF1 PF3

Prev Next

Enter

C
Prev Next Toggle Detail
Screen Screen Menu Help

Figure C-2 Forms Navigation on a DEC LK201 Keyboard

UM6.1:SW3151 Revision H — July 1996

 Keyboard Reference C-11

Find Exit Prev End

Print Replace Field
Values Find Next Open/ Enab/ More Erase
List Null Home Field Close Disab Functs Entry

DEC LK201 Keyboard

F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12 F13 F14 Help Do F17 F18 F19 F20

Find Insert Re--

Here move
PF1 PF2 PF3 PF4
Se-- Prev Next
lect

Enter

Prev Next Gold Exit

Screen Screen Preview
Detail
Help
Figure C-3 Language Editor on a DEC LK201 Keyboard

Find Modify
Position Element Cancel

DEC LK201 Keyboard

White Yellow Cyan

F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12 F13 F14 Help Do F17 F18 F19 F20

File Add Edit Set

Find Insert Re-

Here move
PF1 PF2 PF3 PF4
Se-- Prev Next 7 8 9 --
lect
4 5 6 +
Home

1 2 3 Enter

0 .

Unpick Zoom out/ Zoom in/ Show Move

C
All Next Fld Next Fld Position
Modify
Color
Figure C-4 Display Editor on a DEC LK201 Keyboard

Revision H — July 1996 UM6.1:SW3151

 C-12 Keyboard Reference

Find Last Prev Erase Enter Erase

Row Tag Field Row Default Entry
Values Find Insert Next Menu Field
List Null Row Field Toggle Help

HP-UX Keyboard

f1 f2 f3 f4 f5 f6 f7 f8 f9 f10 f11 f12

Insert Delete
line line * / + --

Insert Delete
char char
7 8 9 Enter

Prev 4 5 6 ,

Select Next 1 2 3 Tab

0 .

Next Prev
ScreenScreen
Figure C-5 Forms Navigation on an HP-UX Keyboard

Find Exit Prev End Enab/ Erase

Repl Field Disable Entry
Print Find Home Next Open/ More
Null Field Close Functs

HP-UX Keyboard

f1 f2 f3 f4 f5 f6 f7 f8 f9 f10 f11 f12

Gold Preview Detail Exit

Help
Insert Delete
line line * / + --

Insert Delete
char char
7 8 9 Enter

Prev 4 5 6 ,

Select Next 1 2 3 Tab

0 .

C
Next Prev Find Insert Help
Screen Screen
Figure C-6 Language Editor on an HP-UX Keyboard

UM6.1:SW3151 Revision H — July 1996

 Keyboard Reference C-13

HP-UX Keyboard
White Yellow Cyan

f1 f2 f3 f4 f5 f6 f7 f8 Help f9 f10 f11 f12

Modify
element Cancel File Add Edit Set

Insert Delete
line line * / + --

Insert Delete
char char
7 8 9 Enter

Prev 4 5 6 ,

Select Next 1 2 3 Tab

0 .

Unpick Find Zoom In/ Zoom Out/ Home Show Move

All Position Nxt Fld Prv Fld Position

Figure C-7 Display Editor on an HP-UX Keyboard

Revision H — July 1996 UM6.1:SW3151

 C-14 Keyboard Reference

Find Last Prev Erase Enter Erase Delete

Row Tag Field Row Default Entry Character
Values Find Insert Next Help Prev Next Menu
List Null Row Field Screen Screen Toggle

IBM-PC Keyboard

Esc F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12

Page Num / * --
Up Lock

Delete
Page 7 8 9
Down
+
4 5 6
Gold = Ctrl-g
1 2 3 Enter

0 .

Figure C-8 Forms Navigation When an ENVOX System (Either OpenVMS or HP-UX) is
Accessed through an IBM-Compatible PC

Prev End Enab/ Erase Next

Field Disable Entry Screen
Next Open/ More Prev
Field Close Functs Screen Exit

IBM-PC Keyboard

Esc F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12

Page Num / * --
Print = Ctrl-a
Up Lock
Find Repl = Ctrl-b Page 7 8 9
Down
Find Error/Null = Ctrl-c +
Exit = Ctrl-d 4 5 6
Home = Ctrl-e
Gold = Ctrl-g 1 2 3 Enter
Preview = Ctrl-j
Detail Help = Ctrl-k 0 .

C
Find Select Insert Help

Figure C-9 Language Editor When ENVOX OpenVMS System is Accessed through an
IBM-Compatible PC

UM6.1:SW3151 Revision H — July 1996

 Keyboard Reference C-15

Find Exit Prev End Enab/ Erase Next Detail

Repl Field Disable Entry Screen Help
Print Find Home Next Open/ More Prev Preview Exit
Values Null Field Close Functs Screen
List

IBM-PC Keyboard

Esc F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12

Page Num / * --
Up Lock
Page 7 8 9
Down
+
4 5 6
Gold = Ctrl-g
1 2 3 Enter

0 .

Find Select Insert Help

Figure C-10 Language Editor When an ENVOX HP-UX System is Accessed through an
IBM-Compatible PC

Find Modify Zoom Out/

Position Element Prev Fld File Add Edit Set

IBM-PC Keyboard
White Yellow Cyan

Esc F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12 Help Pause

Page Num / * --
Insert Home Lock
Up
Page
Delete End Down
7 8 9
+
4 5 6
Home

1 2 3
0 . Enter

Cancel Unpick Zoom In/ Show Move

All Next Fld Position

Figure C-11 Display Editor When an ENVOX System (Either OpenVMS or HP-UX) is Accessed C
through an IBM-Compatible PC

Revision H — July 1996 UM6.1:SW3151

 C-16 Keyboard Reference

C.6 Trace/Tune Keys and Keywords

Table C-4 lists the keywords, function keys, and their corresponding
actions for the Trace/Tune utility.

Table C-4 Trace/Tune Keys and Keywords

Keyword Function Key Action
RUN LCP PF1 Initiates execution of an idle LCP

STOP LCP PF2 Stops continuous execution of an LCP

CONTINUE PF3 Advances the LCP to the next breakpoint
STEP PF4 Advances the FST a single step from the breakpoint
IO F17 Lets you examine or override any I/O channel value
TUNE F18 Lets you examine or change any point’s detail display
parameters (DDPs)
REGISTER F19 Lets you examine or change any LCP register values
ACCUMULATOR F20 Lets you examine or change the SVA, SVP, or SVD
RESTORE F8 CANCEL Clears all overrides and all trace points from all LCPs
for the device
NEXTSCREEN, Next Screen, Toggles between the main trace display and the I/O
PREVSCREEN Prev Screen display, or between help screens
EXIT F10 Exits to the previously displayed prompt or menu
PRINT F2/ Print Prints the current display

HELP F15/ Help Selects the help display

None F7 RESUME Returns to the previous display from the help display
None Return Enters the data after you’ve typed in a keyword or a
response to a prompt
None Return Displays the previous prompt if you have not typed in a
keyword or responded to a prompt
None Right arrow Slews up to next REGISTER, DDP, CHANNEL, or
STEP
None Left arrow Slews down to previous REGISTER, DDP, CHANNEL,
or STEP
None Hold Screen Prevents the software from updating the screen
None Do Executes a highlighted option

None Select Works like Do

UM6.1:SW3151 Revision H — July 1996

 Keyboard Reference C-17

C.7 Diagnostic Utility Keys

Table C-5 lists the dedicated keys for the diagnostics utility.

Table C-5 Diagnostics Utility Dedicated Keys

Dedicated Key Diagnostic Control Action
Return Enters a menu selection
/ Exits the display you are in and returns to the previous
prompt or menu
Exits the Diagnostics Executive menu
Returns to the previous prompt or menu if you are at a
prompt
Exits any menu and returns to the previous prompt
Hold Screen Stops the screen from updating

Return Enters a menu selection, prompt response,

PF1 Moves the cursor between the menu bar and the work area
Right arrow Moves the cursor to the next right-hand menu selection
Left arrow Moves the cursor to the next left-hand menu selection
Up arrow At a prompt, acts as a right arrow key
In a menu, moves the cursor up one option
Down arrow At a prompt, acts as a left arrow key
In a menu, moves the cursor down one option
Next Screen When you are navigating in a menu option from a
pull-down menu, pages forward in a multipage display
Prev Screen When you are navigating in a menu option from a
pull-down menu, pages backward in a multipage display

Revision H — July 1996 UM6.1:SW3151

 C-18 Keyboard Reference

C.8 Using PCs for ENVOX Software

You may use an IBM-compatible personal computer to navigate in
ENVOX forms and to access the ENVOX language editor and display
editor. The PC acts as an X-terminal window to the ENVOX software.
This feature is applicable to either OpenVMS or UNIX based systems.

A suggested setup is a PC having a “standard PC keyboard”, running NT

windows, and using EXCEED, version 4, for the keymapping. An ENVOX
OpenVMS system can be running a Multinet TCPIP. An ENVOX UNIX
system can be running TCPIP with the HP-UX machine used as a host.

Use the settings listed below to setup an IBM-PC. Once you have setup
the PC, refer to subsection C.2 for forms navigation keyboard mapping,
subsection C.3 for the language editor key mapping, and subsection C.4
for the display editor keymapping.

J For an OpenVMS system, enter the following commands:

$ SET DISPLAY/CREATE/NONE=nnnn/TRANS=TCPIP
(where nnnn is the node name of your PC)
$ DEFINE SYBASE_TERM XTERM_C.PC1

$ DEFINE SYB_FONT *-Courier-Medium-R-Normal--18--*

(or whatever font on your PC which you wish to use)
$ ENVOX == $ENVOX$APPLICATION:X_ENVOX

J For a UNIX system with an HP-style keyboard, enter the following

commands:

$ EXPORT DISPLAY = nnnn:0.0

(where nnnn is the node name of your PC)
$ EXPORT SYBASE_TERM = xterm_c.pc2

J For a UNIX system with an IBM-style keyboard manufactured by HP,

no setup is necessary because the keymapping emulates an IBM-PC
keyboard.

UM6.1:SW3151 Revision H — July 1996

 Glossary-1

Glossary
Algorithm Batch
A set of logical steps to solve a problem A specific quantity of a given product,
or accomplish a task. A computer produced in a single complete processing
program contains one or more procedure.
algorithms. Many configurations of
PROVOXr systems also contain
CDV
algorithms, particularly in operations,
Acronym: Comma Delimited Values
procedures, and function sequence
tables.
CHIP
Acronym: Computer/Highway Interface
Analog Input (AI) Package
A PROVOX point type. An analog input
point receives a single analog value, the
process variable. Comma Delimited Values Format
An ASCII version of configuration data.
The configuration data are in a specific
Analog Output (AO) order, separated by commas. CDV-format
A PROVOX point type. An analog output files result from both the export utility and
point generates a single analog value, the migrate utility.
the setpoint.
Computer/Highway Interface
Package (CHIP)
ASCII A PROVOX software product that allows
1. A standard digital encoding scheme for user-written programs to interact with the
data: a 7-bit binary code represents PROVOX database. There are different
numbers, letters, symbols, and control CHIP versions, so that any of several
codes. (The designation is an acronym types of computers can be the host
for American Standard Code for computer.
Information Interchange.)
2. A PROVOX point type. An ASCII point
contains a single real value, referenced Configuration (CONFIG)
by the setpoint attribute, and an Giving instructions and supplying
80-character ASCII string. reference information to the controllers
and other devices that make up a
process control instrumentation system.
Audit Trail For some PROVOX systems,
A record of changes made to the configuration consists of responding to
ENVOXr database and to the system prompts in a series of console screen
where the database resides. The record displays. For other PROVOX systems, Glossary

includes the type of change, when the configuration consists of creating and
change was made and who made it. manipulating special ASCII text files.

Revision H — July 1996 UM6.1:SW3151

 Glossary-2

Configuration Source File Detail Display Parameter (DDP)

A special ASCII text file that certain An item of information usually considered
PROVOX systems use for configuration. changeable or tunable for a control loop
Such a source file contains instructions or point. Common examples are gain,
and reference information for the rate, reset, and alarm trip points.
controllers and other devices in the
system. Device
A piece of electronic hardware that
performs one or more prescribed
Console Trend Display (CTD) functions.
A PROVOX software product that collects
process operating data for continuous
control applications, then presents the Discrete Control Device (DCD)
data in a graphical trend format on the A PROVOX point type. A DCD point
operator console. CTD layers on CHIP encompasses as many as 8 discrete
software. output and 16 discrete input channels
into a single point. This makes possible
16 setpoints and matching input/output
Data states. A common use for a DCD point is
A general term that denotes any to control a discrete device that provides
information an MPU can process. feedback about its status. If the point
works with a DCD template, it can use
different combinations of channels at
Database different times during the execution of a
A collection of data stored in a systematic process-control algorithm.
way so that searches and sorts are rapid
and so that retrieval of items is simple. Discrete Input (DI)
A PROVOX point type. A DI point
monitors a single discrete value of the
Database Index (DBI) process variable. That is, a DI point reads
A sequential integer by which a computer discrete data from a sensor or other
or other electronic device finds or keeps system device.
track of storage locations in a database.
Discrete Output (DO)
A PROVOX point type. A DO point
Datatype generates a single discrete value
Determines the rules that entries for referenced by the setpoint.
specific columns must follow.
Download
DBI To transfer configuration instructions and
Acronym: Database Index reference information from a
configuration device to other devices of a
process control system.
DCL
Acronym: Digital Command Language Dump Device
A tape or disk device to which a
Glossary database and its associated transaction
DDP log can be copied to usually for backup
Acronym: Detail Display Parameter purposes.

UM6.1:SW3151 Revision H — July 1996

 Glossary-3

ED Exception
Acronym: Emergency Download A type of unsolicited reporting: the
reporting device sends a new value only
if the sample period has expired and the
Emergency Download value has changed significantly since the
A download from a special download file last transmission.
while the SYBASE server is not available
or if the ENVOX database is suspect. Export
The extraction of ENVOX configuration
data and placing it in CDV files.
Engineering Units (EU)
The units of measurement for percentage Export Set
values of an analog process variable. CDV files prepared for import to an
Possible examples are gallons per hour, ENVOX database.
degrees Celsius, and pounds per square
inch. The low (0 percent) and high (100
percent) engineering unit limits define the FST
anticipated range of the variable. For Acronym: Function Sequence Table
example, low and high engineering-unit
values of 50 and 1550 might define a Function Sequence Table (FST)
range for degrees Fahrenheit. In this A list of controller instructions to perform
example, the EU span would be 1500 specific logical and mathematical
degrees; each percent of the EU span operations, in a specific order. An FST
equals 15 degrees. resembles a sequence of programming
subroutines, but defining an FST does
not involve actual computer
ENVOXr Software programming.
A Fisher--Rosemount Systems’ line of
configuration products for PROVOX Group
systems. The use of a third--party A PROVOX point type. A group point
relational database is the principle controls as many as 8 DCD points so that
distinguishing feature of configuration they work in unison. A Group point uses
with ENVOX software. a Group template which contains up to
16 setpoints for driving DCD point
setpoints. the user defines group
ENVOXDB Database templates as part of system
The default user database which stores configuration.
all configuration data and is created by
ENVOX software upon ENVOX Group Display
installation. A set of 12 point templates that appear
together on a PROVOX console screen,
so that an operator can see at a glance
envox_readonly Database the most important information about 12
An ENVOX system database containing different points. During system
reference data which is used by all of the configuration, the user establishes the
ENVOX user databases in the system. number of group displays, as well as Glossary

The database is created by ENVOX which point faceplates make up each

software upon ENVOX installation. group display.

Revision H — July 1996 UM6.1:SW3151

 Glossary-4

HART Instrument Locator Tool (HILT) Item

The HART Instrument Locator Tool (HILT) A general term for an ENVOX database
is a standalone utility run from the entity. Items include device definitions,
ENVOX command line. The utility gathers points, and templates.
information about smart field devices
connected to a PROVOX system through LCP
configured controllers. HILT stores the
Acronym: Logic Control Point
collected information in a Comma
Delimited Values (CDV) file specified by
the user so that Asset Management Load
Solutions (AMS) can correctly address A software-initiated action on a database.
the instruments when the need arises. The term refers to the SYBASE database
load function and not the Open Database
load utilities embedded in ENVOX
HP-UX software.
Hewlett Packard’s version of the UNIX
operating system. Locks
A software-initiated action on a database
table. The database software locks tables
IAC that are being affected by a process. The
Acronym: 1. (adjective): interactive. 2. ENVOX administrator can determine
(noun) interactive controller which processes are locking which
tables.

Import Logical Device

The process of placing configuration data A designated area on a disk for
into an ENVOX database from CDV file databases and transaction logs. A
format. database and its associated transaction
log should be on separate physical
devices, if possible. Logical devices are
used on VMS systems, AIX systems, and
Information stream some HP systems.
The first stream in a CDV file.
Logical Volume
Designated areas mapped by the
Interactive Controller (IAC) operating system across one or more
A regulatory controller, part of a disks for databases and transaction logs.
PROVOX instrumentation system, that
handles from one to eight control loops.
Logic Control Point (LCP)
A PROVOX point type for an advanced
batch or multifunction controller, such as
ISQL a UOC or IFC. A role for a multivariable
SYBASE’s stand-alone utility program for point, an LCP calls a programmed
database queries. subroutine defined by an FST. As
configured, the LCP activates the FST in
Glossary a continuous loop, as a single shot
IO or I/O program, or as required as part of a
Acronym: Input/Output control loop.

UM6.1:SW3151 Revision H — July 1996

 Glossary-5

Loop Operation
1. A control loop. [See Unit Operation]
2. A PROVOX point type. A loop point
provides control for a continuous Operator Workplace Console
process. Loop points have many (WPCON)
attributes, so can provide very The PROVOX console products that are
sophisticated control. Bias or ratio factors used in the PROVOX operator workplace
often can be added to loop points. concept. The consoles use a global
database configuration and have
high-resolution graphics, ergonomically
Master Database designed keyboards, and color printers.
The central database which holds details
of all of the other databases. It is created
PDF
by SYBASE when SYBASE is installed.
Acronym: PROVOX Display Format

Migrate Plant Management Area (PMA)

The process of converting PROFLEX A collection of plant process areas
configuration data into CDV file format, (PPAs). A PMA controls the console point
from which the data can be imported into reporting load, and indirectly, central
an ENVOX database processing unit (CPU) loading.

Plant Process Area (PPA)

Model Database Within a process-control system, a
The database which is used as the basis collection of equipment that uses a
for a new database. It is created by common alarm strategy.
SYBASE when SYBASE is installed.
PMA
Acronym: Plant Management Area
Null
Having no assigned value. In a CDV file, Point
null is represented as two commas with A set of process-control parameters and
zero or more spaces in between. data. The makeup and structure of each
point depends on its role in collecting and
OpenVMS reporting data and the type of device in
A mark of Digital Equipment Corporation which the point resides. Points are the
for one of the firm’s computer operating most important logical units of a process
systems; an acronym for Open Virtual control system; the number of points is a
Memory System. OpenVMS provides an measure of the system’s size and
operating environment for technical sophistication.
applications of VAX computers and
certain other computer systems. Primary Control Algorithm (PCA)
The principle control equation of a
continuos loop in a PROVOX system.
Operand The PCA type and station (STA) type
1. In the language editor, a value that defined during configuration determine
modifies or qualifies a function. the main functionality of a point.
2. In ASCII configuration source files, an Glossary

expression, a simple operand, a phrase PPA

list, or an operand list. Acronym: Plant Process Area

Revision H — July 1996 UM6.1:SW3151

 Glossary-6

Process PROVUEÒ Console

A user-initiated action that affects or The Fisher--Rosemount Systems’ line of
accesses a database. Each process console products for PROVOX systems
represents one connection to the server. that use a global database configuration
An ENVOX user typically has three to five and have high--resolution graphics,
processes active at once. Adding a point, ergonomically designed keyboards, and
generating files, and downloading files color printers.
are examples of processes. The ENVOX
administrator can determine which users Register
have initiated which processes and can A memory location for temporary storage
also kill processes. of a value.

SAM
Acronym: System Administration
Process Variable (PV) Manager (The HP-UX system
In process control, a measurable quality administration utility)
or quantity whose change can cause
other changes in the process, or make Setpoint (SP)
such changes possible. Common An input variable that contains the
process variables are temperature, desired value for a process variable.
percent full, and rate of flow. The term Control loop algorithms compare the
measured variable is a synonym. process variable with the setpoint, to
determine an appropriate output.

Signal Value Analog (SVA)

The analog floating point portion of the
PROFLEXr Software
accumulator register in a controller FST.
A Fisher--Rosemount Systems’ line of
configuration software products for
Signal Value Discrete (SVD)
PROVOX systems. ASCII text files are
The discrete portion of the accumulator
the principal distinguishing feature of
register in a controller FST.
configuration through a PROFLEX
device. Signal Value Percent (SVP)
The analog percentage portion of the
accumulator register in a controller FST.
PROVOXr Process Control Products Streams
The Fisher--Rosemount Systems’ line of A series of data fields separated by
process control products used in commas (CDV format), representing a
PROVOX process measurement configuration item. Streams begin with a
systems. It is a distributed control and keyword called an identifying field. This
data acquisition system that keyword identifies the stream type (for
communicates over a data highway. example, UOC_GROUP). Streams end
with the keyword END.

Substreams
PROVOX Display Format (PDF) A series of data fields within a stream,
Glossary ASCII-based format used for operator separated by commas (CDV format) that
screen displays on PROVOX system begins with a keyword, and continues
consoles. until the next keyword.

UM6.1:SW3151 Revision H — July 1996

 Glossary-7

Sybsysproc Database processing errors or system failures

Used in SYBASE SYSTEM 10. It is the occur, transactions which have not
database which holds stored procedures properly completed are not applied to the
that were previously held in the master data file, and the memory cache copy of
database. It is created by SYBASE when the affected data is restored from the
SYBASE is installed. data file. The transaction log is not the
Audit Trail log, but rather contains
SYBASE-only information.
Tag
A unique identifying mnemonic or label
for a controller or point of a process Tuning
control system. The adjustment of control terms or
parameter values to produce a desired
control effect.
Target Device
Any system device that receives point
information, commonly a display device Tuning Parameter
that shows the information to an operator. A parameter adjustable without
reconfiguration; an operator adjusts such
a parameter to alter control effects.
Tempdb Database Common examples are gain, rate, reset,
The database in which all temporary and alarm trip points. Such parameters
tables are created. It is created by appear in detail displays.
SYBASE when SYBASE is installed.

Unit
Template 1. A defined group of specific process
A pattern for valid relationships among equipment that processes a particular
elements of a control strategy, defined batch. For control purposes, such a unit
without specifying particular elements. A is one entity.
template permits different specific 2. A PROVOX point type. A unit point has
elements to use the relationships at many attributes, enabling it to control the
different times during the execution of the execution of a unit operation.
control algorithm. The user establishes
templates as part of system
configuration. [See Alias Template, DCD
Template, and Group Template.] Unit Operation
In batch control, a list of controller
instructions to perform specific
Transaction Log mathematical and logical functions, as
A log file maintained by the dataserver of part of a time-and-event sequence for a
all modifications to the database. As defined set of equipment (the unit). A unit
additions, updates, and deletions are operation consists of phases, each of
performed on data, these changes are which is a set of related steps. Each step
written to the transaction log. Once the is an elemental control action.
changes have been accepted by the user
process and the transaction is complete, Glossary

the changes are applied to the UOC

appropriate data file in the database. If Acronym: Unit Operations Controller

Revision H — July 1996 UM6.1:SW3151

 Glossary-8

Upload WPCON
The movement of configuration Acronym: Workplace Console. this
instructions from system devices to a acronym is used in ENVOX forms. See
configuration device or interface. An definition for an Operator Workplace
upload lets the current values of Console.
parameters be incorporated into new
configuration source files, eliminating
specific user entry. Uploads also may be
used to verify that configuration
instructions are correct.

Glossary

UM6.1:SW3151 Revision H — July 1996

 Index-1

Index
A Batch Generation Job Status form,
8-12
aborting, an inactive generate, 8-16 Batch Generation Queue Status
form, 8-13
Accum menu option, 11-10
BATCH HISTORY instruction, 7-25
accumulator, 11-21
batch job name, parameters, 8-10
ad hoc, 6-3
Batch Upload Status form, 10-6
ad hoc tag sets, 6-9–6-10 BLANK LINES instruction, 7-27
Add menu option, 5-1 BREAKPOINT MODE, 11-2
adding an item to the database,
5-1–5-11 C
alarm CDV format, A-2
conventions, 3-1 IST, B-3
management, 3-1
Change Trace Mode menu option,
Alarm-Priorities, summary report, 11-5
14-6
Clear menu option, 5-39
All Devices In List menu option, clearing a form, 5-39
8-19
cloning, console configurations,
application software, 2-3 5-34
applying, 4-12 colon, after fields, 4-10
ASCII data, importing, B-1–B-6 comments, 5-44
language editor, 7-14
audit trail, 3-5
event types, 15-3 communications
printing reports, 15-6, 15-9, 15-11 local area integrity display, 13-9
searching, 15-2 traffic statistics display, 13-15
unsolicited data control display,
audit trail reports 13-16
audit trail search, 15-1 computer requirements, 3-1
event detail, 15-1
history summary, 15-1 conditional color expressions,
creating from the language editor,
audit trail search report, 15-1 7-4
conditional text expressions,
creating from the language editor,
B 7-4
configuration, 2-3–2-8
backup image, download, 9-10
conventions
Backup to ED Files, 9-14 alarm, 3-1 Index

Revision H — July 1996 UM6.1:SW3151

 Index-2

display, 3-1
database, 10-1
D
documenting, 14-1–14-10 DAT cartridge tapes, 3-1
on-line, 10-1 data replace, 5-22
planning and design, 3-1–3-2
database, configuration,
configuration data, uploading, documenting, 14-1–14-10
10-1–10-20
DCDs, copying, 5-21
console DDPs, tuning, 11-24
alarm management, 3-1
configurations, upgrading, 5-47 debug. See trace/tune
copying a configuration, 5-32 default data, 4-15
reports, 7-23–7-29 default tag, 4-16
console reports, creating from the Define menu option, 11-5, 11-7
language editor, 7-3
Delete Items form, 5-37–5-38
Cont! menu option, 11-6 Delete menu option, 5-38
conventions, ENSTRUCT, manual, deleting items
1-4 device definition restrictions,
5-37–5-38
Copy Form menu option, 5-21–5-35 from the top-level, 5-36–5-38
copy modes destination form, 5-26
data replace, 5-22
detail display parameters, 10-14
fill--in, 5-22
overwrite, 5-22 detail display parameters (DDPs),
10-1
Copy Other menu option, 5-21 tuning controller DDPs, 11-7
copying Detail menu option, 14-2
console configuration, 5-21, 5-32 Detail!, menu option, 15-8
DCD Templates, 5-21
device definitions, creating,
FSTs, 5-21
5-1–5-48
group templates, 5-21
operations, 5-21 Device-Configuration, summary
point data, 5-28 report, 14-5
Device-Target-Points, summary
Count! menu option, 15-5
report, 14-5
Cross-Ref menu option, 14-2 diagnostics, 3-10
cross-ref reports, 14-7 diagnostics displays, 13-8–13-16
Input-Output Usage, 14-7 device integrity, 13-10–13-12
Item-Usage, 14-7 device revision information,
Logic-References, 14-7 13-13–13-14
Points-Without-DSR, 14-7 local area integrity, 13-9
Template-Usage, 14-7 logging, 13-17
system integrity, 13-8–13-9
Current Device menu option, 8-19 traffic statistics, 13-15
cutting and pasting in the language unsolicited data control, 13-16

Index
editor, 7-15 Diagnostics menu option, 13-2

UM6.1:SW3151 Revision H — July 1996

 Index-3

diagnostics utility, 13-1–13-18 downloading a device from, 9-16

menu hierarchy, 13-2 entering data, 4-10
display editor, overview, 3-9 ENVOX documentation, 1-6
Display-Content, summary report, ENVOX system, software version,
14-5 1-1–1-2
Display-List, summary report, 14-5 errors, 5-45–5-46
displays Event Detail, form, 15-10
conventions, 3-1
diagnostics, 13-8–13-16 event detail report, 15-1
overview, 2-8 exit, forms, 4-12
Displays, summary report, 14-5 export_setup utility, A-20
Document menu option, 14-1 exporting configuration data,
A-15–A-24
documentation, 3-10
audit trail, 15-1 exporting database data, A-18
ENVOX, 1-6 extra data, 5-5
documenting the database, 6-1
Download Backup form, 9-1
F
download status words, 9-5
fields, group, 4-19
Download-Information report, 14-7
fill--in, 5-22
downloading configuration data,
9-1–9-18 find and replace, 7-16
building a list of devices, 9-3–9-7 find function, 4-20, 8-19, 9-9
Download Backup form, 9-1
download utility, 3-5, 3-10 finding tags, 6-1
from a backup image, 9-10 FORM FEED instruction, 7-27
from a non-ENVOX machine, form help, 3-12
9-13
from an emergency download forms
(ED) file, 9-13 Batch Generation Queue Status,
report form, 9-10 8-13
starting, 9-1, 9-7 Batch Upload Status, 10-6
steps involved, 9-1 clearing, 5-39
when SYBASE server is copying data, 5-21
unavailable, 9-13 Database Space Information,
4-25
definition, 3-7–3-8
E Download Backup, 9-1
Download Options, 9-3
Edit FST! menu option, 7-2 editing, 4-10
Event Detail, 15-10
emergency download, 9-13
exiting, 4-12
from a non-ENVOX machine,
Export, A-16–A-24
9-17
extra data, 5-5
emergency download (ED) files for pulse count input (PCI) point,
creating, 9-13 4-10 Index

Revision H — July 1996 UM6.1:SW3151

 Index-4

Generate Errors, 8-19 help

Generate Options, 8-1 display editor, 3-12
Generation Errors, 6-3 field-level, 3-12, 4-10
Generation Options, 8-3 form-level, 3-12
History Summary, 15-8 language editor, 3-12, 7-17
IAC/Computing Controller, 7-5 menu-option, 3-12
LCP Boolean Registers, 4-20 navigation, 3-12
LCP Floating Point Registers, help screens, printing, 4-21
4-20
LCP FST, 7-2 highway access control list, A-2
LCP Integer Registers, 4-20 Highway-Access Report, 14-7
navigation in, 4-2–4-9, 4-10–4-11
Operation, 7-3 Highway-Devices, summary report,
14-5
printing, 4-21
Procedure, 7-3 HILT, HART Instrument Location
saving data, 5-19 Tool, 12-1
Show Disk Space, 4-22 HILT Utility, Utilities, 12-1
Tag Set, 6-3
Upload, 10-3, 10-6 history instructions, 7-25–7-26
Whole Queue Status, 8-16 History Summary form, 15-8
FSTs, stepping through, 11-19 history summary report, 15-1
function sequence table (FST),
11-11
I
I/O, examining and overriding,
G 11-23
Generate Options form, 8-1 I/O SET-UP, 11-6–11-7
generating configuration data, 3-5, I/O, changing for IACs, 11-8–11-10
8-1–8-22 IAC trace/tune utility, 11-1
aborting an inactive generate,
8-16 IAC/Computing Controller form, 7-5
batch generation, 8-10–8-15 icons
reviewing errors and warnings, examples, 3-11
8-18 exit, 3-11
Generation Errors form, creating a imported data location, A-12
tag set, 6-9
importing, ASCII data, B-1–B-6
Generation Options form, 8-2
accessing, 8-3 importing bulk data, Open
Database Server, B-1
group fields, 4-19
include function, 7-10
Input-Output Usage, cross-ref
H reports, 14-7
instructions
hardware requirements, 3-1 adding, 7-6
HART Instrument Location Tool, modifying, 7-14
Index
HILT, 12-1–12-4 valid, 7-6

UM6.1:SW3151 Revision H — July 1996

 Index-5

Instrument Signal Tags (ISTs), 3-3, LCP Trace Tune menu option,
6-1 11-14
Instrument Signal Tags (ISTs), LCP trace/tune utility, 11-11
importing from ASCII, B-1 LCPs
interactive controller (IAC), 11-1 running, 11-20
stopping, 11-20
ISQL, 6-12
tracing, 11-17–11-26
ISTs, 3-3 learn feature, language editor, 7-20
Item Copy menu option, 5-21, 5-28 LIST HISTORY instruction, 7-25
Item-Usage, cross-ref reports, 14-7 location, imported data, A-12
logging, diagnostics displays, 13-17
K logic control point (LCP), 11-11
Logic menu option, 7-1
keyboard, navigating with, 4-9
logic sequences, 7-1
keys
for editing item forms, C-2–C-18 Logic-References, cross-ref
for menu options, C-1 reports, 14-7
for the diagnostic utility, C-17
for the language editor, C-4–C-18
for the trace/tune utility, M
C-16–C-18 maintenance. See diagnostics
manual conventions, ENSTRUCT,
1-4
L
Match Criteria! option, 6-1,
language editor, 7-1–7-30 6-5–6-12
accessing, 7-2 example forms, 6-9
comments, 7-14 menu keys, 3-11
cutting and pasting text, 7-15
finding and replacing text, 7-16 menu options
help, 7-17 Abort, 9-7
keyboard layout, 7-5 Accum!, 11-10
learn feature, 7-20 Ad Hoc Tag Set, 6-3, 6-9
overview, 3-9 Add, 5-1
printing ASCII text to a printer or All Devices In List, 8-19
file, 7-30 Backup All Devices, 9-10
split window feature, 7-18 Backup to ED Files, 9-14
Batch, 8-10
LAYOUT instruction, 7-23 Change Trace Mode, 11-5
LCP Boolean Registers form, 4-20 Clear, 5-39
Clear List, 8-6, 9-4
LCP Floating Point Registers form, Cont!, 11-6
4-20 Continue, 9-7
LCP FST form, 7-2 Copy console Configuration, 5-21
Copy Console Configuration,
LCP FST menu option, 7-3
5-32
LCP Integer Registers form, 4-20 Copy Form, 5-21–5-35 Index

Revision H — July 1996 UM6.1:SW3151

 Index-6

Copy Other, 5-21 View, 5-20

Count!, 15-5 View Current, 5-30
Cross-Ref, 14-2 View Item!, 5-37
Current Device, 8-19 Whole Queue!, 10-7
Define, 11-5, 11-7 X-List!, 4-20
Delete, 5-36–5-38 menus, 3-6
Delete!, 5-37 hierarchy, 4-2–4-9
Detail, 14-2 menu bar, 3-6, 4-9
Detail!, 15-8 navigation through, 4-2–4-9
Diagnostics, 13-2 pull-down, 3-6, 4-8, 4-9
Document, 14-1 slide-off, 3-6, 4-8
Download, 9-7
migration, 3-10
Download Backup, 9-11 format, A-15
Edit FST!, 7-2 PROFLEX data, 3-4
Extra Data, 5-5
Generate, 8-10, 8-16 modifying an item, 5-17
I/O, 11-8 using a tag set, 5-18
IAC Trace/Tune, 11-3 mouse, navigating with, 4-8
Interactive, 8-16
Item Copy, 5-21, 5-28
LCP FST, 7-2 N
LCP Trace Tune, 11-14 navigation
Logic, 7-2 help, 3-12
Match Criteria!, 6-1, 6-5–6-12 in the diagnostics utility, 13-6
Modify!, 5-17 in the language editor, 7-5
More, 8-2, 9-2, 10-3 inside a form, 4-10–4-11
Next!, 11-6 menu option, 4-2
Next!, 5-3 overview, 4-2–4-9
Notes, 5-44
Operation, 7-3 NEXT instruction, 7-27
Print, 15-6, 15-9, 15-11 Next! menu option, 11-6
Print!, 11-10 NORMAL MODE, 11-2
Print!, 8-21, 10-9
notes, 5-44
Process!, 7-3
Reg!, 11-9 Notes menu option, 5-44
Rename Item, 5-40
Report, 5-30
Retrieve!, 15-5 O
Save, 5-19 on-line help. See help
Select All Devices, 8-5, 9-3
operands, 7-8
selecting, 4-8–4-9
Show Current Errors, 8-20 Operation form, 7-3
Show Errors, 8-19 Operation menu option, 7-3
Show Report, 9-8
Operation-Indices report, 14-7
Step!, 7-3
Summary, 14-2 operations, creating from the
Tune!, 11-7 language editor, 7-3
Upload, 10-3, 10-4 Operator Workplace Console. See
Index
Utilities, 8-5, 8-6 console

UM6.1:SW3151 Revision H — July 1996

 Index-7

origination form, 5-26 printing

audit trail reports, 15-6, 15-9
overwrite, 5-22
diagnostics displays. See
logging, diagnostics displays
ENVOX, ASCII text from the
P language editor, 7-30
forms, 4-21
pattern tag, 4-16 generation errors and warnings,
PHRASE LIST instruction, 7-27 8-21
help screens, 4-21
Plant-Area-List, summary report, interactive upload information,
14-6 10-9–10-20
Plant-Area-PMA’s, summary report, Procedure form, 7-3
14-6
procedures, creating from the
Plant-Area-Points, summary report, language editor, 7-3
14-6
Process! menu option, 7-3
Plant-Area-PPAs, summary report, PROFLEX data, configuration files,
14-6 3-10
POINT HISTORY instruction, 7-25 PROFLEX data migration, 3-4
POINT LIST instruction, 7-27 PROVOX devices, hardware,
point reporting 2-1–2-3
change-of state, 2-6 computer/highway interface
packages (CHIPs), 2-2
overview, 2-6
controllers, 2-1
periodic, 2-6
data concentrator units (DCUs),
periodic by exception, 2-6
2-1
Point-Information, summary report, data highway, 2-1
14-5 intelligent device interface (IDI),
2-2
Point-Reporting, summary report,
14-5 multiplexers (MUXs), 2-2
operator workplace consoles, 2-2
points, 2-4–2-8 PROVUE consoles, 2-2
creating, 2-5–2-6, 5-1–5-48 traffic directors (NTDs, LTDs), 2-1
DCD, 2-5
PROVOX instrumentation systems,
input and output point types, 2-5 overview, 2-1
loop, 2-5
unit, 2-5 PROVUE console. See console
Points-Without-DSR, cross-ref
reports, 14-7 Q
PPA-States, summary report, 14-6
quitting, 4-12
PRINT instruction, 7-23
Print menu option, 15-6, 15-9,
15-11 R
Print! menu option, 11-10 redraw screen, C-3
Print! menu option, 8-21 refresh screen, C-3 Index

Revision H — July 1996 UM6.1:SW3151

 Index-8

Reg! menu option, 11-9 split window feature, language

editor, 7-18
register values, 11-22
changing IACs, 11-9 starting, logging on, 4-1
renaming an item, 5-40–5-44 status, item copy, 5-29
REPEAT instruction, 7-27 Status Page form, 4-22–4-26
report, previewing, 7-28 Step! menu option, 7-3
Report menu option, 5-30 Summary menu option, 14-2
reports summary reports, 14-5, 14-6
creating, 7-23–7-29 Alarm-Priorities, 14-6
edit display example, 7-29–7-30 Device-Configuration, 14-5
for documenting the database, Device-Target-Points, 14-5
14-1–14-10 Display-Content, 14-5
previewing, 7-27 Display-List, 14-5
reports, other, 14-7 Displays, 14-5
Highway-Devices, 14-5
Retrieve! menu option, 15-5 Plant-Area-List, 14-6
retrieving cleared data, 5-39 Plant-Area-PMA’s, 14-6
Plant-Area-Points, 14-6
Plant-Area-PPAs, 14-6
S Point-Information, 14-5
Point-Reporting, 14-5
Save menu option, 5-19 PPA-States, 14-6
Save To Tag Set! menu option, Trend-Information, 14-6
8-20–8-21 system integrity display, 13-8–13-9
saving, form data, 5-19
saving instruction sets, 7-21 T
search strings, 4-13–4-18
tag
searching, the audit trail, 15-12 default, 4-16
security areas, tag sets, 6-1 ENVOX, !!tags, 4-15
finding, 6-1
selecting with the keyboard. See
rules, 5-2
navigation; keyboard, navigating
with Tag Set Names, 9-3
selecting with the mouse. See tag sets
navigation; mouse, navigating with ad hoc, 6-9–6-10
Show Current Errors menu option, building a list of devices for
8-20 generation, 8-4
creating
software by entering manually, 6-5
how supplied, 3-1 from Tag Set form, 6-3
version, ENVOX, 1-1–1-2 using Match Criteria! option,
software requirements, 3-1 6-5
for security areas, 6-1
source devices, 6-6 form for creating, 6-3
Index
source point, 5-3 contents, 6-3

UM6.1:SW3151 Revision H — July 1996

 Index-9

Match Criteria! option, 6-1 tuning DDPs, 11-24

modifying items using, 5-18 trace modes, 11-13
Tag_set, access, ISQL, 6-12 Trend-Information, summary report,
14-6
tap, pattern, 4-16
tune. See trace/tune
tapes
DAT cartridge, 3-1 Tune! menu option, 11-7
TK50 cartridge, 3-1 tuning, 11-1, 11-11
target devices, 5-3, 6-6 tuning controller DDPs, 11-7–11-10
Target forms, hierarchy, 5-4 tuning values, for IACs, displaying
and changing, 11-7–11-10
Target! menu option, 5-3–5-4
targeting point data
source data, 5-3 U
target devices, 5-3
UNTIL END instruction, 7-27
target group, 5-3
UNTIL instruction, 7-27
Template-Usage, cross-ref reports,
14-7 UOC/IFC, upgrading, 5-47
templates Upgrade console menu option,
batch, 2-7 5-47
creating, 5-1–5-48 Upgrade UOC/IFC menu option,
discrete, 2-7 5-47
overview, 2-7 upload, 3-5, 3-10
TK50 cartridge tapes, 3-1 Upload form, 10-3, 10-6
trace mode uploading on-line configuration
BREAKPOINT MODE, 11-2, data, 10-1–10-20
11-13 batch, 10-5–10-7
changing, 11-5, 11-16–11-26 detail display parameters (DDPs),
NORMAL MODE, 11-2 10-2
WINDOW MODE, 11-2, 11-13 interactive, 10-8–10-20
limitations, 10-2
trace points, 11-5
uploadable point types,
clearing, 11-18, 11-21 10-2–10-5
Trace Points Display, 11-4–11-10, utilities
11-15–11-26 for reports, 14-1–14-10
trace/tune, 3-5, 3-10 HILT utility, 12-1
for IAC’s, 11-1–11-26
for IACs
changing I/O, 11-8 V
changing register values, 11-9
v, after fields, 4-13
displaying and changing tuning
values, 11-7–11-10 valid entries list, 4-12–4-18
I/O SET-UP, 11-6–11-7 values, 11-9
for LCP’s, 11-11–11-26
for LCPs values list key, C-2
tracing an LCP, 11-17 View menu option, 5-20 Index

Revision H — July 1996 UM6.1:SW3151

 Index-10

viewing wildcard, 4-14

configuration generation errors,
8-21 window. See split window feature
item data, 5-20–5-21 WINDOW MODE, 11-2
visible choice fields, 4-12–4-18

W X
warnings, 5-45–5-46 X-List! menu option, 4-20

Index

UM6.1:SW3151 Revision H — July 1996

 History-1

Document History
The list below shows the documents available for released ENVOX
software versions.

ENVOX P1.0

J Installing ENVOX Software and Migrating PROFLEX Data

PN4.14:SW3151 (Original — July 1990) D3P00481002

J Installing ENVOX Software and Migrating PROFLEX Data

PN4.14:SW3151 (Change 1 — December 1990) D3P00482012

J Using ENVOX Configuration Software

UM4:14:SW3151 (Original + Change 1 — December 1990)
D2U00481012

ENVOX P1.1

J Installing ENVOX Software and Migrating PROFLEX Data

PN4.14:SW3151 (Revision A — April 1991) D3P00481102

J ENVOX Tutor
TU4.14:SW3151 (Original — June 1991) D2T00481002

J Using ENVOX Configuration Software

UM4:14:SW3151 (Revision A — April 1991) D2U00481102

ENVOX P1.2

J Installing ENVOX Software and Migrating PROFLEX Data

PN4.14:SW3151 (Revision B — October 1991) D3P00481202

J ENVOX Technical Reference

TR4.14:SW3151 (Revision A — October 1991) D2R00481102

J ENVOX Tutor
TU4.14:SW3151 (Original — June 1991) D2T00481002

J Using ENVOX Configuration Software

UM4:14:SW3151 (Revision B — October 1991) D2U00481202

Revision H — July 1996 UM6.1:SW3151

History-2

ENVOX P2.0

J Installing ENVOX Software and Migrating PROFLEX Data

PN4.3:SW3151 (Revision C — October 1992) D3P00481302

J ENVOX Technical Reference

TR1.0:SW3151 (Revision B — September 1992) D2R00481202

J ENVOX Tutor
TU4.14:SW3151 (Original — June 1991) D2T00481002

J Using ENVOX Configuration Software

UM4:14:SW3151 (Revision C — October 1992) D2U00481302

ENVOX P3.0

J Installing ENVOX Software and Migrating PROFLEX Data

PN6.0:SW3151 (Revision D — December 1993) D3P00481402

J ENVOX Technical Reference

TR1.0:SW3151 (Revision C — December 1993) D2R00481302

J ENVOX Tutor
TU4.14:SW3151 (Original — June 1991) D2T00481002

J Using ENVOX Configuration Software

UM6.1:SW3151 (Revision D — December 1993) D2U00481402

ENVOX P3.2

J Installing Type SW3151 Configuration Software (VMS)

PN6.1:SW3151:VMS (Revision E — June 1994) D3P00481502

J Installing Type SW3153 Configuration Software (HP-UX)

PN6.2:SW3153:HPX (Original — January 1995) D3P01381002

J Installing Type SW3155 Configuration Software (ENVOX DEC AXP)

PN6.3:SW3155:AXP (Original — December 1994) D3P01391002

J Installing Type SW3157 Configuration Software (AIX)

PN6.4:SW3157:AIX (Original — January 1995) D3P01411002

J The System Manager’s Guide to ENVOX Configuration Software

SM1.0:SW3151 (Revision A — June 1994) D3R00501102

J ENVOX Technical Reference

TR1.0:SW3151 (Revision D — June 1994) D2R00481402

J ENVOX Tutor
TU4.14:SW3151 (Original — June 1991) D2T00481002

J Using ENVOX Configuration Software

UM6.1:SW3151 (Revision F — December 1994) D2U00481602

UM6.1:SW3151 Revision H — July 1996

 History-3

ENVOX P3.3

J Installing ENVOX Configuration Software on DEC VAX and DEC

AXP systems
PN6.1:SW3151:VMS (Original — June 1995) D3P01461002

J Installing ENVOX Configuration Software on HP-UX Systems

PN6.2:SW3153:HPX (Revision A — June 1995) D3P01381102

J Installing ENVOX Configuration Software on IBM AIX Systems

PN6.4:SW3157:AIX (Revision A — June 1995) D3P01411102

J The System Manager’s Guide to ENVOX Configuration Software

SM1.0:SW3151 (Revision C — June 1995) D3R00501302

J ENVOX Technical Reference

TR1.0:SW3151 (Revision E — June 1995) D2R00481502

J ENVOX Tutor
TU4.14:SW3151 (Original — June 1991) D2T00481002

J Using ENVOX Configuration Software

UM6.1:SW3151 (Revision G — June 1995) D2U00481702

ENVOX P3.4

J Installing and Upgrading ENVOX Configuration Software on DEC

VAX and DEC AXP Systems
PN6.1:SW3151:VMS (Revision A — July 1996) D3P01461102

J Installing and Upgrading ENVOX Configuration Software on HP-UX

Systems
PN6.2:SW3153:HPX (Revision B — July 1996) D3P01381202

J The System Manager’s Guide to ENVOX Configuration Software

SM1.0:SW3151 (Revision D — July 1996) D3R00501402

J ENVOX Technical Reference

TR1.0:SW3151 (Revision F — July 1996) D2R00481602

J ENVOX Tutor
TU4.14:SW3151 (Original — June 1991) D2T00481002

J Using ENVOX Configuration Software

UM6.1:SW3151 (Revision H — July 1996) D2U00481802

Revision H — July 1996 UM6.1:SW3151

History-4

This page intentionally left blank.

UM6.1:SW3151 Revision H — July 1996

 Notes

Notes

Revision H — July 1996 UM6.1:SW3151

Notes

Notes

UM6.1:SW3151 Revision H — July 1996

This page intentionally left blank.
UM6.1:SW3151