Using ENVOXr r Server and

Control Desktop

This manual applies to software version P5.0 only. For earlier

versions, retain the manual dated May 1998.

User Manual
UM:SW3159:EN
Original — May 2000
This manual supercedes the issue dated May 1998.
D2U01701002
DOCVUE, ENVOX, Fisher-Rosemount, Instrument Information System, PROVOX, and PROVUE are
marks of one of the Fisher-Rosemount group of companies.
All other marks are the property of their respective owners.

ã 2000 Fisher-Rosemount Systems, Inc. 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.
Using ENVOXr Server and Control Desktop Your Evaluation Please ... iii
(Original — May 2000)

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 this manual. 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
iv Your Evaluation Please ... Using ENVOXr Server and Control Desktop
(Original — May 2000)

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) 418-7503 8627 North MoPac, Suite 400
Attention: Technical Documentation Editor Austin, TX 78759
Using ENVOXr Server and Control Desktop Contents v
(Original — May 2000)

Contents

1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.1 Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.2 Product Version this Manual Supports . . . . . . . . . . . . . . . . . . . . . . 15
1.3 How to use this Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.4 First Release for Windows NT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
1.5 Enhancements in this Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
1.6 Structure of this Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
1.7 Conventions Used in This Manual . . . . . . . . . . . . . . . . . . . . . . . . . 18
1.8 Cautions and Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
1.9 ENVOX Server and Control Desktop Documents . . . . . . . . . . . . 21
1.10 Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
1.11 Electronic Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
1.12 Where to Find Answers About This Product or Manual . . . . . . . 22

2 Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
2.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
2.2 Product Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
2.3 Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
2.4 Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
2.5 Configuration Planning and Design . . . . . . . . . . . . . . . . . . . . . . . . 25
2.6 Configuration Engineering and Maintenance Tasks . . . . . . . . . . 26
2.6.1 Server and Client Administration . . . . . . . . . . . . . . . . . . . . . . . . . 27
2.6.2 Import/Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
2.6.3 Database Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
2.6.4 Tag Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
2.6.5 Control Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
2.6.6 Display Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
2.6.7 Logic Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
2.6.8 Generate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
2.6.9 Download . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
2.6.10 Portable Database Transfer (PDX) . . . . . . . . . . . . . . . . . . . . . . . 29
2.6.11 LCP Trace/Tune . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
2.6.12 Report Writer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
2.6.13 Upload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
2.6.14 Task Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
2.6.15 Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
2.6.16 Audit Trail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

3 User Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
3.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
3.2 Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
3.2.1 Help Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
vi Contents Using ENVOXr Server and Control Desktop
(Original — May 2000)

3.2.2 Help Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

3.3 Printed Manuals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
3.4 Books OnLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
3.5 Other Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

4 Startup and License Requirements . . . . . . . . . . . . . . . . . . . 39

4.1 Starting ENVOX Server Software . . . . . . . . . . . . . . . . . . . . . . . . . . 39
4.2 Starting Control Desktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
4.2.1 Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
4.2.1.1 Login from Login Toolbar Icon, Top-level Menu Admin
Option, or Context (Right Mouse) Menu . . . . . . . . . . . . . . . . 40
4.2.1.2 Login by Double Clicking a Server . . . . . . . . . . . . . . . . . . . . . 40
4.2.2 Customizing Control Desktop Options . . . . . . . . . . . . . . . . . . . . 41
4.3 Licensing Control Desktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
4.3.1 Managing Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
4.3.2 License File Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
4.3.2.1 Requesting Initial Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
4.3.2.2 Requesting Additional Licenses . . . . . . . . . . . . . . . . . . . . . . . 43
4.3.2.3 Requesting New Hardware Licenses . . . . . . . . . . . . . . . . . . . 44
4.3.2.4 Activating License Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
4.3.2.5 Viewing License Activation Status . . . . . . . . . . . . . . . . . . . . . 46

5 Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
5.1 ENVOX Server and Control Desktop Navigation . . . . . . . . . . . . . 47
5.1.1 Explorers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
5.1.1.1 Explorers’ Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
5.1.1.2 Explorer Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
5.1.1.3 System Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
5.1.1.4 Resource Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
5.1.1.5 Plant I/O Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
5.1.1.6 The Controller Device I/O Explorer . . . . . . . . . . . . . . . . . . . . . 52
5.1.2 Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
5.1.2.1 Top-Level Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
5.1.2.2 Pull-Down Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
5.1.2.3 Context Menu (Right Mouse Button) . . . . . . . . . . . . . . . . . . . 53
5.1.3 Toolbar Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
5.2 Accessing Modules and Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
5.2.1 From the Windows NT Start as Standalone Modules . . . . . . . 55
5.2.2 From within Control Desktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
5.3 ENVOX Server Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
5.4 Client Administration Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

6 Managing Configuration Items . . . . . . . . . . . . . . . . . . . . . . . 59

6.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
6.1.1 Introduction to the Item Detail Window . . . . . . . . . . . . . . . . . . . 60
6.1.2 Introduction to the Explorers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Using ENVOXr Server and Control Desktop Contents vii
(Original — May 2000)

6.1.3 Introduction to Matrix View and Excel Matrix . . . . . . . . . . . . . . 61

6.2 Using Item Detail Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
6.2.1 Creating a New Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
6.2.2 Create an Item from an Existing Item . . . . . . . . . . . . . . . . . . . . . 65
6.2.3 Editing Items in an Item Detail Window . . . . . . . . . . . . . . . . . . . 65
6.3 Using the Explorers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
6.3.1 Creating Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
6.3.2 Moving Items Using the Context Menu . . . . . . . . . . . . . . . . . . . 68
6.3.3 Moving Items Using Drag ’n’ Drop . . . . . . . . . . . . . . . . . . . . . . . 68
6.3.4 Deleting Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
6.3.5 Moving Targets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
6.3.6 Move F-C-C Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
6.4 Using Matrix View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
6.4.1 Opening Matrix View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
6.4.2 Default Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
6.4.3 Creating Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
6.4.4 Editing Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
6.4.5 Deleting an Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
6.4.6 Saving Changes to a Matrix View . . . . . . . . . . . . . . . . . . . . . . . . 74
6.4.7 Save Data to External Format . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
6.4.8 Load Data from External Format . . . . . . . . . . . . . . . . . . . . . . . . . 75
6.4.9 Customizing a Matrix View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
6.5 Copying Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
6.5.1 Unique Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
6.5.2 Group Field Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
6.5.3 Using Tag Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
6.5.4 Copying a Console Configuration . . . . . . . . . . . . . . . . . . . . . . . . 80
6.5.5 Cloning PROVUE and Operator Workplace Consoles . . . . . . 80
6.5.5.1 Restrictions on Cloning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
6.5.5.2 Changing an Existing Console to or from a Clone . . . . . . . . 82
6.6 Deleting Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
6.7 Renaming Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
6.7.1 Renaming with the Rename Item Application Option . . . . . . . 83
6.7.2 Renaming from the Command Line . . . . . . . . . . . . . . . . . . . . . . 84
6.8 Targeting Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
6.9 Instrument Signal Tags (ISTs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
6.10 Creating Instrument Signal Tags (ISTs) . . . . . . . . . . . . . . . . . . . . . 89
6.11 Validating Data Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

7 Tag Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
7.1 Configuration Tasks with Tag Sets . . . . . . . . . . . . . . . . . . . . . . . . . 92
7.2 Create a Tag Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
7.3 Tag Set Creation from ISQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
7.3.1 Appending Tag Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
7.3.2 Using Pattern Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
viii Contents Using ENVOXr Server and Control Desktop
(Original — May 2000)

8 Logic Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
8.1 Accessing the Logic Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
8.1.1 Procedures and Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
8.1.2 LCP FSTs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
8.1.3 Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
8.1.4 Conditional Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
8.2 Add an Instruction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
8.2.1 Entering Instruction Mnemonics . . . . . . . . . . . . . . . . . . . . . . . . . 101
8.2.2 Filling in the Operands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
8.2.3 Closing an Instruction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
8.3 Setting Logic Editor Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
8.4 Including Blocks of Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
8.5 Modifying Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
8.6 Adding a Comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
8.7 Cutting or Copying and Pasting Text . . . . . . . . . . . . . . . . . . . . . . . 106
8.7.1 Cutting or Copying and Pasting a Closed Instruction . . . . . . . 106
8.7.2 Cutting or Copying and Pasting Text Within Comments . . . . . 106
8.8 Finding and Replacing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
8.8.1 Using Find . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
8.8.2 Using Replace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
8.9 Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
8.10 Determining FST or Step Instruction Size . . . . . . . . . . . . . . . . . . . 109
8.11 Saving Your Instruction Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
8.11.1 Save with Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
8.11.2 Save without Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
8.12 Viewing Generation Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
8.13 Creating a Console Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
8.13.1 LAYOUT Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
8.13.2 HISTORY Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
8.13.3 REPEAT, NEXT, UNTIL, and UNTIL END Instructions . . . . . . 113
8.13.4 Additional Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
8.13.5 Previewing a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
8.13.6 Example Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
8.14 Printing Logic Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
8.14.1 Printing from the Logic Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
8.14.1.1 Printing All Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
8.14.1.2 Printing Selected Instructions . . . . . . . . . . . . . . . . . . . . . . . . . 117
8.14.1.3 Printing to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
8.14.2 Printing from the Item Detail Window . . . . . . . . . . . . . . . . . . . . . 117

9 Excel Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

9.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
9.1.1 Excel Matrix User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
9.1.2 Excel Matrix Connection with ENVOX Server . . . . . . . . . . . . . . 120
9.1.3 Workbooks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
9.1.4 Loop Configuration Workbook . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Using ENVOXr Server and Control Desktop Contents ix
(Original — May 2000)

9.1.5 Enhanced DCD Workbook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

9.1.6 Additional Menu Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
9.1.7 Multiple Concurrent Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
9.2 Installing the Add-In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
9.3 Launching Excel Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
9.4 Using Excel Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
9.4.1 Start a New Configuration Project . . . . . . . . . . . . . . . . . . . . . . . . 130
9.4.2 Create a Sample Workbook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
9.4.3 Transfer Data to and from the Database . . . . . . . . . . . . . . . . . . 131
9.4.3.1 Modify Existing Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
9.4.3.2 Open Data from an External Source . . . . . . . . . . . . . . . . . . . 132
9.4.3.3 Update the Database with New Data . . . . . . . . . . . . . . . . . . . 133
9.4.3.4 Examining Errors and Warnings . . . . . . . . . . . . . . . . . . . . . . . 133
9.4.4 Edit a Workbook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

10 Generate, Download, and Upload . . . . . . . . . . . . . . . . . . . . 137

10.1 Generating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
10.2 Downloading and Related Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
10.2.1 Downloading to Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
10.2.1.1 Downloading from Control Desktop . . . . . . . . . . . . . . . . . . . . 139
10.2.1.2 Downloading from The Task Monitor . . . . . . . . . . . . . . . . . . . 140
10.2.1.3 Downloading from A Command Prompt . . . . . . . . . . . . . . . . 141
10.2.2 Download Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
10.2.3 Downloading from Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
10.2.4 Emergency Downloading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
10.2.4.1 Creating an Emergency Download File from Control
Desktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
10.2.4.2 Creating an Emergency Download File From A
Command Prompt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
10.2.4.3 Downloading from an Emergency Download File . . . . . . . . 147
10.2.4.4 Emergency Download File Names . . . . . . . . . . . . . . . . . . . . . 147
10.3 Uploading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
10.3.1 Upload Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
10.3.2 Upload Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
10.3.3 Upload Failures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
10.3.4 Uploads to LCP Registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
10.3.5 Upload Data Precision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
10.3.6 Upload Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
10.3.6.1 Task Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
10.3.6.2 Upload Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
10.3.6.3 Upload Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
10.3.7 Uploadable Points and Their DDPs . . . . . . . . . . . . . . . . . . . . . . 157

11 Using LCP Trace/Tune . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

11.1 LCP Trace/Tune Module Overview . . . . . . . . . . . . . . . . . . . . . . . . . 165
11.1.1 LCP Trace/Tune Module Window . . . . . . . . . . . . . . . . . . . . . . . . 165
x Contents Using ENVOXr Server and Control Desktop
(Original — May 2000)

11.1.1.1 Header Control Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

11.1.1.2 Main Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
11.1.1.3 Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
11.1.1.4 Document Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
11.1.1.5 Tune Data Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
11.1.1.6 Trace Point Summary Window . . . . . . . . . . . . . . . . . . . . . . . . 167
11.1.1.7 Docking Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
11.1.1.8 Window Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
11.1.2 LCP Trace/Tune Module Signal Processing . . . . . . . . . . . . . . . 168
11.2 LCP Trace Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
11.3 LCP Trace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
11.3.1 Trace Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
11.3.2 Run and Stop an LCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
11.3.3 Step through an FST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
11.3.4 Continue from Breakpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
11.3.5 Select a Different Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
11.3.6 Change the LCP Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
11.3.7 Change the Trace Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
11.3.8 Editing an LCP FST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
11.4 LCP Tune . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
11.4.1 Add and Remove Tune Data Items . . . . . . . . . . . . . . . . . . . . . . 175
11.4.2 Working with I/O Channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
11.4.2.1 Overriding an Input Channel . . . . . . . . . . . . . . . . . . . . . . . . . . 177
11.4.2.2 Overriding an Output Channel . . . . . . . . . . . . . . . . . . . . . . . . . 177
11.4.3 Registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
11.4.3.1 Address Ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
11.4.3.2 Add a Register . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
11.4.3.3 View and Tune a Register . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
11.4.4 View and Tune the Accumulators . . . . . . . . . . . . . . . . . . . . . . . . 179
11.4.5 View and Tune Point DDPs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
11.4.6 Monitoring I/O Channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
11.4.7 View and Tune Operating Parameters . . . . . . . . . . . . . . . . . . . . 181
11.4.8 Continuous Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
11.4.9 Suspend Automatic Updates (the Snapshot Mode) . . . . . . . . 181
11.4.10 Manually Refresh the Display . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
11.5 User Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
11.5.1 Options Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
11.5.2 Registry Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
11.6 Instructions with Parameters That Can Be Added as
Tune Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

12 Report Writer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

12.1 Standard Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
12.2 Custom Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
12.3 Working with Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Using ENVOXr Server and Control Desktop Contents xi
(Original — May 2000)

12.3.1 Change the Appearance of a Report . . . . . . . . . . . . . . . . . . . . . 192

12.3.2 Save Tags to a Tag Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

13 Task Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

13.1 Opening Task Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
13.2 Task Monitor Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
13.3 Connect to a Different Server or Database . . . . . . . . . . . . . . . . . . 198
13.4 Creating Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
13.5 Displaying Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
13.5.1 Displaying Information by Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . 198
13.5.2 Displaying Information by Tags . . . . . . . . . . . . . . . . . . . . . . . . . . 199
13.5.3 Displaying Download Information . . . . . . . . . . . . . . . . . . . . . . . . 200
13.5.4 Displaying Generate Information . . . . . . . . . . . . . . . . . . . . . . . . . 201
13.5.5 Displaying Translate Information . . . . . . . . . . . . . . . . . . . . . . . . . 201
13.5.6 Displaying Other Job Type Information . . . . . . . . . . . . . . . . . . . 202
13.6 Generating a Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
13.7 Downloading a Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
13.8 Aborting a Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
13.9 Produce a Job Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

14 Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
14.1 Highway Reference List/Highway Access Control List . . . . . . . . 205
14.1.1 Search the Highway Reference List . . . . . . . . . . . . . . . . . . . . . . 208
14.1.2 Populating the Highway Reference List . . . . . . . . . . . . . . . . . . . 209
14.2 Audit Trail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
14.2.1 Viewing Events for a Particular Item . . . . . . . . . . . . . . . . . . . . . . 212
14.2.2 Searching Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
14.3 Importing Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
14.3.1 Importing from Control Desktop . . . . . . . . . . . . . . . . . . . . . . . . . 217
14.3.2 Importing from the Command Line . . . . . . . . . . . . . . . . . . . . . . . 218
14.4 Exporting Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
14.4.1 Running the Export Utility from Control Desktop . . . . . . . . . . . 219
14.4.1.1 Exporting the Entire Database . . . . . . . . . . . . . . . . . . . . . . . . . 220
14.4.1.2 Exporting Selected Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
14.4.2 Exporting from a Command Line . . . . . . . . . . . . . . . . . . . . . . . . 222
14.5 Upgrading Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
xii Contents Using ENVOXr Server and Control Desktop
(Original — May 2000)

Figures
Figure 3-1. Map of Help System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Figure 6-1. Matrix View for AI Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Figure 6-2. New Item Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Figure 6-3. Item Detail Window for New AI Point . . . . . . . . . . . . . . . . . . 64
Figure 6-4. New I/O Data Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Figure 6-5. Creating a New Item From an Item Type . . . . . . . . . . . . . . 67
Figure 6-6. Creating a New Item from a Specific Item in the
Resource Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Figure 6-7. Saving Data From Matrix View To External Format . . . . . . 74
Figure 6-8. Finding the File for Loading from External Format . . . . . . 75
Figure 6-9. Copy Item Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Figure 6-10. Target Data Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Figure 6-11. CONSOLE Target Matrix View . . . . . . . . . . . . . . . . . . . . . . . 87
Figure 6-12. Example Validation Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Figure 8-1. Instruction in Open Format . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Figure 8-2. Example Instruction In Closed Format . . . . . . . . . . . . . . . . 103
Figure 8-3. Example Layout Instruction Field . . . . . . . . . . . . . . . . . . . . . 111
Figure 8-4. Example Edit Layout Print Attributes Dialog . . . . . . . . . . . . 111
Figure 8-5. Example Report in Edit Window . . . . . . . . . . . . . . . . . . . . . . 115
Figure 8-6. Edit Layout Print Attributes Dialog . . . . . . . . . . . . . . . . . . . . 115
Figure 8-7. Example Report in Preview Window . . . . . . . . . . . . . . . . . . 116
Figure 9-1. Excel Matrix Connection to ENVOX Server . . . . . . . . . . . . 121
Figure 9-2. Excel and Open Database . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Figure 9-3. Workbook Type Selection Dialog . . . . . . . . . . . . . . . . . . . . . 123
Figure 9-4. Excel Matrix Enhanced DCD Workbook . . . . . . . . . . . . . . . 126
Figure 10-1. Devices to Generate Window . . . . . . . . . . . . . . . . . . . . . . . . 138
Figure 10-2. Devices to Download Window . . . . . . . . . . . . . . . . . . . . . . . . 139
Figure 10-3. Initial Devices to Download Window . . . . . . . . . . . . . . . . . . 145
Figure 10-4. Devices to Download Window after Entering a Device . . 146
Figure 10-5. Upload Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Figure 10-6. Task Monitor Showing Upload Status . . . . . . . . . . . . . . . . . 154
Figure 10-7. Example Upload Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Figure 10-8. Example Upload Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Figure 11-1. The LCP Trace/Tune Window . . . . . . . . . . . . . . . . . . . . . . . . 166
Figure 11-2. The Trace Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Figure 12-1. Select Report Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Figure 13-1. Task Monitor Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Figure 13-2. Generate Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Figure 14-1. Highway Reference List Dialog . . . . . . . . . . . . . . . . . . . . . . . 207
Figure 14-2. Search Dialog for Highway Reference List Data . . . . . . . . 209
Figure 14-3. Populate Highway Access Control List Dialog . . . . . . . . . . 210
Figure 14-4. Audit Trail Tab of Item Detail Window . . . . . . . . . . . . . . . . . 212
Figure 14-5. Event Detail for a Selected Event . . . . . . . . . . . . . . . . . . . . . 213
Using ENVOXr Server and Control Desktop Contents xiii
(Original — May 2000)

Figure 14-6. The Audit Trail Search Window—Date Range Tab . . . . . . 214
Figure 14-7. Audit Trail Search Window—Item Criteria Tab . . . . . . . . . . 215
Figure 14-8. Audit Trail Search Window—Event No. Tab . . . . . . . . . . . . 216
Figure 14-9. Import Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Figure 14-10. Import and Export Utility Flow Diagram . . . . . . . . . . . . . . . . 219
Figure 14-11. Export Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Figure 14-12. Upgrade Devices Window . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
xiv Contents Using ENVOXr Server and Control Desktop
(Original — May 2000)

Tables
Table 1-1. Type Style Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Table 2-1. Computer Requirements for ENVOX Server and
Control Desktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Table 7-1. Rules for Appending Tags to a Tag Set . . . . . . . . . . . . . . . . 95
Table 7-2. ENVOX Database Default Pattern Tags . . . . . . . . . . . . . . . 96
Table 10-1. Types of Downloads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Table 10-2. Uploadable Point Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Table 10-3. Uploadable Detail Display Parameters . . . . . . . . . . . . . . . . 157
Table 11-1. Instructions That Can Be Added As Tune Items . . . . . . . . 185
 Introduction F Section 1 15

Figure 1-Table 1

1
1

1 Introduction
Type SW3159 ENVOXr Server and Type SW3311 Control Desktop
Software are applications used for configuring a PROVOXr process
management system. Control Desktop software, the interface, is the
client to the ENVOX server that contains your ENVOX databases.

This user manual describes ENVOX Server and Control Desktop

functions for configuration engineers. Specific procedures that fully
describe how to use these functions are contained in the online help
system. Some ENVOX functions are reserved for the ENVOX system
manager. These functions are described in The System Manager’s
Guide to ENVOX Server and Control Desktop, SM:SW3159.

1.1 Intended Audience

This manual is intended for users who have knowledge of their
site-specific process and of general process control principles and who
are planning to use ENVOX Server and Control Desktop software to
configure their PROVOX Process Management System. Users should
have attended or should work with someone who has attended a
Fisher-Rosemount Systems certified, Control Desktop and ENVOX
schools.

1.2 Product Version this Manual Supports

This manual applies only to ENVOX Server, version P5.0, and Control
Desktop, version P5.0. For manuals applicable to previous ENVOX and
Control Desktop versions, see the Document History list at the back of
this manual.

1.3 How to use this Manual

This manual contains the “Why” and “What” information which gives you
a background for configuration functions. The way to actually perform a
function is contained in the online help which is accessible from various
help buttons in the software windows.

If appropriate, information is repeated between the printed manual and

online help, but in general, you should use the printed manual for
background information and online help for the “how to” instructions.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 16 Section 1 F Introduction

1.4 First Release for Windows NT

ENVOX Server P5.0 is the first release of ENVOX Server for the
Windows NT platform. This release runs only on the Windows NT
1 platform; there are no corresponding releases for OpenVMS and HP-UX
platforms.

ENVOX Server P5.0 uses Control Desktop P5.0 for the user interface.
The SYBASE APT forms system used in earlier ENVOX releases is not
included.

1.5 Enhancements in this Release

ENVOX Server P5.0 and Control Desktop P5.0 retain the enhancements
of earlier versions of both products, and in addition include the
enhancements listed below. The enhancements are further explained in
appropriate sections of the ENVOX Server and Control Desktop
manuals.

J ENVOX Server P5.0 is accessible only through Control Desktop

P5.0. The SYBASE APT forms interface of previous ENVOX versions
has been removed.

J Control Desktop and ENVOX Server administration is accessed

through a a menu selection in Control Desktop. Administration is
divided between client administration and server administration.
Password access is required for server administration.

J ENVOX P5.0 software operates on a SYBASE 11 SQL Server. With

this server, installation and upgrade procedures for Client-Server
systems use the Portable Database Transfer (PDX) utility.

J Display Designer lets you develop console displays through graphical

methods from the Control Desktop interface. It can also be installed
as a standalone module.

J Excel Matrix lets you efficiently configure and manipulate large

numbers of loop and Enhanced DCD points using an add-on for
Microsoft Excel spreadsheets.

J Trace/Tune lets you debug the control strategy of an LCP point by

viewing the function sequence tables (FSTs) it uses.

J ENVOX Server Administration lets the system administrator monitor

and maintain information about servers, databases, and users.

J A combination of new item detail screens and the new Logic Editor
module provides configuration support for LCP FSTs, Procedures,
Operations, Conditional Colors, Conditional Text, and Console
Reports.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Introduction F Section 1 17

J Import lets you import configuration data into the current database.

J Export lets you copy configuration data to a file, which can later be
used when importing data into a database.
1
J Download Backup lets you download data for all devices to be
backed up.

J Rename Item allows a single item tag to be renamed.

J Device Upgrade lets you convert older product configurations to

newer product configurations.

J Populate HACL lets you assign Highway Access Control List (HACL)
numbers to points targeted to all, or selected, consoles.

J Additional enhancements have been made to other Control Desktop

modules and utilities, such as Control Designer, Task Monitor, and
Download.

1.6 Structure of this Manual

The manual includes the following sections:

Section 1 — Introduction: provides an introduction to this manual,

describes the audience, describes the content of each section, and
describes the symbols and stylistic conventions used.

Section 2 — Product Overview: describes ENVOX Server and Control

Desktop software requirements, capabilities, structure and features.

Section 3 — User Documentation: describes the documentation

structures that provide information for users of the software. Includes
descriptions of online help, online books, DOCVUEt electronic
documentation, and printed manuals.

Section 4 — Start and License Requirements: describes how to

license and start the software.

Section 5 — Navigation: describes the Windows-like explorers, their

tree structure, login and database connection requirements, and the
menuing system.

Section 6 — Managing Configuration Items: describes the basis and

engineering rationale and how you use ENVOX Server and Control
Desktop software to create and edit a configuration and includes Control
Desktop multiple configuration through the Control Desktop Matrix view.

Section 7 — Tag Sets: describes how to use sets of database items to

improve configuration productivity.

Section 8 — Logic Editor: provides general instructions for using the

logic editor to create logic and operator console reports.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 18 Section 1 F Introduction

Section 9 — Excel Matrix: introduces the capabilities for configuring

many Loop and Enhanced DCD points, which cannot be represented in
a single two-dimensional matrix. An Excel Add-in, called Excel Matrix,
1 provides the capability to perform multiple point configurations for Loops
and Enhanced DCD points. This module can be used for multiple point
configurations while the ENVOX Server and Control Desktop application
is active or can be used as a standalone module.

Section 10 — Generate, Download, and Upload: describes how to

generate configuration data and how to download data for each device
in the system. The section also describes how to update the ENVOX
database with online configuration data.

Section 11 — Using LCP Trace/Tune: explains how to trace and tune

control strategies configured with either the Control Desktop Logic Editor
or the Control Designer module. The module can be used to simulate the
plant, to modify the state of registers and accumulators, set trace points
and step through a control strategy from a trace point to the next one
step at a time.

Section 12 — Report Writer: explains how to order, view, and print

reports for certain Control Desktop levels. Reports may be standard or
customized.

Section 13 — Task Monitor: describes the status of jobs submitted for

generation, download, or translate, generates a report for each job
selected. Also used to resubmit generate and download jobs.

Section 14 — Utilities: describes the utilities that are used to obtain

system information, to see current system information, and to maintain
the ENVOX databases. These utilities include Highway Reference List
and HACL Populate, Audit Trail Reports, Import, Export, and Upgrade
devices.

History — provides a list of documents available for earlier versions of

ENVOX and Control Desktop software.

Glossary — provides definitions of terms used in this manual.

Index — provides key-word access to information in this manual.

1.7 Conventions Used in This Manual

The following conventions are used in this manual:

Abbreviations — The glossary of this manual contains abbreviations,

their phrases, and explanations for the abbreviations of terms used in
this manual.

Revision Control — The title page and the footer of each page contain
the revision level and the print date of the manual. The title page and

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Introduction F Section 1 19

subsection 1.2 also describe the applicability of this manual to Control

Desktop and ENVOX versions. When the manual is revised, the revision
level and the date are changed.

Cross Referencing — References in text to other documents provide 1

the document name and document catalog number.

Prompt Style — This manual may present displays and prompt lines
differently than they appear on your screen. Enter the commands shown
in this manual at the equivalent prompt as shown on your screen.

Commands — Commands do not include a notation to enter the

command with the Return key. When the manual describes an operating
system command, assume that a Return is required to enter the
command.

Note ... A command line which normally appears as one line on a

screen may be too long to fit as one line in this manual.
However, whenever possible, always enter the command as
one line on the screen.

Typographic Conventions — Table 1-1 describes the type styles this

manual uses to distinguish different types of information.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 20 Section 1 F Introduction

Table 1-1. Type Style Conventions

When Text Appears
This Way ... It Means ...
1 ENVOXR Technical This style designates the title of another manual as
Reference referenced in this manual. (Helvetica font, italic)

BACKUP This style designates an operating mode or status, or a

key function (used instead of a specific keyboard key).
(Helvetica font, upper case)
Return This style designates a keyboard key on some system
keyboards. On other keyboards, the Return key may be
the Enter key (with or without an arrow). When Return
is indicated in this manual, enter the command using
the key appropriate for your keyboard. (Helvetica font,
bold)
This style designates a keyboard key or key
combination. The word key does not appear after the
Ctrl-v key name. (Helvetica font, bold)
Database This style designates a message or prompt that
appears on a screen. (Courier font)
CREATE This style designates the words that you should type in
as it appears on the printed page. Examples are
commands you enter at an operating system prompt
and keywords in a configuration source file. (Courier
font, bold)
filename.type This style designates a name or path which you must
type into a command. You decide on the appropriate
terms for your system. (Courier font, bold italic)
Italicized words in text emphasize the importance of the
words and are meant to catch your attention. (Helvetica
detail display font, italic)

1.8 Cautions and Notes

Special attention forms and symbols are used to attract attention to
essential or critical information in a document. 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.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Introduction F Section 1 21

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 1
which may make your task easier or increase your
understanding.

1.9 ENVOX Server and Control Desktop Documents

Refer to Section 3 of this manual for a complete discussion of the
documentation included with and available for the ENVOX Server and
Control Desktop applications.

1.10 Related Documents

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

J Relational database documents: You can purchase ENVOX software

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

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

J SRx Controller Family Theory of Operation Manual, CE12.2:CL6640

J SRx Controller Family Technical Reference Manual, CE12.3:CL6640

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 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

J Configuring PROVOX Operator Console Software, CE:NT2100

As other products are released, configuration engineering manuals are

made available for them.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 22 Section 1 F Introduction

1.11 Electronic Documentation

This manual is also available in DOCVUEt Electronic Documentation, a
CD-ROM Documentation set containing current and past
1 Fisher-Rosemount Systems sales literature, manuals, and technical
service bulletins.

DOCVUE documentation runs on UNIX and Microsoft Windows systems

with the advantages of full-text searches, menus, bookmarks, browsing.
and point and click navigation. We recommend that you call your
Fisher-Rosemount Systems representative or sales office and find out if
DOCVUE documentation can make your application of
Fisher-Rosemount instrumentation easier.

1.12 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.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Product Overview F Section 2 23

Figure 2-Table 2

2 2 Product Overview
The ENVOXr Server P5.0 and Control Desktop P5.0 applications and
2

the modules and utilities they include provide engineering support for
control systems implemented with the following PROVOXr devices:
20-Series controllers and newer with Control I/O or MUX I/O, PROVUEr
P5.5 and newer consoles, Operator Workplace consoles, PROVOX
Operator Consoles, and CHIP.

2.1 Introduction
ENVOX Server and Control Desktop client run on Windows NT
computers using the Intel processor family. The P5.0 release provides
full engineering capability for supported devices, including point, device,
and I/O configuration, language editing, and FST tracing, display editing
for supported revisions of PROVUE and Operator Workplace consoles,
and all PROVOX engineering utilities.

Control Desktop is a client to Fisher-Rosemount’s ENVOX Server and

greatly simplifies the engineering work in configuring PROVOX process
systems, substantially reducing the time, effort, and cost required.

Working with the ENVOX Server, Control Desktop provides powerful and
easy-to-use configuration capabilities for a PROVOX Process
Management system, including:

J familiar windows look and feel

J drag and drop and cut and paste editing

J intuitive navigation using interface similar to Windows NT Explorer

J configuration of multiple points from a spreadsheet interface

J graphical creation of control strategies

J able to load ENVOX P4.0 databases

J advanced Help system

If you have an existing PROVOX configuration, you can migrate it from

the forms-based interface of ENVOX P4.0.1 software to the
windows-based interface of ENVOX Server and Control Desktop.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 24 Section 2 F Product Overview

The following paragraphs are an overview of some of the functionality

included in ENVOX Server and Control Desktop.

Easy Navigation

Control Desktop leverages the Explorer navigation approach, providing

2 an easy way to move around the configuration data. With Control
Desktop’s Process and I/O Views, you can quickly move through the
system hierarchy in several ways, such as from:

J device type to specific devices

J types of points to a specific point tag

J PROVOX data highway to specific devices

J specific device to its I/O structure

After you’ve entered data for one I/O card, you can drag and drop the
configuration onto another I/O card, reducing subsequent configuration
time to a few seconds.

Online Help and Manuals

Control Desktop provides a context-sensitive help system to answer your

questions during use. Field-level help windows explain the type of data
you can enter into the field on a data entry screen. Throughout the help
system there are procedures for typical tasks performed by configuration
engineers.

The entire help system is indexed and cross-referenced so you can

easily locate the topic you need.

Context-sensitive help information is easily accessible, with pop-up

field-level help and fully-indexed topics.

All of the Control Desktop manuals are available online as Adobe

Acrobat Portable Document Format files.

2.2 Product Media

ENVOX Server and Control Desktop is shipped on one CD-ROM.

2.3 Hardware Requirements

All options of ENVOX Server and Control Desktop client both run on
Windows NT and require Intel Pentium II or Pentium III processor-based
computers (except User Manuals, which requires a Pentium I processor
or greater). The computer requirements depend on what combination of
applications and modules the machine is running, as shown in Table 2-1.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Product Overview F Section 2 25

Table 2-1. Computer Requirements for ENVOX Server and Control Desktop
Option (Usage) Processor Memory System Disk Database Disk
CHIP Daemons 200 MHz 64 Mbytes 20 Mbytes ------
Client 200 MHz 64 Mbytes 130 Mbytes ------
Server
Client Server
400 MHz
450 MHz
192 Mbytes
256 Mbytes
100 Mbytes
190 Mbytes
300Mbytes
300Mbytes
2
CDOS 400 MHz 64 Mbytes 20 Mbytes ------
Display Designer 200 MHz 64 Mbytes 60 Mbytes ------
Excel Matrix 200 MHz 48 Mbytes 5 Mbytes ------
Emergency Download 200 MHz 48 Mbytes 5 Mbytes ------
Diagnostics(1) 400 MHz 128 Mbytes 30 Mbytes ------
User Manuals(2) 100 MHz 24 Mbytes 40 Mbytes ------
1. To install the Web-based Diagnostics to an existing Web Server requires a maximum of 12 Mbytes. This amount is less if
some of the required software has already been installed, for example, via a Control Desktop install.

If you need to install a Web Server first, then the combined Windows NT Service Pack 4 or Service Pack 6, Internet
Explorer 5.0 and MS Personal Web Server together require a maximum of 110 Mbytes with the options recommended in
the installation instructions. Other Web Servers require different amounts.

Additionally, the ENVOX Server requires a PROVOX Highway Data Link

(Type DH6032) to connect to the PROVOX data highway (Data Highway
I or Highway II).

2.4 Software Requirements

ENVOX Server and Control Desktop both require the Windows NT
operating system with either Service Pack 4 or 6 installed.

To use the Excel Matrix module, you must have Service Pack 2 and
Microsoft Excel installed.

2.5 Configuration Planning and Design

This manual assumes 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
manual assumes that you have identified your basic control needs by
documenting the loops, batch descriptions, and logic required to support
your process.

You want to proceed in a way that takes full advantage of ENVOX Server
and Control Desktop software and the PROVOX system while making

Using ENVOXr Server and Control Desktop (Original — May 2000)

 26 Section 2 F Product Overview

effective use of your time. The following steps describe an effective way
to approach configuration planning:

Step 1: Define control conventions.

For example, determine a consistent way to control motors

2 and pumps and control strategies such as cascade loops.

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 PROVUEr
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 2.6.

2.6 Configuration Engineering and Maintenance Tasks

The ENVOX Server and Control Desktop software supports your
configuration engineering tasks. These tasks are generally defined as
the following:

J Transfer ENVOX Databases — Using the PDX ENVOX database

migration utility, you can transfer ENVOX files into a format that
ENVOX Server and Control Desktop can use. Your ENVOX
databases must be at version P4.0.1 or later to transfer.

J 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.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Product Overview F Section 2 27

J 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, Engineering Unit (EU)
range, and alarms. PROVOX points reference ISTs for their
respective I/O signal characteristics.
2
J Create templates — You create templates as you create points,
because certain types of points reference templates.

J 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).

J Create algorithms — Using the ENVOX Server and Control Desktop

software Logic 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.

J Create console displays — Use the ENVOX Server and Control

Desktop module, Display Designer, to create the displays for the
operator consoles. You also specify which consoles contain which
displays.

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

The following subsections introduces most of the ENVOX Server and

Control Desktop applications, modules, and utilities you use to
accomplish these tasks.

2.6.1 Server and Client Administration

Use these two utilities to accomplish a variety of administrative tasks for
both the ENVOX Server and the Control Desktop client.

2.6.2 Import/Export

You can use the Import utility to load previously exported comma
delimited value (CDV)-formatted data into an ENVOX database, and 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.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 28 Section 2 F Product Overview

2.6.3 Database Configuration

The primary interface for configuring any database item is the Item
Detail window. This window contains several tabs, each containing fields
in which you can enter the configuration information for any item.

2 Additionally, Control Desktop includes the Matrix View utility and the
Excel Matrix module that provide interfaces you can use to efficiently
configure multiple items of some types.

J The Matrix View provides a spreadsheet-like interface for a number

of common point types and other items. Using Matrix View you can
configure any number of one of these items at one time, opening and
saving your work directly to the configuration database.

J Excel Matrix extends this functionality to LOOP and enhanced DCD

point configuration. Use Excel Matrix, implemented as a Microsoft
Excel Add-In, to quickly configure all the information required for
these point types.

2.6.4 Tag Sets

Use the Tag Set utility to group database items in logical collections that
you can investigate or work on. You can group items in a number of
ways depending on what you are doing at the time.

2.6.5 Control Designer

The Control Designer module is a standardized, graphical tool you use to

configure and manage continuous process control strategies. Use its
Function Block Editor to create diagrams of linked function blocks and
variable blocks, reducing the time and effort required to configure
sequential control algorithms, translate them to controller code, and load
them into the controller.

Control Designer complies with the IEC-1131 standard for process

control programming languages, making it easy to learn and use.

2.6.6 Display Designer

Display Designer provides display editing capabilities for the supported

revisions of PROVUE and Operator Workplace consoles. Display
Designer replaces both the ENVOX Display Editor and the Graphics
Toolkit product. Display Designer is a separate Control Desktop module,
licensed in a manner similar to Control Designer.

Display Designer’s editing environment is similar to Graphics Toolkit and

AutoCAD, but without requiring the purchase of an AutoCAD license.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Product Overview F Section 2 29

Displays you create with Display Designer are stored directly to the
ENVOX database.

You can open, edit, and save displays from the ENVOX database
(supported by Control Desktop) directly without any need for migration.
Similarly display files saved from the Graphics Toolkit P4.0 Application
can be opened and edited in the Display Designer application without 2
any need for migration.

2.6.7 Logic Editor

The Logic Editor provides the ability to create and edit all PROVOX logic
items, including FSTs, Operations, Procedures, Conditional Text and
Conditional Color items, and Reports.

2.6.8 Generate
The ENVOX Server and Control Desktop generate option checks the
consistency of the data that the 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.

2.6.9 Download

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.

2.6.10 Portable Database Transfer (PDX)

Use the PDX utility for transferring ENVOX databases between

computers, and performing database backups. This is the only
mechanism for transferring complete databases, including download
data, between different computer platforms.

2.6.11 LCP Trace/Tune

After ENVOX Server and Control Desktop software downloads the
configuration files to the devices, use the LCP Trace/Tune module to
tune control loops and test FSTs. Enter simulated analog and discrete
inputs for an online controller and direct the controller outputs to
simulated analog and discrete outputs. You can observe the controller

Using ENVOXr Server and Control Desktop (Original — May 2000)

 30 Section 2 F Product Overview

outputs resulting from this simulation to determine whether the FST is

functioning correctly without affecting the process.

The Control Desktop LCP Trace/Tune module replaces the ENVOX LCP
Trace/Tune Utility, and runs on the Windows NT Control Desktop Client
application using the conventions of normal Windows applications.
2 You can debug a maximum of 16 LCPs in any controller at any one time.
Each LCP can have a maximum of 10 Trace Points. (These limits are a
function of the controller implementation.)

2.6.12 Report Writer

Use the Report Writer to create both Standard and Custom Reports.
With the Standard Reports, you can display the reports found in ENVOX
software. You can print the results or save them to files in a variety of file
formats. You can also save the report setup for reuse, including which
items were selected and the report formatting.

Use Custom Reports to create a report based on your requirements,

including selecting the data fields you want to display, and joining
multiple data tables. For example, a report can be easily designed to
display the I/O configuration for all Analog Input points, including the
High and Low scale and Units data, along with the I/O location. You can
save the results to one of several file formats. You can also save the
report setup for later use. Exporting the report information into your office
word processing software can reduce the time needed to generate
documents required for regulatory compliance.

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

2.6.14 Task Monitor

The Task Monitor is a standalone utility you can use to examine the
status of jobs currently in the job queue. You can also resubmit Generate
and Download jobs from the Task Monitor.

2.6.15 Diagnostics

Diagnostic data from the PROVOX data highway is useful in diagnosing

integrity problems in a PROVOX system. In ENVOX Server and Control

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Product Overview F Section 2 31

Desktop P5.0 Diagnostics you can examine both live and historical
diagnostics data. The design of the Diagnostics architecture enables:

J Remote diagnostics capability — because the data is in HTML, you

can use a web browser to view the data from any computer (not
restricted to Windows NT) and account that have sufficient privileges.

J Background logging — historical data can be collected without

2
requiring a client to continuously monitor the data.

Other features of Diagnostics include:

J All the intelligence lives on the server machine(s)

J ENVOX Server, Control Desktop (Server or Client), or CHIP is not

required to run Diagnostics on the client machine; only a web
browser is required

J Diagnostic information is in standard HTML — no Applets,

JavaScript, or Active X controls; limited use of frames

J Requires a Microsoft or Netscape Web Server and CHIP installed

J Compatible with previous ENVOX Diagnostics

J Historical logging redesigned:

J Can be gathered in the background

J Multiple, simultaneous logging sessions

J Replay and browse facilities

J Summary page and filtering

J Control functions as in ENVOX software

J Configurable refresh rates

J Embedded on-line help

For information on installing and starting Diagnostics, refer to the manual

Installing ENVOX Server and Control Desktop (PN:SW3159).

2.6.16 Audit Trail

After the initial configuration is complete, you can enable the audit trail
utility to track changes to the database. The Audit Trail utility allows you
to search for change records flexibly, by selecting data of change, user
name, type of change, tag name, and so on.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 32 Section 2 F Product Overview

Blank page.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 User Documentation F Section 3 33

Figure 3-Table 3

3 3 User Documentation
ENVOXr Server and Control Desktop software is accompanied by
3

documentation that provides information about your system. In keeping

with the current state of computing technology, the documentation set is
structured according to the kinds of information needed and is delivered
with the methods that are most useful for every stage of configuration
engineering and that make information retrieval easiest for the user.

3.1 Introduction
The documentation for ENVOX Server and Control Desktop software
provides the information necessary for successful implementation and
use of the application and its modules and utilities. The information is
structured in four formats:

J Online Help included with each application, module, and utility

J Online manuals in Adobe Acrobat Portable Document Format files

that can be viewed and printed with the Adobe Acrobat Reader
included with the software

J Printed manuals

J DOCVUEt electronic documents on CD-ROM

3.2 Online Help

Control Desktop software provide an online help system that is included
on the application CD-ROM and installed as part of the software
installation.

3.2.1 Help Types

The software provides the following categories of help:

J Application, Module, or Utility Help — These are the help systems,

consisting of a number of topics, that explains how the application,
module or utility works. These help systems are generally opened
from a Help menu, by clicking a button, or by pressing F1, but many
of them can be opened from the Help Map when the software is not

Using ENVOXr Server and Control Desktop (Original — May 2000)

 34 Section 3 F User Documentation

running. These built-in help systems contain extensive procedural

and quantitative information about all aspects of using Control
Desktop software to configure your control system.

J Field help — Appears in the status bar when certain fields are
selected. This is not available everywhere within Control Desktop.
Field help (also known as microhelp) provides information specific to
a field or area of the interface. For example, as you move from field
to field in an Item Detail window, help for the currently selected field
3 appears in the status line.

3.2.2 Help Map

You can still access much of the online help as a standalone application
even when the software is not running by selecting the Help Map option
from the Start menu. The online help map is shown in Figure 3-1. It
provides a graphical view of all the software and associated help
components, and each of the icons is a link to a help file.

Figure 3-1. Map of Help System

Using ENVOXr Server and Control Desktop (Original — May 2000)

 User Documentation F Section 3 35

The following is a list of the help files available from the Help Map:

J Control Desktop — contains general information, task-based

instructions, and context-sensitive help topics (available for the
application and all its modules, utilities, and functions).

J Display Designer — Defines the ways you can use the Display
Designer to create and maintain console displays.

J Control Designer — Defines the ways you can use Control Designer 3
to configure and manage continuous process control strategies.

J Task Monitor — Describes the ways you use the Task Monitor utility
to monitor the state of various Control Desktop jobs.

J Report Writer — Describes the ways you use the Report Writer
module to generate reports from data in Control Desktop.

J LCP Trace/Tune — Describes the use of the LCP Trace/Tune module

to view Logic Control Point performance.

J Excel Matrix — Describes the use of the Excel Matrix module to

configure multiple Loop and Enhanced DCD points.

J Server Administration — Defines the ways the system administrator

can use this utility.

J Control Desktop Client Administration — Defines the ways you can

use this utility.

J Server Setup — Defines the ways users with appropriate access can
use this utility.

J ViewPDF — Help for the application you use to view displays saved
in Display Designer as PROVOXr Display Format files.

J Glossary — An online list of terms used in the software along with

explanations.

3.3 Printed Manuals

Although ENVOX Server and Control Desktop 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. Online help is always available.

The only ENVOX Server and Control Desktop printed manual included
and distributed with the software is:

J Installing ENVOX Server and Control Desktop, PN:SW3159 (Original

— May 2000): describes ENVOX Server and Control Desktop system

Using ENVOXr Server and Control Desktop (Original — May 2000)

 36 Section 3 F User Documentation

requirements and provides instructions for installing it and SYBASE

software on Windows NT systems.

The installation manual is also included in the online manuals.

The following manuals are included in the collection of online manuals as

Adobe Acrobat Portable Document Files, but can be ordered as printed
manuals as well:

3 J Using ENVOX Server and Control Desktop, UM:SW3159:EN

(Original — May 2000): describes how to use ENVOX Server and
Control Desktop Software to configure your PROVOXr system
databases. The tasks described include generating, downloading,
uploading, trace and tune functions, diagnostic procedures, and
documenting.

J Using Control Designer, UM:SW3159:LD (Original — May 2000):

Describes how to create control strategies using the Control Designer
module of the Control Desktop software.

J Using Display Designer, UM:SW3159:DS (Original — May 2000):

Describes how to create graphics displays for your configuration
using the Display Designer module of the Control Desktop software.

J The Technical Reference for ENVOX Server and Control Desktop,

TR:SW3159 (Original — May 2000): 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 The System Manager’s Guide to ENVOX Server and Control

Desktop, SM1SW3159 (Original — May 2000): describes the
features available in ENVOX Server and Control Desktop software
for the NT system manager. The features let the system manager
tailor the software to each user and to structure the ENVOX Server
and Control Desktop system to support multiple databases and
users.

See Section 1 for information on other PROVOX product manuals you

may need while configuring your control system.

3.4 Books OnLine

Books OnLine is a new feature for ENVOX Server and Control Desktop.
Books OnLine (BOL) is a complete electronic version of the product
printed user manuals delivered on the product CD. Books OnLine are
delivered in Adobe Acrobat Portable Document Format (PDF).

Using ENVOXr Server and Control Desktop (Original — May 2000)

 User Documentation F Section 3 37

If you select the Install User Manuals option during installation, the
Books OnLine are installed on your configuration workstation.
Additionally, you can install the Books OnLine on other computers so you
can use the online manuals on any convenient computer.

Note that the Adobe PDF format is not related to the PROVOX Display
Format, also known as PDF. The two formats are completely different. To
view PROVOX Display Format files (graphic display files) use the
ViewPDF utility.
3
There are security features available that let you set up access to Books
OnLine according to your particular requirements. The default security
state for Books OnLine is open access to anyone using the computer on
which you have installed the software and the Books OnLine set.

After installation, you access the Books OnLine by starting Adobe

Acrobat Reader from the Start menu, then using Reader’s File --> Open
dialog to navigate to and select the manual you want to open.

The manuals are installed in the directory

C:\Program Files\Frsi\ControlDesktopP50\UserManuals

The Books OnLine PDF files are named:

J Install.pdf — Installing ENVOX Server and Control Desktop

J Using.pdf — Using ENVOX Server and Control Desktop

J CDesignr.pdf — Using Control Designer

J DisplayD.pdf — Using Display Designer

J System.pdf — The System Manager’s Guide to ENVOX Server and

Control Desktop

J TechRef.pdf — Technical Reference for ENVOX Server and Control

Desktop

3.5 Other Documentation

Refer to Section 1 of this manual for information on related
documentation and documentation products.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 38 Section 3 F User Documentation

Blank page.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Startup and License Requirements F Section 4 39

Figure 4-Table 4

4 4 Startup and License Requirements

This section describes how to start ENVOXr Server and Control Desktop
software and explains the software licensing requirements for the 4
application and any modules that are part of your system.

4.1 Starting ENVOX Server Software

If ENVOX server has been installed properly, no startup is required. The
server software runs as an NT service that is automatically started when
the computer boots. The server software does not require that a user be
logged in.

4.2 Starting Control Desktop

Before you can start Control Desktop, the default ENVOX Server for the
Control Desktop client must be running. If the server is not running, or if
there is no connection between the client computer and the server, when
you attempt to start the client an error message appears and Control
Desktop does not start.

Note ... The steps below describe the general procedure for starting
Control Desktop and logging in to the ENVOX Server. Your
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.

You can start up Control Desktop in one of two ways:

J From the Control Desktop icon on your Windows NT desktop

J From the Programs list by clicking on the Start button on your

Windows NT desktop

How you choose to start Control Desktop does not change how you
operate the application. Either way, Control Desktop starts and initially
displays the top-level menu, the toolbar, and the System Explorer
window.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 40 Section 4 F Startup and License Requirements

The selections of the top level menu and the toolbar change to fit the
selections available for the individual operations.

When you start the application, notice that the Application menu is only
partially available, indicating that you must log into the servers and
database before you can continue. Once you have logged in, the
remaining menus become available. Login procedures are detailed in the
following pages and in the Control Desktop online help.

4.2.1 Login
4 After you have started Control Desktop, you may log in to servers and
databases from:

J The Login icon displayed in the Toolbar

J The Admin –> Login... option in the top level menu

J By selecting a server listed in the System Explorer and selecting the

Login option in the right mouse menu

J By double clicking on a server listed in the System Explorer

4.2.1.1 Login from Login Toolbar Icon, Top-level Menu Admin Option,
or Context (Right Mouse) Menu

When you login to the system from the Login toolbar icon, from the
Admin option in the top-level menu, or from the Login option in the
context (right mouse) menu, the Login dialog appears.

You must provide a valid user identification and password combination in

the Connect To Database dialog.

The title of the Control Desktop main window changes to include the
selected server and database in the window title. You may save the
server and database settings shown as the next entry point when you
start Control Desktop again.

4.2.1.2 Login by Double Clicking a Server

A Server Authorization window appears when you log into the system
by double clicking on the server listed in the System Explorer. For
security reasons, the system requires you to enter a valid username and
password in this dialog before you can navigate past a server.

Entering this information does not immediately log you onto a particular
database; it connects you to the server allowing you to explore that
server and choose an appropriate database.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Startup and License Requirements F Section 4 41

Selecting the Login... option from the right mouse button menu connects
you to the selected database directly and inserts the database name in
the Control Desktop title bar.

If you later wish to select a server other than the default server listed in
the List field under Database information, follow the process described in
the Control Desktop online help. Refer to Section 3 of this manual for
instructions on accessing and using the online help system.

Once you are logged in and connected to a database, you have the
options to:

J Choose another server

4
J Change to a different configuration database on the same server

J Change to a configuration database on a different server

J Set and change the current database

J Change your password

The Control Desktop online help system provides complete instructions

for performing each of these tasks. Refer to Section 3 in this manual for
instructions on accessing and using the online help system.

4.2.2 Customizing Control Desktop Options

There are basic options that affect the way you use Control Desktop.
These options are located under the Admin --> Options in the top-level
menu. With these options, you may change the following:

J Startup Settings

J Edit Preferences

J User-defined Help Files

J Logic Editor Preferences

J Location of Client Task Daemon

You may also elect to change your toolbars, an option located under the
top-level menu as Window --> Toolbars. Settings that have been made
by your system administrator may also affect what you can and cannot
do and how you use Control Desktop.

4.3 Licensing Control Desktop

This section explains the software licensing procedure.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 42 Section 4 F Startup and License Requirements

4.3.1 Managing Licenses

ENVOX Server and Control Desktop use a floating license control

approach for the Control Desktop clients, with a node-locked license on
the Control Desktop Open Server (CDOS). This approach provides
encrypted license keys, generated by Fisher-Rosemount Systems
(FRSI), which lets you select purchased features, such as the number of
users for Control Desktop, Control Designer, and Display Designer.

On startup, the CDOS server accesses the license information to make

sure the workstation node is licensed and the system is set up correctly.
4 If the information is different, the system does not launch. Differences
can be caused by invalid changes made by the user to the license file or
by trying to run CDOS on an unlicensed workstation node.

Once the license file contents have been validated and accepted, you
can view the current information about available licenses in your system
and which users currently have them checked out. License management
windows can be selected from the top-level Admin menu option.

4.3.2 License File Operation

Control Desktop is shipped without the license keys. The keys are
requested from FRSI with the initial registration option that generates a
license keys request form. The form can be printed and faxed to an FRSI
Response Center, which may be the North American or European
Response Center, depending on your world area.

Since there may be a delay between the time you receive the software
and the time you receive the license keys from FRSI, there is a 29-day
grace period following installation of the CDOS software during which
period you are granted the use of one Control Desktop, one Control
Designer, and one Display Designer license.

Following the expiration of the 29-day grace period, the Control Desktop
grace period licenses are no longer valid and Control Desktop ceases to
function, except that you can run Control Desktop to request licenses.
The license management selections are located under the top-level
Admin option in Control Desktop.

When the keys are faxed or e-mailed to you, you can enter the details to
activate the license keys and use the software beyond the 29-day grace
period.

The same general procedure is used when you need to add new
licenses due to increases in nodes, changes of Ethernet cards, adding

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Startup and License Requirements F Section 4 43

new hardware, and so on. The licensing process provides the following
types of license requests:

J Initial Licenses

J Additional Licenses

J New Hardware Licenses

J Activation of License Keys

4
4.3.2.1 Requesting Initial Licenses
If you are requesting licenses for the first time for your new installation,
you should provide the following information:

J System Name — Enter the name you wish to call your system.

J CDROM Software Serial Number — The Serial Number located on

the Control Desktop CD-ROM Jewel Case is a required entry.

The serial number is used to cross-reference your license request

against your actual purchase order. This number makes sure that
you receive the licenses which you have purchased.

J Purchased Licenses, Control Desktop — The number of licenses

purchased (for example, 5)

J Purchased Licenses, Control Designer — The number of licenses

purchased (for example, 3)

J Purchased Licenses, Display Designer — The number of licenses

purchased (for example, 3)

4.3.2.2 Requesting Additional Licenses

Following the successful activation of your initial set of software licenses,

you may wish to increase the number of client licenses on your Control
Desktop system in the future.

You must supply the following information:

J System Name — The name you wish to call your system.

J Control Desktop Total Licenses, Change From — The current

number of Control Desktop licenses in your system.

J Control Desktop Total Licenses, Change To — The new number of

Control Desktop licenses which you will be running in your system.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 44 Section 4 F Startup and License Requirements

With these numbers, you inform the FRSI license generation group
the number of concurrent Control Desktop licenses you wish to run.

J Control Designer Total Licenses, Change From — The current

number of Control Designer licenses in your system.

J Control Designer Total Licenses, Change To — The new number of

Control Designer licenses which you will be running in your system.

With these numbers, you inform the FRSI license generation group
the number of concurrent Control Designer licenses you wish to run.
4 J Display Designer Total Licenses, Change From — The current
number of Display Designer licenses in your system.

J Display Designer Total Licenses, Change To — The new number of

Display Designer licenses which you will be running in your system.

With these numbers, you inform the FRSI license generation group
the number of concurrent Display Designer licenses you wish to run.

J CD-ROM Software Serial Number — The Serial Number located on

the Control Desktop CD-ROM Jewel Case is a required entry.

The serial number is used to cross-reference your license request

against your actual purchase order. This number makes sure that
you receive the licenses that you have purchased.

4.3.2.3 Requesting New Hardware Licenses

Control Desktop is licensed to the computer that is running the CDOS
software. In the majority of cases, this computer is the one on which you
have the Sybase server and ENVOX databases running. The license
encryption algorithm takes, as one of its components, the Ethernet card
unique identifier to lock the licenses to a single workstation server node.

If you replace the Ethernet card or move Control Desktop to another

Workstation server, you must request replacement licenses. Simply
installing CDOS on another Workstation will not activate the existing
license pool.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Startup and License Requirements F Section 4 45

To request replacement licenses, you must supply the following

information:

Note ... Make absolutely sure that you fill in the Return Info Fax field
with the fax number to which you would like the license
activation keys sent. Also, make sure that you select the correct
world area in the To field. The world area is selected from a
drop down list containing FRSI Response Center (North
America or Europe). This action makes sure that you get the
correct Response Center fax number printed on the new 4
hardware license request form.

J System Name — The name you wish to call your system.

J License Replacement, Reason — A reason, such as “replacement

Ethernet card” or “new server install”, for your request.

J License Replacement, Previous Machine ID — The Machine ID from

the previous activation fax or the previous license request fax. This
information should be taken from your previous license key activation
fax.

J License Replacement, Previous Access Code — The Customer

Access Code from the previous activation fax or the previous license
request fax. This information should be taken from your previous
license key activation fax.

J CDROM Software Serial Number — The Serial Number from the

Control Desktop CD-ROM Jewel Case is required information.

The serial number is used to cross-reference your license request

against your actual purchase order. This number makes sure that
you receive the licenses, which you have purchased.

4.3.2.4 Activating License Keys

You may activate license keys when you receive the keys by fax or email
from the FRSI Response Center to you.

You will have to supply the requested information that appears on the
licensing window:

J Control Desktop License Code — The Control Desktop license key

string received from the Response Center.

J Control Desktop User Count — The number of Control Desktop

licenses requested.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 46 Section 4 F Startup and License Requirements

J Control Designer License Code — The Control Designer license key

string received from the Response Center.

J Control Designer User Count — The number of Control Designer

licenses requested.

J Display Designer License Code — The Display Designer license key

string received from the Response Center.

J Display Designer User Count — The number of Display Designer

licenses requested.
4
4.3.2.5 Viewing License Activation Status
You may view the status of your license activation to be sure that you
have acquired the proper number of licenses. The system lists the
number of licenses which are available on the system and which users
have them checked out.

To view license status, select Admin --> License Acquisition from the
Control Desktop main menu.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Navigation F Section 5 47

Figure 5-Table 5

5 5 Navigation
There are several ways to navigate in ENVOXr Server and Control
Desktop software. Navigation in ENVOX Server and Control Desktop
software is based on a Windows-like explorer system. The information
that appears in each window depends on your location in the Explorer 5
structure and on which information you have selected for viewing.

5.1 ENVOX Server and Control Desktop Navigation

This subsection describes ENVOX Server and Control Desktop
explorers, menus, and mouse functions and how they support the
configuration process.

ENVOX Server and Control Desktop navigation tools and window types
include:

J Explorers

J Main Menus and Context (Right Mouse Button) Menus

J Toolbar Buttons

J Item Detail and Matrix Windows

J Assorted Windows, Dialogs, and Messages

5.1.1 Explorers

ENVOX Server and Control Desktop software are Windows NT

applications that are explorer-driven. Using the Window-type explorers,
you navigate through the plant configuration, access point information,
create points, summon the modules and utilities, and access the
modules necessary to create and to maintain the system configuration.
Selection of menu options is driven by the task you are performing.

Explorers provide a visual method of locating and then moving to a

particular part of the configuration with a mouse. There are several
Control Desktop Explorers. Once in the correct Explorer, you move to
different branch locations with the mouse. At the lowest level, double
clicking invokes a context-sensitive action for the data item; for example,
the opening of the tagged item’s Item Detail window.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 48 Section 5 F Navigation

The Explorers that are found in Control Desktop include the following:

J System Explorer

J Resource Explorer

J Plant I/O Explorer

J Controller Device I/O (an internal explorer imbedded within the Plant
I/O Explorer or a Controller Item Detail window)

5.1.1.1 Explorers’ Structure

5 The items displayed within each Explorer are referred to as components.

A root component is effectively a container or directory that can be
expanded further. A leaf component refers to a component that contains
data and cannot be expanded any further. Only root components appear
in the left-hand pane. Both root and leaf components may appear in the
right-hand pane if you have not reached the bottom of an Explorer tree.

In the left-hand pane, you can select only single items. In the right-hand
pane; however, you can select multiple items using the Ctrl and Shift
keys in conjunction with a single mouse button click.

5.1.1.2 Explorer Functions

In a broad sense, you can engage in many activities when using
Explorers. The functions that relate to a particular explorer are described
under the heading for that explorer. As usual, if you desire in depth
information about how to accomplish these tasks, see your online Help
system for Control Desktop. In general, you can perform the following
from within explorers:

J Manage Items

J Create a New Device or Item

J Edit Tag Data

J Edit Controller I/O

J Copy Items

J Copy and Move F-C-C Data

J Move Items

J Delete Items

J Generate and Download devices

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Navigation F Section 5 49

J Add Items to a Tag Base

J Use the Context Menu (the Right Mouse Button) to access

task-specific menus

J Drag ’n’ Drop to duplicate, move or set targets for items

J Select multiple items by using the mouse and Shift or Ctrl Arrow Key
combinations for deleting, moving, targeting, and copying.

J Display an ENVOX database in the System Explorer without making

changes to the database

J Switch between Resource and Plant I/O View

J Print
5
J Refresh Branch

5.1.1.3 System Explorer

The System Explorer is the top-level Explorer from which all other views
can be launched. The System Explorer gives an overview of the
configuration system, its server, databases, highways, and devices. The
topic Using Explorers in the online Help for Control Desktop describes
how to use this Explorer window.

When you launch Control Desktop, the system automatically opens the
System Explorer. The System Explorer provides functions and contains
restrictions such as the following:

J Because Control Desktop maintains its server connections through

the system explorer, only one instance of the System Explorer can be
open on the Windows’ desktop and the System Explorer window
cannot be closed, only minimized.

J The root expands to show the available Sybase servers for the PC
client.

J You can use the System Explorer to expand and explore servers and
databases down to the device level.

J With the System Explorer you can browse the system, but you
cannot modify any item data. You can also use the System Explorer
to launch the Resource and Plant I/O Explorers for all devices or with
a selected device in context.

J The System Explorer contains a top-level menu that enables you to

view your configuration, change databases or servers, select an
action, launch a module or utility, perform download and generate
actions, access online help and Books Online, and choose the
activity that you wish to conduct at any given time.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 50 Section 5 F Navigation

5.1.1.4 Resource Explorer

You may use any of the following configuration functions when you have
the Resource Explorer open and active on the desktop:

J Items

J Create a New Item

J Move Items

J Copy Items

J Delete Items
5 J Associate a User Definition, PMA, or Display Console Global Item
with a Console

J Generate and Download device

J Target Points

J Create an IST

J Set the Resource Explorer Root

J Switch To Plant I/O Explorer

J Edit Tag Data

J Launch Control Designer (by highlighting an item and using the

context menu)

J Launch LCP Trace/Tune (by highlighting an item and using the

context menu)

The standard relationships in the Resource Explorer default to

associations with PROVOXr device types. For example, an SR90 has
relationships of AI, AO, DI, DO, etc.

The device types at the top of the tree are the following:

J CHIP devices

J Consoles (PROVUEr and Operator Workplace devices)

J SR90 and SRx Controllers

Expanding this level displays the devices of the selected type in the right
pane of the Explorer — these are categorized into Global and Devices
items for Consoles and Controllers.

All devices are displayed along with their highway address where
configured. The list is ordered such that device tags are displayed

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Navigation F Section 5 51

alphabetically. The default is by Device Tag alphabetically. However, a

click on the column header displays the list in the order for that column;
for example, a click on the highway address column displays the list in
device address order with the unconfigured device addresses appearing
at the top of the list.

5.1.1.5 Plant I/O Explorer

The Plant I/O Explorer opens over the System Explorer window, which
remains open on the Control Desktop window. In the online Help for
Control Desktop, the topic Using Explorers describes how to use this
Explorer window. To reduce clutter on the screen, you can minimize the
System Explorer window.
5
From the Plant I/O Explorer, you can perform I/O operations at the
device level. You may create a new device, copy, or move files, cards, or
channels, within the same device and between devices, and generate
and download your configuration.

You may use any of the following functions when you have the Plant I/O
View open and active on the desktop:

J Copy and Move F-C-C Data

J Create an IST

J Edit I/O Data

J Set the Root of the Plant I/O Explorer

J Switch To Resource Explorer

J Print

J Launch Control Designer (by highlighting an item and using the

context menu)

J Launch LCP Trace/Tune (by highlighting an item and using the

context menu)

You cannot delete configuration information from the Plant I/O Explorer.
To delete an item, use the Controller I/O Explorer that you access from
within this Explorer.

The Explorer relationships that are provided in the Plant I/O Explorer are
as follows:

J Create a new I/O

J Main PROVOX Network (to which devices may be connected)

J All PROVOX highways

Using ENVOXr Server and Control Desktop (Original — May 2000)

 52 Section 5 F Navigation

J All Controllers

J All files within a device

J All cards within a file (configured or unconfigured)

J All channels (configured or unconfigured) on a configured card

5.1.1.6 The Controller Device I/O Explorer

The Controller Device I/O Explorer is an internal, single-pane Explorer
that you can use to do additional device I/O definition configuration tasks
that you cannot use the Plant I/O Explorer to do. Its root includes the
5 main network and editable I/O Item attributes. The configured state of
I/O items is indicated by the presence, or absence, of type description
information next to the component in the Plant I/O Explorer.

You can launch the Controller Device I/O Explorer either by selecting the
I/O icon when the Item Detail window for a specific controller is open or
from the Plant I/O Explorer for a particular file, card or channel.

You use this Explorer and its Item Detail View to navigate and configure
a single Controller’s I/O using an Explorer.

You may use either method to perform the following functions:

J Copy, or move I/O data within the controller

J Delete I/O data from a controller

J Move I/O data within the controller, file to file, card to card, or channel
to channel

J Change the I/O type defined for a controller channel

J Access and correct errors found during a Generate

J View the different I/O data for each type of I/O card you select in the
left-hand pane

5.1.2 Menus
Menus allow you to select a specific option with your mouse. In a menu
name, the highlighted letter indicates the character you may use to
select that menu if you wish to use your keyboard and not the mouse.
Menu keys are displayed in the menus on the menu bar and on the
pull-down menus.

Many modules and utilities have menus as well. In some cases the
menus that appear and the options available on menus depend on the
current sate of the application, module, or utility you are using.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Navigation F Section 5 53

The menu levels in Control Desktop are the following:

J Top level menu

J Drop down menus for each of the top level options arranged across
the top of the ENVOX Server and Control Desktop System Explorer
window

J Drop down menus for the second level explorers

J Context menus (also referred to as the right mouse button)

The choices on the drop down menus are either operable or not,
depending on the task you are doing. Inoperable choices appear dim
and cannot be selected. 5
ENVOX Server and Control Desktop menus, described below, appear in
the following format:

J Top-level Menu

J Pull-down Menus

J Drop down lists

J Context (Right Mouse Button) Menus

J Toolbar Icons

5.1.2.1 Top-Level Menu

The top-level menu appears when you start Control Desktop from your
PC desktop. Control Desktop opens to the System Explorer window that
uses a top-level menu hierarchy. Any dimmed menu option means that
the option is not available for the level of access or the task you have
selected.

5.1.2.2 Pull-Down Menus

Pull-down menus appear when you select one of the top-level menu
options. As you move the cursor over a menu option, the option is
typically highlighted. A dimmed menu option means that the option is not
available for the task you have selected.

5.1.2.3 Context Menu (Right Mouse Button)

You may use the right mouse button (reverse these buttons if you
configure your mouse for left-hand operation) when the selection of a
menu option or function is better done from a mouse button. Clicking the

Using ENVOXr Server and Control Desktop (Original — May 2000)

 54 Section 5 F Navigation

right mouse button displays a context menu for the current level or
function in which you use the button.

The context menu is available throughout ENVOX Server and Control

Desktop application. Use it as a quick and efficient way to access
functions specifically related to the item you have selected.

The following examples describe situations in which the right mouse

menus may be helpful:

J You are editing or exploring to a point and need to target or re-source

the point

J You want to create a device, point, card, channel, block, or card list
5 when you are working within an explorer view

J You want to delete a point, card, channel, block, or card list when you
are working within an explorer view

J You want to edit an item type when you are working within an
explorer view

J Launch Control Designer for an item from an Explorer

J Launch LCP Trace/Tune for an item from an Explorer

This list of examples is not all inclusive. There are menu options that are
operational from the context menu alone. In some cases, ENVOX Server
and Control Desktop software offers more than one choice for choosing
menu options. Context menu use depends on the user’s preferences.

5.1.3 Toolbar Buttons

In addition to the ENVOX Server and Control Desktop menus, you can
use the system’s toolbars to access functions quickly. These toolbars,
which contain a set of context-sensitive icons that enable commonly
used menu items, are usually located at the top of the ENVOX Server
and Control Desktop window (even though you can move them to other
positions). To access a function with the toolbar, you position your cursor
over the icon and click once.

Depending on system settings, you can position the cursor over each
toolbar icon to display text that explains the ENVOX Server and Control
Desktop and function provided by the toolbar.

5.2 Accessing Modules and Utilities

There are several modules and utilities that can be accessed from the
Windows NT Start button or from the top-level menu of the System
Explorer when you have logged into a server and database. Some of

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Navigation F Section 5 55

these modules and utilities also have help files available to them from
within Control Desktop or as standalone files.

5.2.1 From the Windows NT Start as Standalone Modules

Besides starting the ENVOX Server and Control Desktop application

from the Windows NT Start button on the desktop, the modules and
utilities that can also be accessed in this way include the following:

J Modules

J Display Designer

J Utilities 5
J Client Administration

J Server Administration

J Server Setup

J Task Monitor

J Online Help Map

J Books Online

J View PDF

5.2.2 From within Control Desktop

There are modules and utilities that can also be launched from menus
within Control Desktop after you have logged into a server and
database.

J Modules

J Control Designer

J Display Designer

J Report Writer

J LCP Trace and tune

J Excel Matrix Configuration

J Utilities

J Client Administration

J Server Administration

Using ENVOXr Server and Control Desktop (Original — May 2000)

 56 Section 5 F Navigation

J Upgrade Devices

J Generate

J Download

J Download Backup

J Upload

J Import and Export

J Audit Trail Search

Task Monitor
5 J

J Highway Reference List

J Populate HACL

5.3 ENVOX Server Navigation

ENVOX Server Administration in Control Desktop is a utility for
administrators to monitor and maintain information about servers,
databases and users. You must be a System Administrator in order to
use ENVOX Server Administration. ENVOX Server Administration opens
showing the ENVOX Server Administration explorer window. Similarly to
other Control Desktop explorers, the left-hand pane shows the category
of item in an explorer view and the right-hand pane shows information
about that category. There are four categories that show up in the
explorer’s view: Databases, Logical Devices, Dump Devices, and Logins.

A system administrator uses ENVOX Server Administration to:

J Create new databases, logical devices, dump devices, and server

logins.

J Maintain databases and their properties, view logical and dump

devices, and change passwords.

J Edit database properties.

J Administer backups to disk or tape and perform consistency checks.

J Give users access to a database and define what the user can do
with the database information.

J Display server information such as Current Server Users, Server

Processes, Application Locks, Sybase Locks, and a database’s Disk
Space Usage.

You can use the Server Administration Explorer to explore your

configuration on different Sybase servers without having to log in to a

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Navigation F Section 5 57

particular database. You can also connect to a different server or

database from within ENVOX Server Administration. Exploring different
servers does not affect your current desktop database connection.

As in the other Control Desktop modules and utilities, the Server

Administration utility is comprised of the following:

J Familiar explorer windows with menus and toolbar icons

J Context menus (right mouse button menus)

J Windows with tabs and entry fields, and message boxes that ask for
an action or convey information or warnings about an action you
have initiated.
5
All of these are available to you when navigate in ENVOX Server
Administration to perform administration tasks.

5.4 Client Administration Navigation

Client Administration in Control Desktop is an integrated utility you use to
change database and user attributes. You launch Client Administration
from a top-level menu option in an active Control Desktop. You must also
be connected to a database. You may also start the Client Administration
utility from the Windows NT Start button, but this action requires you to
log in to a server and database. In addition, you must have
Administration privileges in order to use Client Administration.

Because the Client Administration is also designed on the explorer

model, the Client Administration window contains two panes. The
left-hand pane shows an explorer view of the databases and users. The
right-hand pane shows information in different tabs, depending on
whether you have selected a user or databases in the explorer. You can
make changes to the information on some of the tabs.

With the Client Administration utility selection in Control Desktop, you

can perform the following administrative tasks:

J Change the attributes of the selected database such as Audit Trail

and Verify Mode settings

J Display information about the database such as Logical Devices and

Space Used.

J Give users access to a database and define what the user can do
with the database information.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 58 Section 5 F Navigation

As in the other Control Desktop modules and utilities, the Client

Administration utility is comprised of the following:

J Familiar explorer windows with menus and toolbar icons

J Context menus (right mouse button menus)

J Windows with tabs and entry fields, and message boxes that ask for
an action or convey information or warnings about an action you
have initiated.

All of these are available to you when you need to navigate Client
Administration to perform administration tasks.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Managing Configuration Items F Section 6 59

Figure 6-Table 6

6 6 Managing Configuration Items

This section describes how to create and edit the components that
comprise a configuration. These items include device definitions, points,
and templates. This section also provides any pertinent information that
may impact the configuration effort. This section uses the term item, or
configured item, when discussing the components of a configuration.
6
6.1 Overview
You use ENVOXr Server and Control Desktop software to manage a
configuration database for your process. The configuration database
contains information about the consoles and controllers, control strategy,
instrument signals, and a wealth of other related information.

The ENVOX Server and Control Desktop software provides several

Windows-based tools you use select and manage items. Your choice of
tools depends on your requirements and the data that is available in your
ENVOX database.

Managing configuration items include the following:

J Creating items in the configuration database

J Editing existing items

J Copying existing items

J Moving existing items

J Renaming existing items

J Delete existing items

Detailed instructions and procedures for using Control Desktop to

accomplish these tasks can be found in the Control Desktop online help
file. Specific examples of item management are contained in the How Do
I¼ section of the Control Desktop online help file.

Managing items consists of navigating to or otherwise selecting or

moving to the item or area of interest, then performing the required

Using ENVOXr Server and Control Desktop (Original — May 2000)

 60 Section 6 F Managing Configuration Items

management task. There are several different tools you use to navigate
to or select and manage items:

J The Item Detail window

J The System, Resource, and Plant I/O explorers

J The Matrix View

J The Excel Matrix

Navigation and management tasks are interrelated. Though most

management tasks can be accomplished with most tools, not that some
tasks cannot be accomplished for some item types with some tools.

The remainder of this section explains each tool and how to use it.

6
6.1.1 Introduction to the Item Detail Window
The Item Detail window is actually a set of tabbed windows, one window
for each item type. Depending on how you are navigating and the task
you are working on, you can open the Item Detail window in any of
several ways. Three examples are:

J By selecting File --> New or File --> Open from the Control Desktop
main menu

J By selecting New or Tag Data from the context menu within an

explorer with an item type or item selected

J By selecting Tag Data from the context menu when a tag is selected
in an Item Detail window.

See subsection 6.2 for more information on using the Item Detail
window.

6.1.2 Introduction to the Explorers

The System, Resource, and Plant I/O Explorer views show the items in
existing ENVOX databases arranged in an explorer-like tree structure.
From within one of the explorers, you can navigate to an area that
contains the information with which you wish to work. When you have
located the area or items of interest, you can perform configuration tasks
by selecting items or types and making selections from menus.

The following item management functions are available from the

Explorers:

J Create a New Device or Item

J Edit Tag Data

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Managing Configuration Items F Section 6 61

J Edit Controller I/O

J Copy Items

J Copy and Move F-C-C Data

J Move Items

J Delete Items

J Add tags to a Tag Base

J Target Points

In addition to the item management functions listed, the ENVOX Server

and Control Desktop Explorers provide standard Windows menu, mouse
action, and keyboard key combinations to enhance your ability to
configure items and to maintain your database. These functions include 6
the following:

J Context Menu (the Right Mouse Button)

J Drag ’n’ Drop

J Selection of multiple items with the mouse and Shift or Ctrl Arrow Key
combinations for deleting, moving, targeting, and copying

J Display of an ENVOX database in the Resource Explorer without

making changes to the database

J Switch databases

J Micro Help line (status bar), which gives you one line help information
for the configurable fields within item configuration

See subsection 6.3 for more information on using explorers.

6.1.3 Introduction to Matrix View and Excel Matrix

The two matrix tools provide a way to manage multiple items of the same
type at the same time. The two matrix tools are similar, but are
implemented differently. Matrix View is a separate Control Desktop
application with an interface that looks much like a spreadsheet.
Figure 6-1 shows a portion of the Matrix View for managing AI points.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 62 Section 6 F Managing Configuration Items

Figure 6-1. Matrix View for AI Points

6
The Matrix View for each type of item is unique. Each row of a Matrix
View contains the same information as the Item Detail window for the
item the row represents. In fact, you can open the Item Detail window by
selecting Open Item Detail from the context menu when a row is
selected.

Use Matrix View to manage the following items:

J Controller point types: AI, AO, DCD, DI, DM, DO, EPCI, Group, LCP,
PCI, PDO, Unit

J Instrument signals

J CHIP points

J Targets: Console, UOC, CHIP

See subsection 6.4 for more information on using Matrix View.

Excel Matrix is implemented as a Microsoft Excel Add-in. Use Excel

Matrix to manage:

J Loop points

J Enhanced DCD points

See Section 9 of this manual for more information on using Excel Matrix.

6.2 Using Item Detail Windows

You can perform the following tasks using an Item Detail window:

J Create an item

J Create an item from an existing item

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Managing Configuration Items F Section 6 63

J Edit the parameters of a point or device

J Save changes to an item

6.2.1 Creating a New Item

To create a new item, select File --> New from the Control Desktop main
menu, the New Item dialog opens as shown in Figure 6-2.

Figure 6-2. New Item Dialog

Select a type from the pull down menu. For example, Figure 6-3 shows
the Item Detail window that opens if you select AI. The Item Detail
windows for other item types have different tabs and different fields.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 64 Section 6 F Managing Configuration Items

Figure 6-3. Item Detail Window for New AI Point

After the window opens you can enter information in the fields on the
tabs of the window to complete the configuration of the item.

Note ... Refer to the appropriate configuration engineering manual to

determine the data you must enter to configure a particular
item.

If you created a controller, you must also edit the I/O data:

Step 1: With the Item Detail window for the controller selected, select
Data --> I/O Data.

The I/O explorer opens.

Step 2: Navigate to and select a card whose I/O you wish to change.

Step 3: Select New I/O... from the context menu.

The New I/O Data dialog appears as shown in Figure 6-4,.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Managing Configuration Items F Section 6 65

Figure 6-4. New I/O Data Dialog

Step 4: Enter I/O data and click OK to save the data and close the
dialog. 6
6.2.2 Create an Item from an Existing Item

To create an item from an existing item:

Step 1: Select File --> New from the Control Desktop main menu.

The New Item dialog opens.

Step 2: Click the Create From button.

The Create From dialog appears, listing all the items currently
in the database.

Step 3: Select an item and click OK.

The Item Detail window opens. The window title bar indicates
this is a new item created from an existing item. The window’s
fields are filled with the existing item’s data.

Step 4: Make any changes to the data required.

Step 5: Select File --> Save or File --> Save As....

The Save Item As dialog appears.

Step 6: Enter the tag you want to save the item as and click OK.

The item is saved to the database.

6.2.3 Editing Items in an Item Detail Window

The Item Detail window uses a tabbed format; clicking a tab reveals the
data fields related to the tab. You may move between tabs in any order.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 66 Section 6 F Managing Configuration Items

When you select a field on a tab, the Help line at the bottom of the
screen provides a brief description of the field. Clicking the Help icon in
the sheet Toolbar displays further information about the current Item
Detail window.

If you have made changes but not saved them, you can revert to the last
saved version of the window by selecting Data --> Retrieve Data.

The only information about targeting for the item that is displayed on an
Item Detail window is a list of the currently targeted devices and the
index number of the point in that device. This information is read-only.
You can view the targeting information using the Matrix view.

Signal data for points that have instrument signals associated with them
are not displayed on the Item Detail windows. You can access signal
data using the context menu Tag Data from the Signal Tag field within
6 the point and from the Instrument Signal Matrix display.

6.3 Using the Explorers

This subsection explains the tasks you can perform from the explorers.

6.3.1 Creating Items

To create an empty new item from the explorers:

Step 1: Select an item type folder in the left pane of the Resource
Explorer, as shown in Figure 6-5.

Step 2: Select the New option in the context menu.

Control Desktop opens the Item Detail window for a new item
of that type.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Managing Configuration Items F Section 6 67

Figure 6-5. Creating a New Item From an Item Type

To create an item with the fields filled with information from an existing
item:

Step 1: Select an item tag in the right pane of the Resource Explorer,
as shown in Figure 6-6.

Step 2: Select New from the context menu.

Control Desktop opens an Item Detail window for a new item

of the same type as the selected item and fills in the fields
(with a few exceptions) with data from the selected item.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 68 Section 6 F Managing Configuration Items

Figure 6-6. Creating a New Item from a Specific Item in the

Resource Explorer

If you create a point using the New option in the context menu in the
explorers, the source device is filled in automatically.

6.3.2 Moving Items Using the Context Menu

Use Move in the context menu when you have displayed the tag level in
the right-hand pane of the Resource Explorer and wish to move one or
more items. Selecting Move from the context menu opens the Move
dialog.

6.3.3 Moving Items Using Drag ’n’ Drop

To drag ’n’ drop an item from one device tag to another while in the
Resource Explorer, simply drag the selected item onto the destination
component.

To move an item from one device tag to another using drag ’n’ drop:

Step 1: Display the Resource Explorer and display the tag level in the
right-hand pane.

Step 2: Click and drag the item to be moved onto the new location.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Managing Configuration Items F Section 6 69

Step 3: Release the mouse button.

A message informs you of the status of the move.

The following shows the function that you are initiating and the action or
results that occur when you use the listed Drag ‘n Drop functions.

J Move Item — Select item in the right pane and drag it onto another
device component in the left pane while holding the Ctrl key down.

J Target Item to Device — Select item in the right pane and drag it onto
a CONSOLE, CHIP or UOC device component in the left pane while
holding the Shift key down.

6.3.4 Deleting Items

You can delete items quickly from an Explorer, using the context menu or 6
by selecting an item then selecting Delete from the context menu. A
confirmation dialog appears.

Deleting an item that has references to it elsewhere in system (for

example, in FSTs, procedures, reports) does not delete the references.

Note ... If you delete an item that has references to it elsewhere in the
system (for example, an AI point which 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 is not allowed because those references still
exist.

6.3.5 Moving Targets

Use Drag ‘n’ Drop in the Explorers to duplicate, move or set targets for
items. To do the following functions:

J Duplicate — Drag the selected item onto destination component

J Move — Hold the Ctrl key down and drag the item onto destination
component

J Target — Hold the Shift key down and drag the selected item onto
destination component.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 70 Section 6 F Managing Configuration Items

6.3.6 Move F-C-C Data

Moving file-card-channel data removes the data from the source location
and transfers it into the destination location. You can move
file-card-channel data in the Plant I/O Explorer using one of several
methods:

J Move F-C-C Data Using the Move Icon

J Move F-C-C Data Using the Context Menu

J Move F-C-C Data Using Drag ’n’ Drop

6.4 Using Matrix View

You can manage items by using a Matrix view. Once you have opened a
6 matrix view, you can perform the following tasks:

J Create a New Item

J Edit the Parameters of a point or device

J Make and Save Changes to an item

J Delete an Item

J Change the Source Device of a Single or Multiple Points

J Target an Item Tag to Devices

J Change a Parameter of Many Points

J Save Data to External Format

J Load Data from External Format

J Validate Matrix data entries

J Use Default Tags

J Make multiple changes

J Target items’ tags to devices

The File --> New top-level menu option is not applicable to the Matrix
view. Create a new item in the Matrix view by adding a new row in the
matrix and assigning it a tag.

When within a Matrix View, you can create a new item only of the same
type as the current Matrix view. (The AO Matrix view can be used to
create AO and FIELDVUEr AO points and the CHIP Points Matrix view
can be used to create any CHIP point type.) New items can be added

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Managing Configuration Items F Section 6 71

using the Duplicate Row(s), Insert Row and Default Row Values, and
Default Tag features.

If you want to create several new rows in a matrix view that have most of
the same basic details as another existing row, or you want to override
the current settings of several rows with the settings of an existing row,
then use the default tag facility.

6.4.1 Opening Matrix View

To open Matrix view, use the following procedure:

Step 1: Click Matrix in the Toolbar. The Matrix — Data View dialog
appears.

Step 2: Select the type of Matrix view in the drop down on the Matrix
— Data View dialog. 6
Step 3: To display an empty Matrix view of the selected type, leave
the Retrieve All Rows for the View check box blank.

Step 4: Click the Load Customized Grid check box to display a

previously stored customized grid.

Step 5: Click OK to load the Matrix view.

6.4.2 Default Tags

You can designate one row in each open matrix view as the default tag.
The name of the default tag is shown at the top of the window. If the
default tag row is not in the list of tags currently shown in your matrix
view (for example you have applied a filter to the displayed list), then you
cannot copy its settings to other rows.

The default tag row has a tag icon in the third column of the row. If you
change any of the settings for the default tag, then the icon’s
background changes color to indicate that the tag’s settings have
changed but have not been saved. If you copy its settings to another
row, then the row’s current settings are copied, not the saved settings.

To copy a default tag’s settings to another row, select the row, then
select Default Row Values from the context menu. The selected row’s
cells are filled with the values from the default tag’s row.

If you have not saved the Matrix view, you can revert a row to its saved
values by selecting the row, then selecting Reject Update from the
context menu.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 72 Section 6 F Managing Configuration Items

6.4.3 Creating Items

You can create a new item of the same type as the current Matrix view.
New items can be added using the Duplicate Row(s), Insert Row and
Default Row Values, and Default Tag features.

To insert a new blank row in any Matrix:

Step 1: Highlight a row at which you wish the insertion to take place in
an active Matrix view with a left mouse click on the row index
column.

Step 2: Select Edit --> Insert Row in the top level menu or Insert
Row in the right mouse menu.

Step 3: The system inserts a new empty row in the Matrix identified
by the NEW icon.
6
Step 4: Enter new information at this point or use data from an
existing row.

To duplicate existing information in a new row:

Step 1: Highlight the desired row(s) that you wish to duplicate with a
left mouse click on the row index column.

Step 2: Select Edit --> Duplicate Row(s) in the top level menu or
Duplicate Row(s) from the right mouse menu.

Step 3: A new row appears below each highlighted row and contains
the parameters of the highlighted row. The New icon appears
in each new row.

Step 4: Enter a point name for each new row. Modify any fields in the
row as necessary.

To use default row information for a newly created row:

Step 1: Highlight the row that you wish to use as the default row with
a left mouse click on the row index column.

Step 2: Select Data --> Set Default Tag in the top level menu or Set
Default Tag in the right mouse menu to identify the tag of the
item that will be the basis for the default row information. The
tag will not be carried to the newly created row because that
would be a duplicate.

Step 3: Select Edit --> Default Row Values in the top level menu or
Default Row Values in the right mouse menu to specify the
data that carries over to the newly created row.

Step 4: Select Edit --> Insert Row in the top level menu or Insert
Row in the right mouse menu to create a new row.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Managing Configuration Items F Section 6 73

Step 5: Highlight the new row and select Edit --> Default Row Values
in the top level menu or Default Row Values in the right
mouse menu. The new row is populated with the values from
the default row.

Step 6: Enter a point name for each new row. Modify any fields in the
row as necessary.

Note ... Section 7 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.
6

6.4.4 Editing Items

To edit items in a Matrix view, click the field you want to change.

Step 1: If the field contains a drop down list of values, the list
appears.

Step 2: If there are tag values associated with the field, click Tag
Values in the right mouse menu.

Step 3: Refer to the Help line at the bottom of the window for a brief
description of the field, including value ranges where
appropriate. Click Context Help in the Toolbar to open further
information about the current Matrix view.

Step 4: Use the right mouse menu to copy, paste, and delete field
values.

Step 5: When you are finished making edits, select Data --> Validate
(or click Validate in the Toolbar) to make sure that all field
values are within range and no required fields are empty.

If you have not saved the Matrix view, you can revert a row to its saved
values by selecting the row, then selecting Reject Update from the
context menu.

6.4.5 Deleting an Item

To delete an item in a Matrix view, use the following procedure:

Step 1: Highlight the row(s) containing the item(s) you want to delete.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 74 Section 6 F Managing Configuration Items

Step 2: Select Delete Row from the right mouse menu. To restore a
deleted row, select Edit --> Restore Deleted Row.

6.4.6 Saving Changes to a Matrix View

To save changes you have made to a Matrix view, click Save in the
Toolbar.

6.4.7 Save Data to External Format

You can save the data in a Matrix view to a file that can be read by an
external application, such as a spreadsheet or a database manager
where you can perform tasks such as column-based edits and checking
macros. When these edits are complete, you can reload the file into the
6 Matrix view.

You must specify the location and file type to which the data will be
saved as shown in Figure 6-7.

Figure 6-7. Saving Data From Matrix View To External Format

Note that though you can save to several different formats, the only
formats that Matrix view can load are tab-delimited *.TXT files and dBase
format *.DBF files.

You should provide a name for the file and specify the file type. The file
is written in the specified format to the specified location.

The information is always exported in the default grid order, regardless of

whether you have customized the Matrix view grid.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Managing Configuration Items F Section 6 75

6.4.8 Load Data from External Format

You can load data from an external format into a Control Desktop Matrix
view. For example, if you have exported the Matrix view data and edited
it in an external application and you wish to return the changed data to
the database. The data file must be in the tab-delimited text (.TXT) or
database (.DBF) format. If you are using another application, for
example Excel, then save (or export) the file in tab-delimited text format.

Figure 6-8 shows the Load from External Format dialog.

Figure 6-8. Finding the File for Loading from External Format

You cannot delete items by loading (importing), though you can overwrite
item settings. If there are any items in the database that are not included
in the import, they are left in the database intact. If you have removed
data from a particular field before reloading the data into Control
Desktop, the value for the field is returned to the value in the database.
In addition, no target data information is changed during an import of
source points — an import activity does not delete any target data.

If there are problems with the file being loaded, you are prompted. For
example, if the following message is displayed, there is a basic error (for
example alphabetical characters in a numeric-only field):

Item validation error on IMPORT. Continue IMPORT?

You can select Yes to continue the import, or No to stop importing and
locate the error in the other application.

The information is always imported in the default grid order, although if

you are using a customized grid, it is reformatted to match the grid.

After you have loaded data from an external source, it is recommended

that you validate it to check for any errors that may have been made.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 76 Section 6 F Managing Configuration Items

6.4.9 Customizing a Matrix View

The Matrix view provides you with the capability to customize. A

customized Matrix is one in which you have specified a range of data to
be retrieved into the Matrix when you reopen it, as well as, have
changed the column width or order, or split the window.

You may save each customized Matrix view. You may also restore the
revised Matrix to a standard Matrix view. Customized Matrix views load
automatically when you specify that you wish to see the customized
Matrix.

There are several operations you may perform to customize a Matrix

view.

J To set the data selection criteria for your custom grid, select the Data
6 --> Set Criteria option in the top level menu, or click the Set Criteria
icon in the left Toolbar.

When you save your custom grid, the query is saved with it. Then,
when you open your custom grid, the query runs to select the range
of data to be automatically included in the Matrix.

J To sort the entire matrix view, click the column header that contains
the sort criteria.

J To change the order of the columns, click and drag the column
heading to a new location.

To change the width of a column:

Step 1: Click and hold on the dividing line to the left of the column
heading whose width you want to change. The cursor
changes to a two-sided arrow.

Step 2: Drag the cursor to the left or right to the desired column width.

You can hide a column by dragging its dividing line on top of

the preceding column. You can restore hidden columns by
dragging the dividing line to the right.

Step 3: Save the customized view by selecting Format --> Save Grid
Definition.

Step 4: Open a customized grid using the procedure.

Step 5: To restore the order of columns and the default column

widths, select Format --> Restore Pre-defined Grid.

The column headings in a matrix view correspond to fields in the

database. You can change the Column Headings entries; you cannot
change the Database Column entries.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Managing Configuration Items F Section 6 77

To change the heading of a column in a matrix view:

Step 1: Select Format --> Change Heading. The Change Column

Heading window appears.

Step 2: Locate and delete the Column Heading entry.

Step 3: Type the new heading, then click OK.

6.5 Copying Items

In addition to the methods already explained to copy items, you can use
the Copy Item window to copy items. Select Application --> Copy Item
from the Control Desktop main menu. The Copy Item window appears as
shown in Figure 6-9.

Figure 6-9. Copy Item Window

Enter the applicable data for the fields. If the Destination Tag already
exists, it must be of the same type as that specified by the Source Tag.
You may select an existing tag as the source, destination, instrument
signal, and/or a point’s target data for the copy operation from a list of
items displayed by the Tag Values option of the right mouse button or
the Data option of the top-level menu. When copying points, you can
specify an Instrument Signal Tag to be copied to the destination tag. You
may also specify whether the Point’s Target data is included in the copy.

The Copy Items option let you reuse existing data in several ways. The
options can:

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

J Copy a complete console configuration

J Copy Target data

Copying file-card-channel information copies the data in the source

location and writes the data into the new location. The original data

Using ENVOXr Server and Control Desktop (Original — May 2000)

 78 Section 6 F Managing Configuration Items

remains in the source location. You can copy file, card and/or channel
data in the Plant I/O Explorer using one of several methods:

J Copy F-C-C Data Using the Copy Icon

J Copy F-C-C Data Using the Context Menu

J Copy F-C-C Data Using Drag ’n’ Drop

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

J Devices — The tag specified as the destination cannot already exist;

it must be a new tag.

J Logic Items — The following logic items can be copied: procedures,

operations, LCP FSTs, IAC FSTs, reports, conditional color, and
6 conditional text. The tag specified as the destination cannot already
exist; it must be a new tag.

J Displays — Displays can be copied.

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.

J Target Data — the system copies the target data when you check a
checkbox on the Copy Item window window.

6.5.1 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.

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

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Managing Configuration Items F Section 6 79

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.

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

6
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.

6.5.2 Group Field Data

Group fields are fields containing multiple values. The Item Copy treats
the data in a group field as a single entity. 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:

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.

The Copy Item option copies group field data to the destination as they
appear in the source.

6.5.3 Using Tag Sets

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 asks whether you wish to
expand the tag set. If you say yes, the software expands the tag set to
show all its tags. If you say no, the software automatically enters the four

Using ENVOXr Server and Control Desktop (Original — May 2000)

 80 Section 6 F Managing Configuration Items

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.

6.5.4 Copying a Console Configuration

The Copy Item option copies a console configuration by creating a

device definition for a new console, replicating the data from an existing
console, and making the data part of the new console. Note the
following:

J The device being copied to must not exist.

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

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 the next subsection in this manual describe
console cloning.

6.5.5 Cloning PROVUE and Operator Workplace Consoles

ENVOX software allows you to clone PROVUEr and Operator
Workplace 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 the use of 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
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

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Managing Configuration Items F Section 6 81

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 as required (not all items
apply to both PROVUE and Operator Workplace consoles):

J Basic console device definition form

6
J Options Definition

J Station Details (PROVUE console only)

J Station Key Definitions (PROVUE console only)

J System Clock

J Pen Recorder List (PROVUE console only)

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

J Console Preferences (valid for WPCON)

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 that 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.

6.5.5.1 Restrictions on Cloning

A cloned 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. 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.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 82 Section 6 F Managing Configuration Items

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.

6.5.5.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
6 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 Copy Item to
recreate the console just deleted.

6.6 Deleting Items

In addition to other methods mentioned in this section, you can delete
items from the database using the Delete Items window. To open the
window select Application --> Delete Item. Enter the tags of the items
you want to delete in the Delete Tag field. The Type and Status fields
are updated as you enter tags. After you have entered all the tags you
want to delete, select Action --> Delete.

Deleting a tag set from the Delete Items window lets you delete all the
items in a tag set or the tag set only, depending on your choice of option.

If you enter the tag of a tag set, you are asked if you want to expand the
tag set. You have two choices and the result depends on these choices:

J If you choose Yes, the tag set is expanded and all items in the tag
set are deleted, but the tag set itself is not deleted.

J If you select No, the tag set tag is deleted, but the items in the tag
set are not.

6.7 Renaming Items

You can rename one tag of any item type. Any tag may be renamed
except tags beginning with ! (exclamation point) and & (ampersand) —
that is, pattern tags. Renaming may be done in the Rename Item dialog
or by command line interface.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Managing Configuration Items F Section 6 83

Note ... Renaming an item locks the database to prevent other functions
from writing to the item. Functions like generate and download
cannot start until the rename is complete. Renaming more than
a few tags can take a long time. Therefore, renaming multiple
items should be done when no other users are using the
ENVOX database.

6.7.1 Renaming with the Rename Item Application Option

Using the Application --> Rename Item option, you can rename
selected tags of your choice. During the rename, Control Desktop
automatically changes all the database references to the item with the 6
new tag.

The Rename Item dialog window appears when you select Application
--> Rename Item. The Rename Item dialog contains the following fields:

J Source Tag — The tag to be renamed.

J Source Type — Read-only field showing the type of tag in the

Source Tag field.

J Destination Tag — Enter the destination tag, i.e. the tag’s new
name.

You must enter the Source Tag. You can click Tag Values from the
context menu to select a tag. Next, enter a unique name for the
Destination Tag for the tag you want to rename. When you click the
Rename button, .the software displays a confirmation dialog box
informing you that the job you requested has been submitted, and
showing the job number.

The tag is not actually renamed — instead the request is submitted

ready to be processed, in the same way as a Generate or Download job
may be requested and later processed. You can use Task Monitor to
monitor its process. If you enter a tag set, then the tag set itself is
renamed not the tags held in it.

When the item is renamed, the previous tag no longer exists in the
database and so can be reused.

Renaming causes ENVOX Server 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
6.7.2.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 84 Section 6 F Managing Configuration Items

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

6.7.2 Renaming from the Command Line

You can rename an item from the command line in a DOS window with
the following command:

rename_tag /C[:]CDOS /S[:]SYBASE /D[:]DATABASE

6 /U[:]USERNAME /P[:]password [/R] [oldTag newTag]

where

/C Connect through a CDOS Open Server.

CDOS The name of the CDOS Open Server.

/S Specify a SYBASE Server to use.

SYBASE The name of the SYBASE Server.

/D Specify a database to use.

DATABASE The name of the database

/U Defines the ENVOX username.

USERNAME The uppercase ENVOX username.

/P Defines the ENVOX user’s password.

password The ENVOX user’s password.

/R Use to run rename in recovery mode

[oldTag] Defines the tag of the item to be renamed.

[newTag] Defines the new tag for the item.

Recovery mode should be used when an item rename fails.

Old Tag and New Tag must not be supplied if running in recovery mode.

Example of running an Item Rename:

rename_tag /C:CEDOS_NTTGT /S:TUBAL /D:ENVOXDB

/U:SMITH /P:password AI-1 AI-NEW

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Managing Configuration Items F Section 6 85

Example of running Item Rename in recovery mode:

rename_tag /C:CEDOS_NTTGT /S:TUBAL /D:ENVOXDB

/U:SMITH /P:password /R

Caution ... Renaming via the command line interface includes a check for
valid tag names. If an invalid tag is entered, an appropriate error
message is displayed. You must not create a command file in
an attempt to perform multiple item renames. If such an attempt
is made, and the rename fails, the database may be left in an
inconsistent state. To rectify this situation, the cause of the
rename failure must be first ascertained, and then the
rename_tag.exe utility must be run from the command line in
recovery mode before any further attempt is made to rename
another tag. 6

The normal result of retrying a failed rename is to undo the unfinished

rename. Retrying a failed rename is completed only if it is significantly
progressed and has passed a point of no return.

Note ... If you delete an item that has references to it elsewhere in the
system (for example, an AI point which 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 is not allowed because those references still
exist.

6.8 Targeting Points

Targeting point data establishes reporting between a point and other
devices in the database. When you target point data, you specify the
devices to which the point reports, the reporting rate and deadband, and
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, and UOCs.

In Control Desktop there are two main ways to target points:

J From the Resource Explorer

You can select one or more points and drag and drop them onto the
device you want to target them to. You can also select one or more

Using ENVOXr Server and Control Desktop (Original — May 2000)

 86 Section 6 F Managing Configuration Items

points, then select the Data --> Target To menu option. A dialog
appears on which you select the target device.

Regardless of the method you use the Target Data form appears as
shown in Figure 6-10.

Figure 6-10. Target Data Form

On the Target Data form enter the various target parameters such as
reporting mode, deadband, and so on.

Note that target groups are not supported in Control Desktop.

J From Target Matrix Views

You can target points using Target Matrix views. There are three
Target Matrix views available, one for each type of target device
(Console, CHIP, and UOC). Figure 6-11 shows a Console Target
Matrix view.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Managing Configuration Items F Section 6 87

Figure 6-11. CONSOLE Target Matrix View

If you are targeting a point to multiple devices, you enter one line in
the Matrix views for each device the point is targeted to.

Note that in Control Desktop, configuration of Target PT

Compensation and Target Action DIs is done from the UOC Matrix
view.

For more information on using Matrix Views, refer to subsection 6.4.

6.9 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 in the ENVOX database and use it when you begin point and logic
configuration.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 88 Section 6 F Managing Configuration Items

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

6 J Engineering units and ranges

J Signal inversion status

J Alarm values

J SMART variable

Note ... 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
Server and Control Desktop software then automatically updates all
references to this IST by way of its relational database.

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.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Managing Configuration Items F Section 6 89

6.10 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 in their configuration. 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 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. 6
6.11 Validating Data Entries
You can verify that the values you enter in a field in the Item Detail or the
Matrix windows are valid before you save. To validate the entries, select
either Data --> Validate or click the Validate icon in the toolbar. The
validation process begins. At any time that you wish to stop the
validation process, click the Cancel button.

When the validation process is complete, the Validation Log for the point
appears only if there are any validation messages or errors. The Validate
window also appears when you Save, if the item being saved has errors.

The Validation Log indicates the location of any problems uncovered by

the validation process. You need to correct the errors and note the
contents of the messages before you download the device.

Figure 6-12 shows the appearance of the Validation Log for a point.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 90 Section 6 F Managing Configuration Items

Figure 6-12. Example Validation Log

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Tag Sets F Section 7 91

Figure 7-Table 7

7 7 Tag Sets
Tag sets are user-defined groups of tags on which the ENVOXr Server
and Control Desktop software can perform functions, such as Report
Writer, generate, and download. These can be easily defined and
maintained in various ways from various places in Control Desktop.

A special type of tag set is available and is called a Tag Base. The tag
base is essentially a scratch pad of tags that you can use instead of
having to make notes on paper to list tags that you later want to add,
investigate, update, delete, etc. 7
Control Desktop groups items in Explorers, matrix views, and so on, in
logical collections normally based on the type of item or device.
However, you may want to investigate or work on tags that are not
grouped by Control Desktop; for example, by an area of your plant. You
can use Control Desktop to group these items together into tag sets.

There are many methods and many places in which you can use tag
sets within Control Desktop. This makes the way you create, maintain
and use tag sets very flexible, in order to suit your needs.

The ways you can use tag sets include the following situations:

J Analyzing and modifying items

J Deleting many tags in one operation

J Generating and downloading groups of tags

J In Report Writer, when defining your selection criteria when you

produce a report

J As security area tag sets in order to restrict access to certain devices

for specific individuals

J Creating a tag base from the tag set.

Tag sets can be created and updated in many different ways within
Control Desktop, such as:

J Create (or Save to) a Tag Set

J Add Tags to an Existing Tag Set

Using ENVOXr Server and Control Desktop (Original — May 2000)

 92 Section 7 F Tag Sets

J Open a Tag Set

J Use the List of Tags in a Tag Set

There are three types of tag sets you can define:

J No SQL — a manually created and maintained list of tags. Use this

tag type if you know the names of the list of tags, and if it is not
possible or you do not know how to generate this list using an SQL
statement.

J Static SQL — a fixed list of tags automatically generated using an

SQL statement. This list can be manually changed once it has been
created. Use this tag type if you know the SQL statement required to
generate the list of tags.

J Dynamic SQL — an SQL statement to be run dynamically whenever

the tag set is called by Control Desktop. No tag list is held. Defining
this type of tag means that whenever it is used, it is guaranteed that
7 the list generated is up-to-date. Unlike the Static SQL type, you do
not see the list of tags that is to be generated when you create the
SQL statement.

Control Desktop does not support the ENVOX Fixed Attribute Criteria tag
sets, as these are superseded by the use of SQL. Neither are ENVOX
Adhoc tag sets supported — those that start with an ’&’ and were
created in ENVOX software when you saved generation errors to a tag
set (tag set name is ’&username’).

7.1 Configuration Tasks with 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.

Tag sets help optimize productivity because they allow you to execute
configuration functions on a group of items. For example, you can use
tag sets to:

J Report Writer — When you use the Report Writer module, you may
use a tag set to specify which items you want a report to include.

J Delete items — When you wish to delete items, 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.

J Generate — You can build the list of devices that you want to
generate by specifying a tag set. The software includes the devices
represented by the tag set in the Generate option.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Tag Sets F Section 7 93

J Upload online configuration data — When you select the Upload

option, the software enables you to specify the items you want to
upload using a tag set.

J Download configuration files — When you select the Download

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

J Copy all the data from one point to another — When you select the
Copy Item menu option, you can 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.

J Create a tag base from the tag set — There is an option on the
Startup tab on the Control Desktop Options dialog which makes
Control Desktop create a tag base based on a specific tag set when
you log in.

J Define System security — The system administrator uses tag sets to

define areas of limited access, called security areas, for different 7
devices in different configuration databases. The System Manager’s
Guide to ENVOX Server and Control Desktop, SM:SW3159,
describes security area tag sets.

7.2 Create a Tag Set

You create a tag set in the same way as you create any item or device
so that you create a list based directly on the results of other Control
Desktop facilities in a flexible and integrated fashion, as well as
separately.

There are several ways to create the tag set.

J The standard Item Detail window — You can use this window to
define the tag set’s details, including the type of tag set (No SQL,
Static SQL or Dynamic SQL).

J From the Task Monitor — You can create a report that contains all
the devices that have generation errors, then use the Save To Tag
Set... button on the report to create a Tag Set containing the items
that prevented a successful generation.

J From within Report Writer — After you have created a report and
have a list of tags in a report on the screen, you can create a tag set
for these tags.

J After an audit trail search — When you are viewing the history
summary of an audit trail, you can create a tag set of the listed tags.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 94 Section 7 F Tag Sets

J When using a filter definition — From anywhere in Control Desktop,

you can filter the list of tags displayed and can save this list of tags
as a tag set.

J From a tag base — Which can have tags added to it from many
places in Control Desktop — almost everywhere tags are displayed.
For example, you can add items to a tag base from Explorers and
from item detail windows.

You can modify a tag set or the tags in a tag set as well as delete tags
and tag sets. Use the tag set’s Item Detail window, the menu option for
Tag Set to open the tag set that contains those tags you wish to modify
or delete. If you delete tags, you do not delete the tag set.

7.3 Tag Set Creation from ISQL

In some cases it may be easier to create a special tag set using ISQL.
You can use ISQL to insert rows into an existing tag set or into a new tag
7 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.

The following functions are restricted by triggers in ISQL:

J Changes to a security area tag set cannot be made. The message

you receive in this case is: You are not allowed to update a security
area.

J A tag set’s row cannot be updated from one tag set to another.

J A row cannot be inserted for a new tag set such that the tag of the
new tag set already exists in the database.

J Rows of more than one tag set cannot be operated on in one

operation.

7.3.1 Appending Tag Sets

When you decide you want to add tags to an existing tag set, bear in
mind the rules shown in Table 7-1 on what is the result of trying to
append tags in one tag set type to tags in another.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Tag Sets F Section 7 95

Table 7-1. Rules for Appending Tags to a Tag Set

Existing Tag Set Type New Tag Set Type Being Resultant Tag Set Type
Appended When Appending
No SQL No SQL No SQL
No SQL Static SQL Static SQL — list of tags doesn’t
match the SQL
No SQL Dynamic SQL Not possible — only Overwrite
permitted
Static SQL No SQL Static SQL — list of tags doesn’t
match the SQL
Static SQL Static SQL Static SQL — using original tag set
SQL (list of tags doesn’t match)
Static SQL Dynamic SQL Not possible — only Overwrite
permitted
Dynamic SQL No SQL Not possible — only Overwrite
permitted
Dynamic SQL Static SQL Not possible — only Overwrite

Dynamic SQL Dynamic SQL

permitted
Not possible — only Overwrite
7
permitted

Although some tag set types cannot be appended to, all tag set types
can be overwritten.

7.3.2 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 tag with Control Desktop drag ’n
drop or cut and paste functions. One exclamation point (!) precedes a
pattern tag. The exclamation point tells Control Desktop to ignore pattern
tags so that they do not interfere with your actual configuration.

However, while Control Desktop does not generate pattern tags, they are
included in the error and limit checking functions that are also performed
by Control Desktop. Therefore, to avoid errors when generating and
downloading devices, do not include the name of the pattern tag that is
being modified.

If you want to fill in a tag window with pattern-tag data, use the Copy
Item menu option. See the online help files for additional details on the
Copy Item menu option.

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 Copy Item menu option to copy
predefined data from a pattern tag into all the points in the tag set.

Table 7-2 lists the default pattern tags.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 96 Section 7 F Tag Sets

Table 7-2. ENVOX Database Default Pattern 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
7 !!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
!!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
!!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

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Tag Sets F Section 7 97

Table 7-2. ENVOX Database Default Pattern Tags (Continued)

ENVOX Tag Type
!!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
7
!!MUX STD AI MUX STD AI
!!MUX STD AO MUX STD AO
!!MUX STD DO MUX STD DO
!!MUXEXTAC MUX EXT AC2
!!MUXSTDAC MUX STD AC2
!!NSTRMNTSGN INSTRUMENT SIGNAL
!!OPERATION OPERATION
!!PCDSCRT PCIU DISCRETE
!!PCI PCI
!!PCIU PCIU
!!PCIU AI PCIU AI
!!PCIU AO PCIU AO
!!PDO PDO
!!PMA PMA
!!PPA PPA
!!PPLCTN APPLICATION
!!PRCDRLST PROCEDURE LIST
!!PROCEDURE PROCEDURE
!!PROVUE PROVUEr
!!PROVUE DCD CONSOLE DCD
!!PROVUEEPCI CONSOLE EPCI
!!PRVCCMLTN CONSOLE ACCUMULATION
!!PRVCTVTY CONSOLE ACTIVITY
!!PRVMNTNNC CONSOLE MAINTENANCE
!!PRVNTGRTY CONSOLE INTEGRITY

Using ENVOXr Server and Control Desktop (Original — May 2000)

 98 Section 7 F Tag Sets

Table 7-2. ENVOX Database Default Pattern Tags (Continued)

ENVOX Tag Type
!!QPMNTLST EQUIPMENT LIST
!!RPRTHDR REPORT HEADER
!!SNGLDSCRT SINGLE DISCRETE
!!SRDFNDKY USER DEFINED KEY
!!SRPLTT USER PALETTE
!!TARGET AI
!!TREND TREND
!!UNIT UNIT
!!UOC SRx UOC
!!USER NAME USER NAME
!!WPCON WPCON

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Logic Editor F Section 8 99

Figure 8-Table 8

8 8 Logic Editor
The Logic Editor is an integrated language editor that you use to create
and edit the following types of logic items:

J Logic control point (LCP) function sequence tables (FSTs)

J Procedures

J Operation Steps

J Console reports

J Conditional color expressions 8

J Conditional text expressions

Launch the Logic Editor from one of these items by selecting the
appropriate selection from the Data menu. For example, after opening
an LCP FST, select Data –> Edit FST. To create a new item, select File
–> New, then enter or select the item type to create.

Control Desktop allows you to have several Logic Editor sessions open
on your desktop at the same time. This includes Logic Items of different
types. You can copy and paste information between windows of the
same type.

The basic way you use the Logic Editor to create a list of instructions is
the same for all items, but the instruction set depends on the item.
Creating and maintaining the instruction list comprises:

J Adding Instructions

J Editing Instructions

The instructions that you use to create these sequences are different for
each item type and are not described in this section (except for the
console reports editor). For information about specific instructions, refer
to the configuration engineering manuals for the controllers and operator
consoles or the online help for the Logic Editor.

This section describes how to access the Logic Editor, use the editor to
enter and save instructions, and use the various editor features such as
cut and paste and find and replace.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 100 Section 8 F Logic Editor

8.1 Accessing the Logic Editor

The Logic Editor is closely integrated with Control Desktop and is not a
separate, stand-alone module. The following subsections detail how to
launch the Logic Editor for the different item types. (Create new items by
selecting File --> New instead of File --> Open.)

The editor works the same for all logic item types. Keep in mind,
however, that you can only use the instructions for the sequence type
you are currently editing. For example, if you are editing an FST, you
cannot use console report instructions.

IAC FSTs are not supported in Control Desktop P5.0.

8.1.1 Procedures and Operations

Step 1: Open a Procedure or Operation Item (File --> Open).

Step 2: Select the Processes or Steps tab and click on the Process
or Step you wish to edit.
8 Step 3: Select Data --> Edit Process (or Step).

The Logic Editor opens the process or step instruction data.

8.1.2 LCP FSTs

Step 1: Open an LCP FST Item (File --> Open).

Step 2: After the LCP FST Item Data Window is open, select Data -->
Edit FST.

The Logic Editor opens the FST instruction data.

8.1.3 Reports
Open the Console Report (File --> Open). The Logic Editor opens the
report instruction data.

8.1.4 Conditional Expressions

Open the Conditional Text/Expression (File --> Open). The Logic Editor
opens the conditional text/expression instruction data.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Logic Editor F Section 8 101

Note ... Procedures, Reports and Conditional Expressions can also be

accessed from the Resource Explorer under the
Consoles\Global Items\Logic Items tree.

Conditional Expressions can also be accessed from the

Console Display Editor. Refer to the console configuration
engineering manuals for instructions.

LCP FSTs and Operations can also be accessed from the

Resource Explorer under Controllers\Global Items\Logic Items
tree.

8.2 Add an Instruction

Once you are in the Logic Editor, you can add instructions. To add an
instruction, perform the following steps:

Step 1: Enter an instruction mnemonic. 8

Step 2: Fill in the operands.

Step 3: Close the instruction.

8.2.1 Entering Instruction Mnemonics

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 and opens the instruction for editing, if only
one instruction matches the letters you typed. 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. Select the desired instruction and click OK to accept it
and close the dialog, or click Cancel to exit the dialog.

If you do not know which instructions are valid, you can find a list of valid
instructions in the online help for Control Desktop. To see a list of valid
instructions, move the cursor to the [End of File] marker, enter ?
(question mark), and press Return.

When you type an instruction mnemonic and press Return, the

instruction appears in expanded, or open, form. That is, the software

Using ENVOXr Server and Control Desktop (Original — May 2000)

 102 Section 8 F Logic Editor

displays a prompt for each operand that the instruction requires. For
example, if you enter the mnemonic ADD when editing an operation, the
software displays the expanded instruction in Figure 8-1.

Error Box Instruction Comment

Status Line
Operand Prompts
Instruction Number List Boxes
Figure 8-1. Instruction in Open Format

The Logic Editor contains several elements. They include:

J Instruction — The instruction mnemonic that you entered and

parentheses for the operands.

J Operand prompts — The prompts for all of the operands required for
this instruction.

J List Boxes — Contain pulldown lists of configured items in the logic

item you are configuring. Insert an item from a list at the current
cursor position by opening the list and clicking on the item.

J Error Box — Contains a list of errors in the current editing session.

J Status Line — The Logic Editor uses the Control Desktop Status Line
to present brief information about the current state of the editor and
to prompt for the information the editor expects at the current cursor
location.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Logic Editor F Section 8 103

For more information on the components of the Logic Editor window,

refer to the online help.

8.2.2 Filling in the Operands

Enter data at the operand prompts. If you enter an invalid operand, the
software displays an error message in the error box that describes why
the operand is invalid.

8.2.3 Closing an Instruction

When you have entered valid operands for each prompt, press Return
or click the mnemonic to close the instruction. Figure 8-2 shows a
completed ADD instruction in closed format.

0001:ADD (UV[26], UV[26], 1) {add 1 to UV26}

Figure 8-2. 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 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.

After entering instructions in the Logic Editor window, you may need to
edit them in some way. There are facilities available to let you:

J Edit an Instruction

J Delete an Instruction

J Disable an Instruction

J Enable an Instruction

J Indent an Instruction

J Insert an Unattached Comment

As well as directly editing instructions, there are other facilities:

J Finding and replacing text

J Finding incomplete instructions

Using ENVOXr Server and Control Desktop (Original — May 2000)

 104 Section 8 F Logic Editor

J Finding generation errors

J Refreshing the display

8.3 Setting Logic Editor Options

There are two settings you can make from the Control Desktop Options
dialog:

J Suppress Warnings

If this check box is checked, any warnings encountered while editing

an instruction set in the Logic Editor window are not shown.
However, errors encountered are shown. By default, this check box is
not checked.

J Check References Before Save

If this check box is checked, Control Desktop checks all Label

references before saving the current instruction set. By default, this
check box is checked.
8
8.4 Including Blocks of Instructions
You can 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.

To include instructions from one instruction set into another instruction

set:

Step 1: Open the first instruction set.

Step 2: Open the second instruction set.

Step 3: Select the instructions you want to include.

Step 4: Select Copy from the context menu.

Step 5: Move to the point in the first instruction set where you want to
insert the instructions you copied.

Step 6: Select Paste from the context menu.

Because you can copy and paste between Logic Editor windows, you
can create one or more instruction sets that contain commonly used
instructions or combinations of instructions. You can use these
instruction sets as libraries, copying blocks of instructions from them to
instruction sets you are creating.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Logic Editor F Section 8 105

Note ... Use register names with caution in instruction sets you use this
way because register names may result in invalid register
references or indices when pasted into the second instruction
set. The editor will not give any warning message to this effect
following an include.

8.5 Modifying Instructions

To modify instructions, either double click on the instruction or click on
the instruction and select Open Instruction from the context menu. The
software opens the instruction so that the operands can be edited. To
close the instruction, select Close Instruction from the context menu,
click on the instruction, or simply press Return at the Comment operand.

8.6 Adding a Comment

You can enter a comment for an open instruction or when all instructions 8
are closed.

Each instruction (except LAYOUT in reports) has a comment operand.

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 to the right of the middle of the window. If necessary,
the comment wraps to the following lines. (You may now continue to
enter another instruction mnemonic or a comment.)

To write a comment when all instructions are closed, position the cursor
at the desired point and select Insert Comment from the context menu.
The Comment Edit window opens. Enter your comment and click OK.
The Logic Editor inserts the comment with opening and closing brackets.

You can perform some simple formatting (inserting blank lines and
limiting line lengths using returns) in the Comment Edit window. Note
that the Logic Editor window ignores leading spaces entered in the
Comment Edit window. To retain indenting in comments, start each
comment line with a non-space character. For example:

* This remains indented

* So does this.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 106 Section 8 F Logic Editor

8.7 Cutting or Copying and Pasting Text

The language editor provides two kinds of cut or copy and paste, for:

J instructions

J text within comments

8.7.1 Cutting or Copying and Pasting a Closed Instruction

To cut or copy and paste a closed instruction, or a series of closed
instructions (instructions include the comment operand):

Step 1: Highlight the desired instructions by clicking and dragging.

Step 2: Select Cut or Copy, as desired, from the context menu.

Step 3: Move the cursor to the desired position and select Paste from
the context menu.

8 8.7.2 Cutting or Copying and Pasting Text Within Comments

To cut or copy and paste text within comments:

Step 1: Double click on the comment. The Comment Edit window

opens.

Step 2: Use the cursor to select the desired text and select Cut or
Copy from the context menu.

Step 3: Select Paste from the context menu to paste this text
elsewhere within this comment or in another comment within
this instruction set or another instruction set. The paste buffer
retains its contents until you cut or copy something else into it.
You can therefore copy or cut once and then paste the same
text multiple times.

8.8 Finding and Replacing

The Logic Editor has Find and Replace selections from the Edit menu.
Both selections open the Find and Replace window. The window has
two tabs, Find and Replace. Both Find and Replace work a bit differently
and have slightly different features than find and replace do in most text
editors and word processors.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Logic Editor F Section 8 107

8.8.1 Using Find

The Find tab of the Find and Replace window has two functions:

J Finding specified text in instruction mnemonics, instruction operands,

and comments

J Finding incomplete instructions.

To find a string in an instruction, operand, or comment:

Step 1: Position the cursor where you want to begin the search.

Step 2: Select Edit –> Find... from the main menu.

The Find and Replace window opens.

Step 3: Select the Find tab.

Step 4: In the Search String field, enter the string you want the
software to find. If desired, select the Match Case checkbox.

Step 5: To start the search, click Find Next. The software finds the
first occurrence of the string, if any. You can skip to the next
8
occurrence by clicking Find Next. To abort the search, click
Cancel.

To find an incomplete instruction:

Step 1: Position the cursor where you want to begin the search.

Step 2: Select Edit –> Find... from the main menu.

The Find and Replace window opens.

Step 3: Select the Find tab.

Step 4: Select the Find Incomplete Instruction box. The Search

String field is disabled.

Step 5: To start the search, click Find Next. The software finds the
first incomplete instruction, if any. You can skip to the next
occurrence by clicking Find Next. To abort the search, click
Cancel.

8.8.2 Using Replace

Use the Replace tab of the Find and Replace window to find a specified
string and replace it with another. Note that the Replace function works
only in instruction operands and comments.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 108 Section 8 F Logic Editor

To find a string and replace it with another in an instruction operand or

comment:

Step 1: Position the cursor where you want to begin the search.

Step 2: Select Edit –> Find... from the main menu.

The Find and Replace window opens.

Step 3: Select the Replace tab.

Step 4: In the Search String field, enter the string you want the
software to find. If desired, select the Match Case checkbox.

Step 5: In the Replace String field, enter the text you want to
substitute for the string you find.

Step 6: To start the search, click Find Next. The software finds the
first occurrence of the string, if any. To replace, click Replace.
To replace all occurrences, click Replace All. You can skip to
the next occurrence by clicking Find Next. To abort the
search, click Cancel.
8
The software checks instructions after you replace operands. If it finds
errors it asks if you want to continue. It does not replace operands that
will result in an error.

8.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)
make sure the cursor is not on an instruction, then press the Shift F1
key combination. A list of all valid instructions appears. To see detailed
help, click on an instruction of interest.

To directly access detailed help for a particular instruction position the

cursor at an instruction of interest. Press the Shift F1 key combination or
click the Help icon on the toolbar. A help topic specific to the instruction
appears. The instruction help screen defines the instruction and provides
information on operands.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Logic Editor F Section 8 109

8.10 Determining FST or Step Instruction Size

You can determine the size of your FST or Step Instructions at any time
by selecting Data --> Validate (or the validate toolbar button) when in the
Logic Editor. This displays a message in the error pane similar to:

Validation Complete
0 Errors - FST size = 326 bytes.

8.11 Saving Your Instruction Set

To save the instruction set you are working on, select File –> Save. The
software checks the instruction set for errors. If it finds any it lists them in
an error box. You must correct the errors before you can save the
instruction set.

8.11.1 Save with Check

If you selected the Check References Before Save option (see

subsection 8.3) the software checks the syntax and all of the references
to item data within the instruction set such as label declarations, phrase 8
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 the software saves the data.

8.11.2 Save without Check

If you did not select the Check References Before Save option, the
software checks only the syntax (overlooking reference errors).

Selecting File --> Close prompts you to save your data if you have made
changes.

8.12 Viewing Generation Errors

When editing a logic item you can view any errors found the last time this
item was generated by selecting Data --> Generation Errors. The
Generation Errors box appears at the bottom of the Logic Editor. Any
generation errors appear in the box, ordered by instruction number. The
error information includes the affected device tag and the error message.

As you scroll through the generation errors with the arrow keys, the
cursor in the Logic Editor moves to the instruction that caused the error.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 110 Section 8 F Logic Editor

Note that the generation errors are a snapshot of the Logic instructions
that caused errors at the time of the generate. Therefore if the logic
instructions have been modified since the last generate, the generation
errors instruction numbers may no longer be correct.

Submitting a new generate produces a new generation errors list with

up-to-date instruction numbers.

8.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 8.13.1 through 8.13.4 define the valid instructions for

console reports. Subsection 8.13.5 shows how to view the report format
without having to download and actually request the report from a
console. Subsection 8.13.6 shows an example report.
8
The configuration engineering manuals for the consoles provide
additional background about configuring reports.

8.13.1 LAYOUT Instructions

The basic instruction that you use to build a report is LAYOUT. When you
enter the LAYOUT instruction or select Insert Layout from the context
menu, the editor opens a text editing field in the editor window.

The layout field 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 normal editor window displays only the first 101
characters of the line. To view the full 132 characters go into Edit Full
Screen mode and resize the editor window. The editor does not wrap
lines since it attempts to show what the report would look like when
printed.

The next step is to identify the text you want printed (if any) and to create
a placeholder for your data. Figure 8-3 shows an example layout field.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Logic Editor F Section 8 111

Text string Data placeholder characters

Layout field

Figure 8-3. Example Layout Instruction Field

To exit the layout window, press the Return key. If you enter the
information shown above, the editor reads your text string and data
placeholder and automatically opens the Edit Layout Print Attributes
dialog. Figure 8-4 shows the dialog that results from the example in
Figure 8-3.

Figure 8-4. Example Edit Layout Print Attributes Dialog

Enter information in the Print Item, Justification, and Underline fields.

The editor supplies default values for justification (default is left) and
underline (default is no underline). Click OK to accept your entries. If
there are no errors (or if you leave the Printed Item field blank) the dialog
closes. If there are errors, messages appear in the box at the bottom of
the dialog.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 112 Section 8 F Logic Editor

You can reopen the dialog by placing the cursor at the beginning of the
layout field (not in the field) and then selecting Layout Print Attributes...
from the context menu.

Note that the software creates one row in the Layout Print Attributes
dialog to support each data place holder you put in the layout field.

The following paragraphs describe the values that can be put in the
three fields of the dialog:

J 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.

8 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 16.

J Justification — Determines where the software places the item within

the field if there is extra space. Selections are: LEFT, CENTER, and
RIGHT.

J Underline — Determines whether the software underlines the data in

the report. Selections are UNDERLINE and NOUNDERLINE.

If you delete a layout instruction, all of the information stored in the

Layout Print Attributes dialog is removed as well.

8.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.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Logic Editor F Section 8 113

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.

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)

8.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:
8
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
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.

8.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.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 114 Section 8 F Logic Editor

J BLANK LINES — Prints the number of blank lines you specify.

J FORM FEED — Advances the paper to the top of the next page.

8.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, select Report Preview from the
context menu. The software displays the report in a window that
approximates the layout of the report.

Previewing displays the following:

J LAYOUT field

J REPEAT instruction

J UNTIL instruction

J UNTIL END instruction

8 J blank lines

J FORM FEED Instruction

You can edit the LAYOUT fields in the preview view. To return to the
editor, select Report Preview from the context menu.

8.13.6 Example Report

Figure 8-5 is an example of a console report in the Logic Editor.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Logic Editor F Section 8 115

8
Figure 8-5. Example Report in Edit Window

Figure 8-6 shows the Edit Layout Print Attributes dialog associated with
the LAYOUT fields:

TAG DESCRIPTION PV SP %OUTPUT

@@@@@@@@@@@@ @@@@@@@@@@@@@@@@ @@@@.@@ @@@@.@@ @@@@.@@

Figure 8-6. Edit Layout Print Attributes Dialog

Using ENVOXr Server and Control Desktop (Original — May 2000)

 116 Section 8 F Logic Editor

Figure 8-7 shows how the example report appears in the preview
window.

Figure 8-7. Example Report in Preview Window

8.14 Printing Logic Data

8 There are a couple of different ways to print logic data:

J You can print any Logic item’s instruction data from within the Logic
Editor. You have the option of printing a selection of instructions

J You can print from a logic item’s Item Detail Window. You have the
option of printing all tabs and the logic instructions, or printing the
currently selected tab.

8.14.1 Printing from the Logic Editor

From the Logic Editor you can print all the logic instructions or only the
range of instructions you select. In either case you can print to a file.

8.14.1.1 Printing All Instructions

To print all the instructions, do the following:

Step 1: Select (highlight) the title bar of the Logic Editor window
containing the instructions you want to print.

Step 2: Select File --> Print.

The Print dialog opens.

Step 3: Select a printer.

Step 4: Select the Selection radio button.

Step 5: Click OK.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Logic Editor F Section 8 117

8.14.1.2 Printing Selected Instructions

To print only a selection, do the following:

Step 1: Highlight the instructions you want to print.

Step 2: Select File --> Print.

The Print dialog opens.

Step 3: Select a printer.

Step 4: Select the Selection radio button.

Step 5: Click OK.

8.14.1.3 Printing to a File

You can print the instructions to a file by selecting the Print to file
checkbox on the Print dialog. When you click OK the Print to File dialog
opens. Use it to select a directory and file name to print to. The output
file is ASCII text. 8
8.14.2 Printing from the Item Detail Window

For Procedures, Operations and FSTs, you have the option of printing
from the Item Detail window. When you print from the window, a popup
appears and provides the choices for printing:

J Tabs and Logic Instruction data — This option prints the complete
logic data—all the tabs and the instructions.

J Current Tab only — This option prints just the current tab.

Note ... When printing from an Item Detail window, the Logic Editor
always produces a text file of the printed data in the Control
Desktop Temp directory.

The default location for this directory is:

\Program Files\FRSI\ControlDesktop50\Temp

Using ENVOXr Server and Control Desktop (Original — May 2000)

 118 Section 8 F Logic Editor

Depending on the type of logic item you are printing, the text file created
is one of:

J lcp_fst_data.txt

J operation_data.txt

J procedure_data.txt

The file of a particular type is overwritten each time an item of that type
is printed. If you want to use these files for your own purposes, move or
rename them after printing an item.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Excel Matrix F Section 9 119

Figure 9-Table 9

9 9 Excel Matrix
Excel Matrix is an Excel add-in that you use to configure Loop or
Enhanced DCD (EDCD) points in a Microsoft Excel workbook. Using
Excel Matrix you can efficiently configure large numbers of these points.

9.1 Overview
In early releases of Control Desktop, configuration of multiple points was
provided through the Matrix views in Control Desktop. Unfortunately, due
to their relative complexity, Loop and Enhanced DCD points were
excluded. With release P5.0, that shortcoming is addressed by Excel
Matrix.

Excel Matrix leverages the power of Microsoft Excel to provide

workbooks through which you can configure multiple Loop and EDCD 9
points. The Excel menus are enhanced to include functions specific to
Control Desktop that you use to directly update or read from ENVOXr
databases. The module features include the following:

J The matrix configuration of Loops and Enhanced DCDs (EDCDs) is

provided through two separate Excel workbooks — one for Loops
and one for EDCDs.

J Each workbook contains a number of worksheets that together allow

the configuration of the applicable point type. The specific layouts for
these worksheets differ for the two point types, but the general
approach is the same.

J As with Open Database, you can save the workbook to disk for
offline work if it is necessary to stop at a given point and restart the
configuration work at a later time.

J Additionally, you can perform an update operation to write the

contents of the workbook directly to the ENVOX Server database or
can perform a select operation to read from the ENVOX Server
database.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 120 Section 9 F Excel Matrix

9.1.1 Excel Matrix User Interface

Excel Matrix is implemented as a Microsoft Excel add-in. While this

approach integrates Excel Matrix into ENVOX Server and Control
Desktop, it does not tie the module entirely to Control Desktop. Excel
Matrix can also be used as a standalone module that operates offline
even when Control Desktop is not running. Hence, a full client installation
of Control Desktop P5.0 is not required. To work offline you need only to
install the Excel Matrix add-in.

Note ... While it is possible to edit an Excel Matrix workbook on any PC

with Microsoft Excel, it is strongly advised that you edit Excel
Matrix workbooks only if the Excel Matrix add-in is
installed. The add-in automatically maintains information within
the workbook to ensure that the configuration database is
updated correctly.

9.1.2 Excel Matrix Connection with ENVOX Server

9 The connection between Excel Matrix and the ENVOX server uses the
DIAL (Dynamic Item Application Layer) Service and CDOS (Control
Desktop Open Server). You can create configuration data using Excel,
save that data as a file, and load it into the ENVOX database at any
time.

The chief advantage of Excel Matrix over the Open Database is that the
interface to the ENVOX database is achieved entirely through Microsoft
Excel, the NT and Windows spreadsheet application. The widespread
use of Windows NT and its associated applications places Excel Matrix
in the familiar Microsoft Excel environment and is a seamless extension
to Excel that becomes part of Excel but contains the essential
connection to the ENVOX server.

Figure 9-1 is a schematic of the Excel Matrix connection to the ENVOX

Server.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Excel Matrix F Section 9 121

File SQL Insert/Delete

Statements formulated by
DIAL service
Open/Save

Excel Workbook Update CDOS

Database DIAL Service

Select CDOS Server converts ENVOXDB

from to Update/Delete
Database statements which minimize
database changes

Figure 9-1. Excel Matrix Connection to ENVOX Server

You can save the workbook to disk for offline work. Additionally, though,
can write the contents of the workbook directly to the ENVOX Server
database or can perform a select operation to read from the ENVOX
Server database.

There are three components to this facility:

9
J Excel Workbooks — provide the entire user interface. New menu
commands in Excel initiate the reading from and writing to the
ENVOX Server database.

J The DIAL Service — provides DCOM objects, which the Excel

worksheets use to access the ENVOX Server database.

J CDOS — provides read/write access to the ENVOX Server database

including the save checks that are essential in preventing invalid
configuration data being written to the ENVOX Server database.

For comparison purposes, the previous method of creating and updating

data in the ENVOX database using Excel with Open Database is
illustrated in Figure 9-2.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 122 Section 9 F Excel Matrix

Open/Save
File
Load

Excel Workbook
Unload Synchronize

INSTRMNT
Open Database

Populate EVX like

(phase 1)
ENVOXDB
Populate
(phase 2)

Figure 9-2. Excel and Open Database

With Open Database, an Excel workbook was saved to disk and the
resultant file loaded into the Open Database’s tables. These files were
then later merged into the ENVOX database through a populate
operation.

9 9.1.3 Workbooks

There are two workbooks that provide multiple point configurations for
loops and EDCDs. The workbooks provide the capability to:

J Load selected configuration data into the worksheet tables

J Update the ENVOX Server database with the information in the

tables. In normal use, no such connection exists; the worksheet
always operates offline.

Control Desktop displays a dialog for you to choose the type of workbook
you want to start, or you can open a previously saved workbook using
the From File field. You can also create a new Excel Matrix workbook
from within Excel. Figure 9-3 shows the dialog that opens from Control
Desktop.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Excel Matrix F Section 9 123

Figure 9-3. Workbook Type Selection Dialog

For both Loops and EDCDs, the Excel Matrix workbooks are made up of
worksheets containing configuration data. There are five worksheets
within the Loop workbook and six within the EDCD workbook. However,
there is a fundamental difference between the two workbooks. The
workbook used to configure loops represents a single loop point by a
single row in one of the five worksheets. The workbook used to configure
EDCDs represents a single point in several rows in all of the worksheets.

Excel Matrix does not check if points are defined more than once in any 9
Loop worksheet or the Main worksheet of an Enhanced DCD workbook.
If a point is defined more than once, during a Database update every
definition is written to the database. Only the last definition written
remains in the database. Usually this is the last definition in the
worksheet, but this is not true in all cases. For best results ensure that
you have not defined any point more than once.

Note that it is clearly valid for a point tag to appear in more than one row
of any of the sub-worksheets of an Enhanced DCD workbook (Inputs,
Outputs, Disabled SPs, Conditions, and Actions). Only if more than one
row contains identical values in the POINT TAG and POSITION columns
(of the Inputs worksheet, for example) is this considered duplication. If
duplicates exist, all rows are written to the database during an Update
DB operation, but only the last row written remains in the database.

Both workbooks provide a status column for each item. The status
column is not directly user editable, but is automatically updated as the
points are modified or written to the database. The values in the Status
column affect the operation of Update and Select commands:

J Blank — indicates that Excel Matrix will not ordinarily process this
item during an Update operation

J Modified — indicates that the user has modified the item on at least
one of the worksheets in a workbook. Excel Matrix processes this

Using ENVOXr Server and Control Desktop (Original — May 2000)

 124 Section 9 F Excel Matrix

item during an Update operation. New items always have a Modified

status.

J Delete — indicates that the item will be deleted from the ENVOX
database during the next Update operation at which time it will also
be removed from the worksheet.

J Error — indicates items that contain one or more errors detected

during an Update operation.

J Sample — indicates items that will be completely ignored by an

Update operation. These items are provided as sample items on
which configuration engineers may base their real items.

These are the only values that are valid for the Item Status field. These
values are not stored in the database, but are informational for the user
and are essential to control update operations. The processing for points
varies for each of these Item Status values according to the user’s
specification in the dialog for the Update DB menu option:

J Changed Points — all points with an Item Status of Modified, Delete,

and Error are sent for processing.

J Selected Points — all selected points except those with Item Status
9 of Sample are sent for processing.

J All Points — all points except those with Item Status of Sample are
sent for processing.

9.1.4 Loop Configuration Workbook

You can configure Loops through a five-worksheet workbook. Each
sheet is labeled for and handles one kind of loop. The types of loops are
the following:

J PI/PID/I — provides a standard two- or three-mode control function

or an integral (I) only function.

J Signal Selector — provides a four-input signal selector with high or

low signal selection and logic inputs that indicate which input was
selected. The selected signal corresponds to the highest or lowest
implied valve position.

J Manual Loader — provides manual control of a final control element

from a remotely located operator control room.

J Bias and Gain — provides a proportional bias and gain function on

the PV input.

J P/PD with Bias — provides a standard one- or two-mode control

function.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Excel Matrix F Section 9 125

There is also a Messages worksheet that holds messages resulting from

database update operations

These worksheets operate independently of each other such that an

Update DB, when performed in one loop worksheet, will not cause data
from the other four loop worksheets to be sent to the database.

The saved workbook is the same as any other workbook created in

Excel and can therefore be opened by any user of Excel regardless of
whether they have the Excel Matrix add-in installed. However, such a
user should not edit the data, since the ITEM STATUS column will not be
correctly maintained.

9.1.5 Enhanced DCD Workbook

You can configure Enhanced DCDs through a six-worksheet workbook.
Each sheet covers a separate portion of the Enhanced DCD
configuration.

Figure 9-4 shows part of the Main sheet of an example Excel Matrix
workbook for EDCD points.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 126 Section 9 F Excel Matrix

Figure 9-4. Excel Matrix Enhanced DCD Workbook

For information on the use or meaning of any portion of the workbook,

refer to the Excel Matrix online help.

The types of worksheets are the following:

J Main — general information about an Enhanced DCD item, the

operating mode, the RSP mode and SP information. The remaining
worksheets contain related list data for Enhanced DCDs.

J Inputs — up to 16 Input Instrument Signals.

J Outputs — up to 8 Output Instrument Signals.

J Disabled SPs — deny operators access to up to 16 specific

setpoints.

J Conditions — up to 8 Enhanced DCD conditions.

J Actions — up to 16 Enhanced DCD actions.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Excel Matrix F Section 9 127

There is also a Messages worksheet that holds messages resulting from

database update operations.

These worksheets are interrelated. A fully configured Enhanced DCD

may have data on all 16 worksheets If you delete an item on the Main
worksheet, the corresponding data for this item is also removed from the
other worksheets. If you modify an item by editing an existing row on a
subsheet or by adding or deleting rows from subsheets, the item is
marked Modified on the main worksheet.

If you update an Enhanced DCD point to the ENVOX database from

Excel, the data in Excel replaces rather than appends the data in the
database. For example, if the database has 16 disabled SPs for a
particular point, and the point has only 8 in the workbook, updating
replaces the 16 SPs with the 8.

The saved workbook is the same as any other workbook created in

Excel and can therefore be opened by any user of Excel regardless of
whether they have the Excel Matrix add-in installed. However, such a
user should not edit the data, since the ITEM STATUS column will not be
correctly maintained.

9.1.6 Additional Menu Options

9
The following is a list of all the additions to the standard Excel menus
that are as a result of the add-in. Some of the options are available from
more than one menu, some are only available under certain conditions
(e.g., an item highlighted) and some are available from the context (right
mouse) menu:

J New Workbook — opens a new workbook of the type specified

J Select from DB — retrieves point data from the designated ENVOX

database and inserts the data into a workbook’s worksheets

J Update DB — sends points for processing to database

J Insert Rows — inserts rows in one worksheet

J Insert Columns — inserts columns in one worksheet

J Create from — creates a new point from the currently selected point

J Delete Item From Spreadsheet — Deletes the selected point from the
workbook, but does not affect the database.

J Delete From DB (on Update) — Marks the selected point for deletion
from the database the next time database is updated

J Set Item Status — enter either Sample or Modified in the Item Status
field for the point

Using ENVOXr Server and Control Desktop (Original — May 2000)

 128 Section 9 F Excel Matrix

J Format Column — set the width of the current column or columns.

Enter a value or size to fit.

J Sort — Sorts the list of points by the field(s) specified.

J View Messages — View any messages generated during the

previous database update and locate the cell that caused the error.

J Help — Opens the help for Excel Matrix

The Select from DB and Update DB options open a dialog through

which you can connect to the CDOS and SYBASE servers with the
database name and the uppercase ENVOX user name and password.
The dialog for the selection operation that reads from the database
contains a multi-line edit box. Use the edit box to create an SQL ‘where’
clause to filter the rows selected. The columns attached to the header
cells provide information about the column names to use in where
clauses you create.

You can select and update in the following ways:

J Select from the database — retrieves the data appropriate to the

active worksheet from the database and replaces the worksheet
contents with this data.
9 J Update the database — causes a series of insert and delete
statements to be sent to the database so that, on completion of the
update operation, the database contents match the worksheet
contents. Changes to the database table are minimized to avoid
unnecessary verification and generation.

9.1.7 Multiple Concurrent Users

The configuration of multiple Loops and Enhanced DCDs is carried out
offline within Excel Matrix. While these points are being edited in Excel,
there is no locking mechanism that prevents other users editing the
same points in Control Desktop. Since items are only loaded into the
ENVOX database from Excel Matrix if they have an Item Status of
modified, unaltered items are not written to the database.

If more than one user is making configuration changes to the same

points, it is possible that a database update initiated by one user will
overwrite changes made by another user. Therefore, it is good working
practice to not have more than one person configuring the same points
simultaneously.

9.2 Installing the Add-In

As part of the main Control Desktop installation (from CD-ROM), Excel
Matrix is installed on your workstation. If you have elected to perform a

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Excel Matrix F Section 9 129

Custom Client install on a machine separate from the server, Excel

Matrix is installed on the workstation that is designated as the client
machine when you perform the Client Only installation. In addition, you
may elect to install only the Excel Matrix add-in under the Custom Install
option.

In most circumstances, the full Control Desktop installation is all you

need to do. The Excel Matrix Add-In is a demand-loaded add-in,
meaning that it is used by Microsoft Excel only when necessary, so as to
not unnecessarily use resources in Excel.

When Excel has been updated with the add-in, there are various
additional menu options (including a new menu Control Desktop) that
provide facilities you can use when you configure Loop and Enhanced
DCD points.

If, during installation, you selected either the full Control Desktop option
or the Excel Matrix option, the Excel Matrix add-in is installed and added
to Microsoft Excel, ready for use. Under unusual circumstances the
add-in file is added to the machine’s hard disk but is not added into
Excel. In this case manual addition of the add-in from within Excel is
required.

The Control Desktop menu is available, though many of the options may
be grayed out. When you start a new workbook or open an existing 9
workbook, the add-in is fully loaded.

There are some situations where the Excel Matrix add-in is not installed
and loaded into Excel. You can tell that this is the case if you cannot see
the Control Desktop menu in Excel. In this case, you need to manually
install the add-in to Excel.

Three situations in which the add-in may not be immediately available in

Microsoft Excel are:

J Where the add-in has been unloaded (switched off) from within Excel

J Where the add-in is installed onto a workstation with Microsoft Office

2000 on it before Microsoft Excel has ever been launched on that
workstation

J Where the add-in is installed onto a workstation before Microsoft

Excel (Office) has been installed on that workstation.

For detailed information about the installation of ENVOX Server and

Control Desktop and all of the modules and utilities that accompany the
software, refer to the ENVOX Server and Control Desktop Installation
Manual, Installing ENVOX Server and Control Desktop, PN:SW3159
(Original — May 2000).

Using ENVOXr Server and Control Desktop (Original — May 2000)

 130 Section 9 F Excel Matrix

9.3 Launching Excel Matrix

There are two ways in which you launch Excel Matrix. Excel Matrix can
be launched from within Control Desktop or used directly from Excel.

Launch Excel Matrix from within Control Desktop under the View
top-level menu option and select Excel Matrix. Be sure that you have
logged in and are connected to the server and database.

As a standalone module, launch Excel Matrix by starting Microsoft Excel.

Excel opens and contains the added menu functionality that enables you
to use Excel Matrix regardless of how you launched it.

9.4 Using Excel Matrix

There are many tasks you can perform with Excel Matrix when carrying
out configuration of multiple Loop and Enhanced DCD points. See the
online Excel Matrix help file for illustrations of the module’s windows and
detailed instructions for performing tasks. The tasks available with Excel
matrix are the following:

J Start a New Configuration Project

Create a Workbook
9 J

J Create a Sample Workbook

J Transfer Data to and from the Database

J Edit Existing Database Data

J Open Data from an External Source in Excel

J Update the ENVOX Database with New Data

J Delete Data from the ENVOX Database

J Examine Errors and Warnings

In addition, Excel Matrix provides you with the ability to adjust your
worksheets for the type and quantity of data that you are configuring.

9.4.1 Start a New Configuration Project

When you start a new configuration project from scratch, part of what
you may need to configure may be Enhanced DCD or Loop items.

To enter new data for Loop or Enhanced DCD points, use the Excel
Matrix add-in to enter a workbook of data, which you will later load into
the ENVOX database. Each time you save your data, the data items
displayed in the worksheet are flagged with Modified in the Item Status

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Excel Matrix F Section 9 131

column to indicate that you are entering new data. See the Excel Matrix
Add-in online help file for illustrations of this procedure and detailed
instructions for this task.

When you have finished entering the data and have manually checked
that it seems accurate, you can update the ENVOX database with the
data with Update DB menu option. The data is written to the database.
All rows that are successfully written to the database have the Modified
removed from the Item Status column. Items with problems have an
Item Status of Error. Commands are available through which a
description of the error can be displayed. You can edit the data in order
to correct the problem and then send the corrected data to the database
with the Update DB menu option.

9.4.2 Create a Sample Workbook

You can use a feature of the Excel Matrix Add-In to create a sample
(template) workbook for Enhanced DCD points. The module lets you
create a new workbook, insert sample configuration items of typical point
data, identify them with easily recognizable tags, and save the workbook
to disk with a suitable name.

Once the workbook is complete, the user changes the Item Status to
Sample by using the Set as Sample menu option so that configuration 9
engineers can readily identify the workbook as a sample. Any
configuration engineer who wants to create and to configure EDCD
points can use the workbook sample. You can also create Sample items
in your normal Excel Matrix workbooks. The sample items created are
useful in two ways:

J You can use Excel’s AutoComplete function to correctly complete

multi-choice cells

J If a point exists on your worksheet that is similar to one you want to

create, you can copy its details into the new point. Copying a main
point has the effect of also copying all related data on the other
worksheets.

9.4.3 Transfer Data to and from the Database

The tasks that you can perform with Excel Matrix to transfer data to and
from the database enable you to bring database information into a
workbook so that you can make changes to item information regardless
of the source of your database. You can also examine, track, and correct

Using ENVOXr Server and Control Desktop (Original — May 2000)

 132 Section 9 F Excel Matrix

errors in the information that you are changing. In Excel Matrix, you can
do the following:

J Modify Existing Databases

J Open Data from an External Source

J Update the Database with New Data

J Examine Errors and Warnings

9.4.3.1 Modify Existing Databases

You can make changes to a large number of Loop points in the ENVOX
database. The Excel Matrix module provides a dialog in which you enter
selection criteria using the SQL where clause. You can also restrict the
query to points sourced on a specific tag so that the data for that tag are
read into the workbook.

The module displays an icon in the data column headings that displays
comments when you pass your cursor over the icon. These comments
provide the table name and column name of the database column. You
can use this to make sure that your SQL query is accurate.
9 You can then edit the worksheet and save the workbook to disk. The
Item Status changes from no entry to Modified to indicate that the data
has been changed. You should save your changes at regular intervals.

Once you have finished editing, you instruct the module to update the
database. The term Modified is removed from the Item Status of items
that are successfully written. Items with problems have an Item Status
displaying the term Error. For those items that display an error, you can
re-edit the data to correct the problem and then instruct the module to
write the corrected data to the database. As usual, you can save the
workbook to disk for future reference.

9.4.3.2 Open Data from an External Source

If you have a source, such as a database, which contains data (e.g., for
loops) that you want to load into the ENVOX database, you can open
data from that source. The procedure has two steps: export the data
from your database to a .CSV file and import the file into Excel. You can
then create a new workbook for this data, save it to disk and copy and
paste the contents of the .CSV workbook into this new workbook. The
items in the worksheets will show an Item Status of Modified.

You can now check each of the worksheets to make sure the data
seems correct and can update the database with these details.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Excel Matrix F Section 9 133

9.4.3.3 Update the Database with New Data

Once you have a Loop or Enhanced DCD workbook in Excel that

contains items, you can update the ENVOX database with this data. You
can update the database with the following:

J Some of the changed points — select only these items. All items are
updates except those with an Item Status of Sample.

J All of the changed points in the workbook — the default option

J All Points — updates the database with every item in the workbook
except those with an Item Status of Sample

The module indicates which items are successfully written to the

database by removing Modified from their Item Status. Items with
problems show Error. Deleted items are removed from all worksheets in
the workbook.

This option may take some time. If it does, then a message may be
displayed “Microsoft Excel is waiting for another application to complete
an OLE application.” Because this process uses the DIAL Service, which
is built on OLE technology, you may need to wait some minutes before
the process finishes.

As in the other situations, you can examine the error messages, edit the
9
items to correct them, write them to the database, and save the
workbook to disk for future reference.

9.4.3.4 Examining Errors and Warnings

You may want to examine errors that result from an update operation so
that you can correct any data that is incorrect. On completion of an
update operation, a dialog summarizes the update operation. This dialog
shows how many errors occurred. Edit your data, write the corrected
data to the database, and save the workbook to disk. See the Excel
Matrix online help file for detailed instructions for this procedure.

9.4.4 Edit a Workbook

There are a number of tasks that you can do to set up your workbook for
the type and quantity of data that you are configuring. The module lets
you edit a workbook in the following ways:

J Insert a Row

The top header cells (colored by default) in a Loop or Enhanced DCD

worksheet are protected so that they are read-only. Therefore, you
cannot edit them or add new items among them. However, you can
add items in the main area of the worksheets. You may do this so

Using ENVOXr Server and Control Desktop (Original — May 2000)

 134 Section 9 F Excel Matrix

that you can create a new point in the position of your choice in the
worksheet.

If there is already a point that contains information similar to the one

you are creating, you can create a new point based on an existing
point. Since it is not possible to edit the ITEM STATUS column, copy
and paste has to be used with care so as to avoid any cells in that
column.

J Create a Point from Another

If a point exists on your worksheet that is similar to one you want to

create, you can copy its details into the new point. Copying a main
point has the effect of also copying all related data on the other
worksheets making it particularly useful with Enhanced DCDs, which
may have related data in all five of the subordinate worksheets
(Inputs, Outputs, etc.).

If you need to create many points with similar details, you can create
a sample item to act as a template, enter the details into a new item,
and mark the item with an Item Status of Sample.

J Insert a Column

9 The main columns in a Loop or Enhanced DCD worksheet are

protected so that they are read-only. Therefore, you cannot edit them
or add new ones between them. However, you can add columns to
the right of the main columns, or simply type into the columns that
exist there.

Information in the columns to the right of the main protected columns

is stored in the Excel workbook but is not written to the ENVOX
database.

J Delete a Row

Deleting a row from an Excel Matrix worksheet does not remove the
item from the ENVOX database.

J Delete Items

You must select each row that contains data for the items that you
want to remove from the workbook. This operation does not delete
the item from the database — it simply removes it from the workbook
you are editing.

J Delete Data from the Database

Once you have opened a workbook in Excel Matrix that contains the
items you want to delete, you can select those items and instruct the
module to delete them. It is also possible for you to edit items that
need correction at the same time. When you select the update option

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Excel Matrix F Section 9 135

to update the database, corrected items are written to the database

and deleted items are removed.

For an EDCD workbook, you can only delete data from the Main
worksheet.

J Using the Supplied User Data Columns

Columns C, D and E of all Loop and Enhanced DCD worksheets

(except Messages) are User Data columns entitled User Col 1, User
Col 2 and User Col 3. You can enter whatever information you want
into these columns.

Information in the User Data columns is stored in the Excel

worksheet but is not written to the ENVOX database.

Typically, you can hold data in the User Data columns in order to sort
points.

J Change the Width of Columns

You cannot change the width of the Loop and Enhanced DCD
worksheet columns in the same way you change standard Excel
worksheets because the cells are locked and cannot be deleted or
altered. Header cells are locked to avoid inadvertent changes that
may prevent the add-in functioning properly.
9
The module provides two ways in which you can change column
widths. You can make the column width fit its contents or change the
column width to a value of your choice. See the Excel Matrix Add-in
online help file for detailed procedures to accomplish this task.

J Change the Item Status

The Item Status column is included on all Loop worksheets and on

the Main worksheet of Enhanced DCD workbooks. It indicates the
status of each point. There are five statuses:

j Blank — this item is ignored during a database update. Items

initially have a blank status if you have selected and retrieved
them from the ENVOX database. You cannot manually set an
item to have this status.

j Modified — this item has been changed on at least one of the

worksheets or is a newly created item. Modified items are
included in database updates. You can manually set an item to
have this status.

j Delete — this item will be deleted from the database during the
next update. Upon completion, the item is also removed from the
workbook. You can manually set an item to have this status.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 136 Section 9 F Excel Matrix

j Sample — this item is ignored during a database update. These

are used as sample (template) items for configuration engineers
to base real items on. You can manually set an item to have this
status.

j Error — this item contains one or more errors. This status is

automatically assigned to items during a database update if a
problem is encountered. You cannot manually set an item to have
this status. Error items are included in updates.

J Sort Rows

You can sort the rows on the worksheet into alphanumerical order.
You can choose to sort the items by any column, in either ascending
or descending order. You can carry out a multi-level sort, specifying
up to three sort keys.

Each worksheet of the two workbooks contains USER DATA

columns. You can use these columns as sort keys and sort the points
on the information you enter in these columns

J Messages

There are four message menu options that control how you navigate
9 through the messages and errors generated as a result of a
database update:

j First — displays the first message for an item that contains a

problem

j Next — takes you to the next message for an item with an error

j Back — steps you back to the previous message

j Current — lets you browse the Messages worksheet directly and

then move immediately to the offending cell in the desired
configuration worksheet.

These menu options are disabled if the active worksheet is not the
Messages worksheet.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Generate, Download, and Upload F Section 10 137

Figure 10-Table 10

10 10 Generate, Download, and Upload

This section explains the processes required to create download files
from configuration data (generating), the different download procedures
(including download backup, creating emergency download files, and
downloading from backups), and how you save tuned data from devices
to the configuration database (uploading).

10.1 Generating
When you have entered all of the configuration data into the database,
you need to send the data to the PROVOXr devices. The Generate
application extracts data for each device from the database and creates
a file that is ready to download to a selected device. The Generate
application also checks for inconsistencies or errors in the data before it
creates the download file.

10
Note ... You need to generate the device each time you modify or add
new data to the device’s configuration. If you do not generate
the device after changing the configuration, the next download
does not include the new data.

To generate the download files, choose one of the following methods:

J Select the Application –> Generate, option in the top level menu

J Select the Generate option in the right mouse menu when in the
Resource or Plant I/O navigators at the device level

J Select the Task Monitor view from the View option in the top level
menu

If you select Generate from the top level menu, Control Desktop displays
the Devices to Generate window that lets you enter the devices you
wish to generate. In the window:

Step 1: Enter the devices to generate.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 138 Section 10 F Generate, Download, and Upload

Step 2: Select the Action –> Submit Job, option in the top level
menu or click the Submit Job icon in the Toolbar.

The system displays a response informing you of the success or

failure of the generate command.

Figure 10-1 illustrates the Devices to Generate Window.

10
Figure 10-1. Devices to Generate Window

To generate individual devices in the Resource Navigator window,

highlight the device, then click the right mouse button and select the
Generate option. The system displays a response informing you of the
success or failure of the generate command; it does not display a
Devices to Generate window.

When you select the Task Monitor for a selected device, the system
launches the Task Monitor application and displays generate information
for the selected device.

10.2 Downloading and Related Tasks

The term downloading covers several related tasks:

J Downloading generated configuration data to devices

J Backing up a complete download database

J Downloading from a backup

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Generate, Download, and Upload F Section 10 139

J Downloading from a command prompt

J Creating emergency download files

10.2.1 Downloading to Devices

Once you have generated the download data using the Generate
application, you send (download) the data to the PROVOX devices. You
can choose whether to download information to one or several devices,
download the entire configuration for a device, or download only the
changes to the configuration since the last download (a partial
download).

10.2.1.1 Downloading from Control Desktop

To download to devices, choose one of the following methods:

J Select the Application –> Download, option in the top level menu

J Select the Download option in the right mouse menu when in the
Plant I/O or the Resource navigator at the device level

J Select View --> Task Monitor view from the top level menu

In the first two cases, Control Desktop opens the Devices to Download
window shown in Figure 10-2. 10

Figure 10-2. Devices to Download Window

Using ENVOXr Server and Control Desktop (Original — May 2000)

 140 Section 10 F Generate, Download, and Upload

Use the window to enter the devices you wish to download. In the
window:

Step 1: Enter the devices to download.

Step 2: Click Download Required to display a list of the types of

downloads available for the selected device. The types of
downloads are described in Table 10-1.

Step 3: Select the type of download to perform.

Step 4: Select the Action –> Submit Job, option in the top level
menu or click the Submit Job icon in the left Toolbar.

The system displays a response informing you of the success

or failure of the download command.

10.2.1.2 Downloading from The Task Monitor

You can also download from the Task Monitor. You might want to do this
if the original download failed but you are already using Control Desktop
for another job. You can download devices from either the Job List or the
Tag List view.

To download a device from the Task Monitor:

10 Step 1: From the Job Type drop-down list, select DOWNLOAD.

Step 2: From the list of jobs or tags, highlight the device, or devices.

Step 3: Select Job --> Download.

The Devices to Download window opens.

In Job List view, the previous type of download (download

current configuration, download from backup, or create
emergency download files) is carried out. In Tag List view, the
current configuration is downloaded, regardless of the
previous type of download that was carried out. The
exception to this is if you are running a download from backup
for devices that previously failed.

Step 4: Unless you are creating an emergency download file, choose

the type of download you require. If you choose none, Task
Monitor does not submit the Download job for that device.

Step 5: Click OK.

Task Monitor prompts you to confirm that you want to

download information to this device.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Generate, Download, and Upload F Section 10 141

Step 6: Click Yes to download information to the device.

Task Monitor displays a message when it has submitted the

job successfully.

Step 7: Click OK.

Task Monitor displays the progress of the job. When the job is
complete, the Task Monitor icon in your Windows task bar and
the Task Monitor title bar flash.

Table 10-1 describes types of downloads and the configuration

information that is downloaded for each type. Note that when you open
the Download Required pull-down list in the Devices to Download
window, the list contains only the download types valid for the selected
device.

Table 10-1. Types of Downloads

Type Description
I-total For SR90 and SRx controllers. Downloads all of the related
information for the selected device. When received, the
controller sets its state to initialized and clears its
configuration memory.
M-total For controllers other than SR90 and SRx. Downloads all of
the related information for the selected device.
M-partial Downloads only the device configuration data that has
changed since the last download. 10
Total For devices that are not controllers, such as CHIP devices
and consoles. Downloads all of the related information for
the selected device.
Partial For devices other than controllers such as CHIP devices and
consoles. Downloads only the device configuration data that
has changed since the last download.
None Downloads no data because there have been no changes to
the device configuration data.

10.2.1.3 Downloading from A Command Prompt

If you are logged in to the ENVOXr Server, you can download to devices
from a command prompt using the dlexec command. The syntax for the
command is:

dlexec /C[:]CDOS /S[:]SYBASE /D[:]DATABASE

/U[:]USERNAME /P[:]password [/M[:]downloadMode]
[/F[:]Folder] [/t[:]Timestamp] [/T[:]deviceTag]

Using ENVOXr Server and Control Desktop (Original — May 2000)

 142 Section 10 F Generate, Download, and Upload

Where:

/C Connect through a CDOS Open Server.

CDOS The name of the CDOS Open Server.

/S Specify a SYBASE Server to use.

SYBASE The name of the SYBASE Server.

/D Specify a database to use.

DATABASE The name of the database

/U Defines the ENVOX username.

USERNAME The uppercase ENVOX username.

/P Defines the ENVOX user’s password.

password The ENVOX user’s password.

/M Use to specify the type of download required.

downloadMode
Must be one of total, partial, I--total, M--total, M--partial,
TO--ED

/F Use to specify the directory to create the ED file in.

Folder Only valid if download mode is TO--ED

/t Use to specify a specific timestamp for the ED file. Only

valid if download mode is TO--ED
10 Timestamp Date and time of the file in the form :
YYYY_MM_DD_HH_MM.
For example, 1999_05_12_07_30

/T Defines the tag of the device to be downloaded

deviceTag Tag of the device to download.

Note ... The dlexec command also has a /J switch. Do not use this
switch. The Client Task Daemon uses this switch when it runs
this command for Control Desktop.

For example, to download a device enter a command like the following:

dlexec /C:CEDOS_NTTGT /S:TUBAL /D:ENVOXDB /U:SMITH

/P:password /M:total /T:MYDEVICETAG

Note that the switches must be entered in the case shown.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Generate, Download, and Upload F Section 10 143

10.2.2 Download Backup

After you have completed your configuration and have a working set of
download files, 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.

You cannot backup a single device — all successfully generated devices

are backed up. The backup you create is stored in the database.

To backup configuration download data, follow these steps:

Step 1: Select Application --> Download Backup.

A dialog containing a message about the implications of

backing up download data appears.

Step 2: Click Yes to continue. The cursor changes to an hourglass

while the backup takes place.

When the backup is finished, an informational dialog appears.

Step 3: Acknowledge the dialog.

During the backup, which may take some time, no devices can be
generated. (Devices, can be downloaded, however, both from backed up
or normal download data, providing this is done from another Control
Desktop session.) 10
You can now download from the backup you created, if it becomes
necessary. Refer to subsection 10.2.3 for more information.

You can also create emergency download files. Refer to subsection

10.2.4 for more information on creating emergency download files and
downloading from emergency backup files.

10.2.3 Downloading from Backup

If you have created a download backup (see subsection 10.2.2), you can
download directly from that backup file to return to the configuration you
saved in the backup. You may need or want to do this if changes you
make to your configuration after you create a download backup do not
work. Downloading from the backup takes you to a known state.

To download from a backup, follow these steps:

Step 1: Select Application --> Download from the top-level menu.

The Devices to Download window appears.

Step 2: Select Download From Backup from the Download Option

drop-down list.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 144 Section 10 F Generate, Download, and Upload

Step 3: Enter the device tag names, or click Tag Values and select
the appropriate device tags of the devices you want to
download. (If the device has not been backed up, then a
message is displayed informing you of this. The device tag is
grayed out in the list.)

If you have selected a tag set, the Devices in Tag Set dialog
is displayed, showing the tags referenced by the tag set.
Select the ones you want to include in the download.

Step 4: For each device, select the type of download required.

Step 5: When you have finished selecting devices, click the Submit
Job icon on the toolbar, or select Action --> Submit job.

You can review the status of the download from within Task Monitor.
Click on the Help Map button at the top of this window, and select Task
Monitor for more information. After a download from backup, the next
download of that device from the current database must be a total
download.

You can select the Data --> Report menu option on the Task Monitor for
a particular job, or click the Report toolbar icon to produce a report of
the process — the Report dialog is displayed. When you run the report,
the Download Report dialog is displayed for you to view the details.

When the download procedure is complete, Task Monitor informs you of

10 how successful it was.

10.2.4 Emergency Downloading

The emergency download feature provides the following capabilities:

J Create emergency download files containing download data for a

single device or selected devices. You can create emergency
download files from Control Desktop or from the command line on the
server.

J Download a device from the emergency download file if the SYBASE

server is not available or if your ENVOX database is suspect
(requires that the machine you download from has had the
Emergency Download utility and CHIP installed on it).

CHIP must be running to be able to perform any of these tasks.

You must create an emergency download file for each device. 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.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Generate, Download, and Upload F Section 10 145

You can create an emergency download (ED) file in either of two ways:

J Using the Control Desktop user interface

J Using a command at the system prompt from the server

You are prompted for a location to store the emergency download files
on the server.

10.2.4.1 Creating an Emergency Download File from Control Desktop

You create Emergency Download files through the Control Desktop
interface for selected devices or for one device. To create an emergency
download file:

Step 1: Select Application --> Download from the main menu.

The Devices to Download window opens as shown in

Figure 10-3.

10

Figure 10-3. Initial Devices to Download Window

Step 2: Select Create Emergency Download File from the

Download Option drop down list.

Step 3: Enter device tag names or click Tag Values from the context
menu and select tags from the list that appears.

Step 4: If you select a tag set, the Devices in Tag Set dialog
appears, showing the tags referenced by the tag set. Select
the tags you want to include.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 146 Section 10 F Generate, Download, and Upload

As you select or enter tags, the software fills in the Download

Required, Status, and Last Downloaded columns as shown
in Figure 10-4.

Figure 10-4. Devices to Download Window after Entering a Device

Note that the software allows you to enter or select only tags
10 of devices which have been successfully generated.

Step 5: After you have entered or selected all the tags you want to
create emergency download files for, select Action -->
Submit job from the main menu.

The Enter Emergency Download File Path dialog appears.

Step 6: Enter or browse to the path where you want to save the
emergency download files. You can save download files to
the server or any networked PC.

Step 7: Click OK to start creating files.

You can review the status of the job from the Task Monitor.

10.2.4.2 Creating an Emergency Download File From A Command

Prompt

If you are logged in to the ENVOX server, you can create emergency
download files from a command prompt using the dlexec command. To
see the command line options for the dlexec command refer to
subsection 10.2.1.3.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Generate, Download, and Upload F Section 10 147

For example, to create an Emergency Download (ED) file enter the

command:

dlexec /C:CEDOS_NTTGT /S:TUBAL /D:ENVOXDB /U:SMITH

/P:password /M:TO-ED /F:c:\MyEDFiles /T:MYDEVICETAG

Note that the switches must be entered in the case shown.

10.2.4.3 Downloading from an Emergency Download File

It is possible to download devices using emergency download files from
a machine other than an ENVOX server using the dlexec_ed command.
To use the command you must first install CHIP and the Control Desktop
Emergency Download utility on the machine.

To see the syntax of the dlexec_ed command enter dlexec_ed /?:

C:\>dlexec_ed /?
Parameters required :

<Device tag> ”FROM-ED” <Directory> [<Download type>]

(<Download type> : total,I-total,M-total)

For example, to perform a total matching download from an

Emergency Download (ED) file in the directory c:\MyEDFiles to
device MYDEVICETAG, enter:
10
dlexec_ed MYDEVICETAG “FROM-ED” c:\MyEDFiles M-total

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 emergency

download file maintenance. This maintenance includes purging and
deleting old emergency download files and log files and, for data
protection, copying emergency download files onto tape, another disk, or
another machine on the network.

10.2.4.4 Emergency Download File Names

The software names the emergency download files in the following
format:

DeviceTag_mask_yyyymmddhhmm.dwn

The DeviceTag part of the name is the device tag. If the tag is fewer than
12 characters, it is filled with underscores. The mask part of the file name

Using ENVOXr Server and Control Desktop (Original — May 2000)

 148 Section 10 F Generate, Download, and Upload

depends on the length and the characters used in the tag. Each letter in
the tag becomes an l (letter l) in the mask. Each number in the tag
becomes a d. Each hyphen becomes an h.

For example, if you create an emergency download file for DEVICE-1 at

1:26pm on May 8, 2000, the file is named:

device-1_____llllllhd_200005081326.dwn

Breaking the name into its components and explaining the pieces results
in:

device-1____ -- tag
_ -- separator
llllllhd -- tag mask
_ -- separator
2000 -- year
05 -- month
08 -- day
13 -- hour
26 -- minutes
.dwn

As another example, if you create an emergency download file for

PROVUEr console PROVUE-1-B32 at 3:24 pm on May 28, 2001, the file
name is:
10 provue-1-b32_llllllhdhldd_200105281524.dwn

10.3 Uploading
You can use Control Desktop to upload the values of detail display
parameters (DDPs) from a downloaded and tuned PROVOX device to a
Control Desktop database. You can also determine the status of upload
requests. Upload also makes it easier to update the source configuration
data and encourages the regular backup of the tuned parameters.

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 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 Control Desktop. This configuration is
stored on disk.

J The on-line configuration — the dynamic, tuned configuration data

running in the PROVOX devices.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Generate, Download, and Upload F Section 10 149

The upload utility enables you to replace data in the configuration

database with data directly retrieved from on-line devices.

Uploading an item updates the database, but not the download data.
After uploading, you must generate all devices affected by the uploaded
changes.

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
should not be permanently included in the database. (REM OFS
exemplifies this type of DDP. Normally a point is tuned off scan to get 10
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 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.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 150 Section 10 F Generate, Download, and Upload

10.3.1 Upload Procedure

To upload an item, follow these steps:

Step 1: Select Application --> Upload.

The Upload window is displayed as shown in Figure 10-5.

Figure 10-5. Upload Application

Step 2: Enter the name of a tag or tag set. You can select Tag Values
from the context menu to select from a list.
10 The status of the tag is shown.

Step 3: Repeat this for all the tags you want to upload.

Step 4: When you have selected all the tags, select Application -->
Submit job to submit the upload. You can use Task Monitor
to monitor the status of the upload.

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, they are not uploaded.

The uploadable point types are: LOOP, GROUP, DCD, AO,DO, PDO, AI,
DI, DM, PCI, LCP, EPCI, MUX EXT DO, MUX STD AO, MUX EXT AO,
MUX STD AI, MUX EXT AI, MUX DI, CONFIGURABLE DCP, IAC DCP,
IAC ANALOG ICP, and IAC DISCRETE ICP.

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.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Generate, Download, and Upload F Section 10 151

10.3.2 Upload Privileges

The system administrator provides you with the privilege to upload

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 software displays error
messages to indicate when you do not have sufficient privilege to
perform uploads.

10.3.3 Upload Failures

If the 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:
10
j Points that have not already been uploaded in the lost controller
are not uploaded.

j 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

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.

10.3.4 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.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 152 Section 10 F Generate, Download, and Upload

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
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.

10.3.5 Upload Data Precision

Uploading may produce values in the database that differ slightly from
the values in the controllers.

10 The 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 after
Device Upload
14.0 ALM DBND alarm deadband 4.9992 4.99219

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Generate, Download, and Upload F Section 10 153

10.3.6 Upload Information

Information about uploads appears in three different places:

J Task Monitor

J Upload log files

J Upload reports

10.3.6.1 Task Monitor

Figure 10-6 shows the Task Monitor with an UPLOAD job selected. The
right pane of the window shows each item uploaded.

Two messages that can appear are:

U2943: INFORMATION - Item updated in database

And

U3041: INFORMATION - Operator selected skip or quit,

item NOT updated in database

10

Using ENVOXr Server and Control Desktop (Original — May 2000)

 154 Section 10 F Generate, Download, and Upload

10

Figure 10-6. Task Monitor Showing Upload Status

10.3.6.2 Upload Logs

Upload logs show only items for which errors occurred during upload.
The error gives the reason for the failure. Figure 10-7 shows an example
Upload log.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Generate, Download, and Upload F Section 10 155

10

Figure 10-7. Example Upload Log

Upload jobs can access the log while an upload takes place. Logs
remain in the database until the next upload, at which time they are
replaced.

10.3.6.3 Upload Reports

Whether an upload was successful or failed, the software automatically

creates an upload report. The report displays the differences between
device and database DDP values for all the items in the upload. The
report documents those points affected by the upload.

You can view a report of the most recent (or currently processing) upload
through the Task Monitor. Figure 10-8 shows an example Upload Report.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 156 Section 10 F Generate, Download, and Upload

10

Figure 10-8. Example Upload Report

The columns in the Upload report are:

J Tag — The tag of the item you selected for this upload.

J Type — The item type.

J DDP — The DDP numbers. All DDP types have a unique number,
consistent for all device types.

J Occur — The DDP Occurrence number. Displays 0 (zero) if DDP

does not have any occurrences.

J Mnemonic — The mnemonic for the DDP. Each DDP type has a
unique mnemonic, consistent for all device types.

J Stored Value — The parameter value in the ENVOX database.

J Uploaded Value — The parameter value in the source device.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Generate, Download, and Upload F Section 10 157

10.3.7 Uploadable Points and Their DDPs

Table 10-2 lists the uploadable point types for the IACs; computing and
configurable controllers; UOC family of controllers; multiplexers; and
SR90 and SRx controllers.

Table 10-2. 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-3 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 example, 187, 1—31 indicates that DDP 187 has 31 possible 10
occurrence numbers, 1 through 31.

Table 10-3. Uploadable Detail Display Parameters

DDP
Number(1)(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

Using ENVOXr Server and Control Desktop (Original — May 2000)

 158 Section 10 F Generate, Download, and Upload

Table 10-3. Uploadable Detail Display Parameters (Continued)

DDP
Number(1)(2) Mnemonic and Name Devices(3)
9 REV ACT? CFG, IAC, UOC,
Reverse/direct control action CHIP
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
15 SP VL LM CFG, IAC, UOC
Setpoint velocity limit
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
10 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
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

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Generate, Download, and Upload F Section 10 159

Table 10-3. Uploadable Detail Display Parameters (Continued)

DDP
Number(1)(2) Mnemonic and Name Devices(3)
32 RST RAT IAC
Restart ratio
33 NTC LOBP IAC
Notch low breakpoint
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 10
Deviation high gain factor
44 VO LOBP IAC
Valve position low breakpoint
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

Using ENVOXr Server and Control Desktop (Original — May 2000)

 160 Section 10 F Generate, Download, and Upload

Table 10-3. Uploadable Detail Display Parameters (Continued)

DDP
Number(1)(2) Mnemonic and Name Devices(3)
55 DSC GF IAC
Discrete gain factor
56 DTC GAIN IAC
DTC process gain
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
10 66 FF SREV? IAC
Feedforward summer reverse/direct
70 FILT TIM IAC
First order digital filter time constant
71 INT GAIN IAC
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

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Generate, Download, and Upload F Section 10 161

Table 10-3. Uploadable Detail Display Parameters (Continued)

DDP
Number(1)(2) Mnemonic and Name Devices(3)
81 X2 COEF IAC
Polynomial coefficient x2
82 X1 COEF IAC
Polynomial coefficient x1
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 10
Ratio of setpoint
113 BHLO UOC
Alarm B high or low?
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
118 INTSP IAC, UOC
Internal setpoint
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

Using ENVOXr Server and Control Desktop (Original — May 2000)

 162 Section 10 F Generate, Download, and Upload

Table 10-3. Uploadable Detail Display Parameters (Continued)

DDP
Number(1)(2) Mnemonic and Name Devices(3)
127 TRANTIME UOC
Transition time
128 RTRYCNTR UOC
Retry counter
130 INVERT? UOC
Discrete invert
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
10 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
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

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Generate, Download, and Upload F Section 10 163

Table 10-3. Uploadable Detail Display Parameters (Continued)

DDP
Number(1)(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 The DDP Number 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
microPROVOXt automation system

10

Using ENVOXr Server and Control Desktop (Original — May 2000)

 164 Section 10 F Generate, Download, and Upload

Blank page.

10

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Using LCP Trace/Tune F Section 11 165

Figure 11-Table 11

11 11 Using LCP Trace/Tune

Use the LCP Trace/Tune module in Control Desktop software to debug
the control strategy of an LCP point. The LCP point’s functions sequence
tables are displayed in document windows complete with all necessary
debug information in context. In addition, the Tune Data window can be
used to monitor or change I/O signals, registers and attributes in the
controller’s process database.

This module replaces the ENVOXr LCP Trace/Tune utility.

LCP Trace/Tune can be started from Control Desktop or from Control

Designer.

11.1 LCP Trace/Tune Module Overview

The module contains many features for tracing and tuning control
strategies configured in Control Desktop or Control Designer.

11.1.1 LCP Trace/Tune Module Window 11

The LCP Trace/Tune window contains user interface elements that
enable you to trace and tune your control strategies. This window is
illustrated in Figure 11-1.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 166 Section 11 F Using LCP Trace/Tune

Menu Bar Toolbar Header Control Bar

11 Tune Data Window Status Bar Document Windows

Trace Point Summary Window

Figure 11-1. The LCP Trace/Tune Window

The LCP Trace/Tune window contains user interface elements as

follows:

11.1.1.1 Header Control Bar

The context of the LCP Trace/Tune session including the controller

Device , LCP Tag, LCP Mode selections are entered and displayed in
this docking window.

11.1.1.2 Main Menu

Menu options are enabled when the session is in a valid state. For
example, a device must be selected before options on the Debug and
Tune menus are enabled.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Using LCP Trace/Tune F Section 11 167

11.1.1.3 Toolbar

The toolbar is a dockable window containing frequently used commands.

To access a toolbar function, simply click once on the toolbar icon.

Depending on system settings, you can position the cursor over each
toolbar icon to display a tool tip that explains the to which function the
toolbar icon applies. You may hide the toolbar.

11.1.1.4 Document Windows

When an LCP Tag is selected in the Header Control, the right hand
area of the module window contains one or more document windows,
one for each FST used by the LCP. The step number, full instruction,
comment and the accumulator values SVA, SVD, SVI and SVP are
displayed in a standard list control.

Trace points and the current breakpoint are indicated with disk and arrow
symbols to the left of the step number.

When an FST instruction is selected in this window, a context menu

(right mouse) is available for frequently used commands.

From this window you can add tune data items from an FST instruction
and can set and clear trace points when you are tracing and testing.

11.1.1.5 Tune Data Window

You can view I/O signals, registers and attributes in the controller’s
11
process database using dialogs called from the Tune menu. If you need
to monitor or change data periodically, the change can be added to this
window.

When this window is selected, a context menu (right mouse) is available

for frequently used Tune data commands.

11.1.1.6 Trace Point Summary Window

This window is hidden by default. Use the View menu to enable it. A
summary of all the trace points you have set is displayed in this window.
Each trace point is identified by its FST tag and step number. An
abbreviated instruction mnemonic and the accumulator values SVA,
SVD, SVI and SVP are displayed in a standard list control.

When this window is selected, a context menu (right mouse) is available

for frequently used Trace Commands.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 168 Section 11 F Using LCP Trace/Tune

This window can be used to view and debug downloaded FSTs at times
when the configuration in the ENVOX database is not synchronized with
the downloaded FSTs.

11.1.1.7 Docking Windows

The Toolbar, Tune Data window and Trace Point Summary windows
are all dockable, which means that they can be floated into the center of
the document window area and repositioned. The Tune Data window
and Trace Point Summary window can be resized while they are
floating. All of these windows can be made visible or hidden using the
View menu.

11.1.1.8 Window Updates

By default the LCP Trace/Tune windows are updated continuously. If the
Tune Data window is empty, trace points are updated every four
seconds or so. The update rate slows as more information is added to
the Tune Data window. Use the View --> Snapshot menu to select the
Snapshot mode. This mode takes a snapshot of the displayed data from
the controller after each Step or Continue command.

11.1.2 LCP Trace/Tune Module Signal Processing

The LCP Trace/Tune module provides a window into the data inside the
controller Device that you select in the Header Control Bar and allows
11 you to do two things:

J Debug a control strategy by stepping through a function sequence

table (FST) of a LCP

J View, monitor and change I/O signals, registers and DDP or

Operating parameter attributes in the controller

Debugging usually combines the use of both these features. When you
have downloaded a valid configuration to a controller device, you can
start an LCP Trace/Tune session to debug the configuration.

LCP debug can be implemented with the LCP mode set to either
WINDOW or to BREAKPOINT in the Header Control. You can set trace
points and examine the results of the instruction execution in WINDOW
mode without affecting the FST executions. Alternatively, you can set the
LCP mode to BREAKPOINT: controller execution is suspended at the
next breakpoint when you select this mode. The Step command is used
to move execution from one step to the next. The Continue command is
used to move execution from one trace point to the next.

When the controller device is offline, process inputs and outputs can be
overridden as shown in Figure 11-2.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Using LCP Trace/Tune F Section 11 169

Process Inputs

Normal Input

Interrupt
Override Input

Trace Utility
FST

Calculated Output
Override Output

Interrupt
Normal Calculated
Output

Process Outputs
X00016:SW3151--0

Figure 11-2. The Trace Utility

Note ... Any change to a tune data item or the selection of

BREAKPOINT mode modifies information in the target controller
and the process that it controls. Make sure you have complied
with all relevant site procedures and fully understand the effect
of any proposed change before implementing it. 11

11.2 LCP Trace Modes

The LCP Trace Mode selection defines the current debug mode of the
LCP. You can trace any LCP tag, which is in the current controller device
as selected in the Header Control. To be valid, an LCP tag must be the
tag of an LCP in the controller and in the ENVOX database in which you
are working. The software displays the trace-point display for the LCP
you selected.

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 WINDOW — This mode allows setting trace points at multiple steps

in the controller LCP FSTs. In the WINDOW mode, the controller
does not stop at trace points. Instead, the module updates the

Using ENVOXr Server and Control Desktop (Original — May 2000)

 170 Section 11 F Using LCP Trace/Tune

accumulator values displayed on the window as the trace passes

each trace point.

J BREAKPOINT — This mode enables you to set trace points at

multiple steps in the controller FST and to single step the LCP. This
mode must not be used if the LCP/FST is in use (that is, online to the
plant), 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:

j The STEP is updated like a trace point, in single-step execution

j The LCP function at the trace point is executed, then LCP

execution stops

j The LCP trace status shows AT BREAKPOINT in the display

j The display line for the particular controller step is backlit

j The system updates accumulator values for the step

At a breakpoint, you may set the accumulator values. The Step

command allows execution to continue to the next breakpoint
whenever the LCP stops (AT BREAKPOINT or SINGLE STEP) in the
11 BREAKPOINT mode.

The first time the module traces an LCP after download, the LCP 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 to clear the FST breakpoints and
virtual I/O assignments.

11.3 LCP Trace

Once you have configured controllers and have written LCP FST
programs, you can test them. LCP Trace/Tune enables you to test the
different paths in an LCP FST program to make sure that the program
behaves the proper way.

The way you choose to use the LCP Trace/Tune software depends on
your specific circumstances and requirements. However, as a general
procedure, you are able to:

Step 1: Select the device and LCP tag in which you are interested.

Step 2: Change the Trace Mode.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Using LCP Trace/Tune F Section 11 171

Step 3: Decide which elements of the FST you want to examine in

detail.

Step 4: Set trace points and optionally view tune data.

Step 5: Run an LCP.

Step 6: Change the Trace Mode to Breakpoint to stop execution at

the first breakpoint set. You can look at the values of any tune
data items you set — they are changed by the program you
are tuning, although they may be changed by other point
processing elsewhere in the system.

Step 7: Override some tune data item values, such as I/O channels,
to force the program down a different path. This technique
lets you test all the possible paths the LCP FST program may
take.

With the Trace portion of the LCP Trace/Tune module, you can:

J Work with Trace Points

J Run and Stop LCPs

J Step through an FST

J Continue from Breakpoint

11.3.1 Trace Points

11
There are fundamental operations that you perform on Trace points so
that you can see what the FST is doing. You can:

J Set trace points

J Set a single trace point

J Clear specific trace points

J Clear a single trace point

J Restore all trace points for a Device

Trace points can be set or cleared while the LCP is in the WINDOWS or
BREAKPOINT modes. The online Trace/Tune help contains an
illustration of the interface windows and dialogs and detailed instructions
for carrying out these operations.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 172 Section 11 F Using LCP Trace/Tune

11.3.2 Run and Stop an LCP

You can run an LCP in any Trace mode and force the LCP to execute if it
is currently idle. Idle LCPs are those that are executed in a one-shot
fashion and depend on other LCPs for initiation and are newly
configured LCPs that are not scheduled. As well as idle LCPs, this option
can be used with caution for scheduled LCPs or those associated with
direct control inputs.

You can stop an LCP in any Trace mode and force the LCP execution to
cease. It is available for LCPs that are currently continuously executing,
though it can be used with caution for scheduled LCPs associated with
direct control inputs.

The system confirms whether the LCP was successfully run. You remain
in the Run LCP dialog, so that you can run another LCP, until you exit
the dialog.

11.3.3 Step through an FST

When the LCP Trace Status is at Breakpoint trace mode, you can step
through an FST as though a trace point were at every step. This causes
one FST step to be executed whether or not it is a trace point.

If a currently selected LCP is at breakpoint or single-step, the FST

execution resumes and 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 according to normal rules of FST operation.
11
If the LCP is on a slow scan it may take some time to reach this state.

11.3.4 Continue from Breakpoint

When a controller is in Breakpoint mode, execution stops each time FST
execution reaches a trace point.

Execution stops after the controller executes the step.

Continue from Breakpoint is only available when the LCP Trace Status is
at breakpoint. If the LCP is on a slow scan it may take some time to
reach this state.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Using LCP Trace/Tune F Section 11 173

11.3.5 Select a Different Device

While using LCP Trace/Tune you may decide to debug another controller
device’s LCPs. The module lets you select a different device from within
the Trace function through the following features:

J Drop down list selection of a different device.

J If you are actively tracing or tuning, option to return the device’s I/O
channels and LCPs to normal.

J With the default system settings and if you are currently in Window or
Breakpoint trace point mode, the option to restore the current LCP
and its I/O channel overrides to normal.

J Depending on a system option and whether there are any I/O

overrides owned by the current LCP, the option to restore the current
LCP I/O overrides. If you do not restore I/O overrides, then it is up to
you to manage subsequent clearing of overrides, either by channel
or by device.

For a detailed description of these procedures, see the online

Trace/Tune help file.

11.3.6 Change the LCP Tag

When you finish debugging one LCP in a device, you may choose to
debug another LCP. The module lets you select another LCP from within
the Trace function through the following features: 11
J Drop down list selection of a different LCP Tag.

J With default system settings, the option to restore the current LCP
and its channel overrides to normal, if you are currently in Window or
Breakpoint trace mode.

J Depending on a system option and whether there are any I/O

overrides owned by the current LCP, the option to restore the current
LCP I/O overrides. If you do not restore I/O overrides, then it is up to
you to manage subsequent clearing of overrides, either by channel
or by device.

For a detailed description of these procedures, see the online

Trace/Tune help file.

11.3.7 Change the Trace Mode

The LCP Trace/Tune module lets you choose the appropriate trace
mode that suits what you want to view and how you want to debug

Using ENVOXr Server and Control Desktop (Original — May 2000)

 174 Section 11 F Using LCP Trace/Tune

devices. The module lets you select another trace mode through the
following features:

J Drop down list selection of the new mode from among the three trace
modes, which are the following:

j Normal

j Window

j Breakpoint

J You can carry out tracing only in Window or Breakpoint trace modes.

When you change to Normal mode, be aware that:

J You must choose whether to restore the selected LCP to normal

J Any trace points are removed from the Trace Point Summary
window and document windows.

When you change to Window mode, be aware that:

J The FST goes to continuous execution (provided that the LCP Mode
is shown as RUNNING).

J The value of the accumulators at each trace point are monitored

periodically and displayed in both the FST listing document window
and the Trace Point Summary window.

11 J Any accumulator values added to the display during single-step

mode are cleared.

When you change to Breakpoint mode, be aware that:

J The value of the accumulators at each trace point are monitored

periodically and displayed in both the FST document window and the
Trace Point Summary window.

J There is a visual indication of the instruction that is the current trace

point.

J During single-step mode, the accumulator values of the current step

are displayed in the Trace Point Summary window.

11.3.8 Editing an LCP FST

FST document windows are read-only; therefore, you cannot change the
logic they contain. To change the FST logic, use the Logic Editor (as
described in Section 8 of this manual and in the Control Desktop online
help file). When you have saved the changes, you need to generate and

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Using LCP Trace/Tune F Section 11 175

download the item, and close and re-open the document window in LCP
Trace/Tune. Some values may be re-initialized after a download.

11.4 LCP Tune

You may want to tune data in the controller’s process database as part
of your general tracing and testing procedure for making sure that LCP
FSTs are functioning correctly. However, you may also want to carry out
commissioning or plant maintenance work, and consequently want to
study control data values. You can do this using the Tune Data window
in LCP Trace/Tune. See the Trace/Tune online help file for an illustration
of this window and detailed instructions on its use.

In general, LCP Tune provides these features:

J You can quickly add tune data items to the Tune Data window from
FST instructions in a document window and remove data items.

J You can view and tune various control data items:

j I/O channels

j Local and global registers

j Accumulators

j Point DDPs

j Operating parameters

J You can view and update the Displays

11
However, remember that any change to a tune data item modifies
information in the target controller and the process that it controls. You
should be sure that you have complied with all relevant site procedures
and fully understand the effect of any proposed change before
implementing it.

11.4.1 Add and Remove Tune Data Items

When tuning data items, you can add items (I/O channels, registers,
accumulators, point DDPs, and operating parameters) using the
standard procedures. However, you can add tune data items to the Tune
Data window from FST instructions in a document window if there is at
least one parameter containing an appropriate address/location context.
You can also remove tune data items as needed.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 176 Section 11 F Using LCP Trace/Tune

Using the Add Tune Item(s) option to add tune data items is not
available if the option Show Register Numbers was unchecked on the
LCP Trace/Tune Options dialog when the FST was opened:

The following information also pertains to the use of the Add Tune
Items(s) option to add tune data items:

J I/O channel tune items are created from instructions containing

addresses in the F-C-C format

J Local register tune Items are created from local register references in
any of the supported instruction. Save registers are ignored.

J Global registers are created from LDSVG and STSVG instructions

only

J DDP tune items are created from DDPRD and DDPWT instructions
only

J Operating parameters are created from DARD, DAWT, AIPROC

TIFMOD and IFTMOD instructions containing literal
’attribute[Occurrence]:tag’ strings

J Duplicate tune items are ignored. There can be only one occurrence
of each unique item. The data format is included in the uniqueness
test so it is possible to display a single integer register in any or all of
the supported formats.

J The item type and location information is checked before items are
11 added. If an error message is output, that tune item will not be
added. For example, 1-1-1:2 is a valid SMART address, but it is not
valid in the context of this feature.

J Unavailable attributes are modified to equivalent available attributes

as follows:

j AI and Loop PV are converted to AO and %PV

j Loop SP is converted to %SP

A complete list of the instructions that can be added as Tune Items is

contained in the online Trace/Tune help file and in subsection 11.6.

If you remove overridden I/O channels, the I/O overrides remain in effect
until you clear them manually.

11.4.2 Working with I/O Channels

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

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Using LCP Trace/Tune F Section 11 177

this way, you can specify I/O values and monitor their effects on LCP
operation. The Trace/Tune module lets you:

J View the normal values for I/O channels

J Add or remove I/O channels

J Set overrides for input and output channels

J Clear or change set overrides

Since I/O channels are tune data, you can add an I/O channel to the
tune data for periodic update. If it has already been added, you can
remove the channel from the display.

When you override a current override value for an I/O channel, an

asterisk is placed in the display to indicate an override condition on
inputs and output. Any message responses from the controller are
displayed on the dialog.

Any change to a tune data item modifies information in the target

controller and the process that it controls. Make sure you have complied
with all relevant site procedures and fully understand the effect of any
proposed change before implementing it.

11.4.2.1 Overriding an Input Channel

You enter the F-C-C number to select the channel you wish to view and
to override. When an entered value overrides an input channel or
pseudo I/O value, then an input function of any IFC or UOC+ point reads 11
the override value.

11.4.2.2 Overriding an Output Channel

You enter the F-C-C number to select the channel you wish to view and
to override. When an entered value overrides an output channel, the
computed output value of the channel remains in the display as Normal,
but the override value is output to the process.

11.4.3 Registers

The procedure you follow to view and edit registers is the same for local
and global registers. See the online Trace/Tune help file for an
illustration of this window and specific instructions for its use.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 178 Section 11 F Using LCP Trace/Tune

Local and global registers that can be viewed are the following:

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 Trace/Tune module accepts values in the ranges
shown:

j INTEGER: --32,768 through 32,767

j PERCENT: --128 through 127.996

j FILE—CARD—CHANNEL: file—card—channel format

j 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.

J GLOBAL BOOLEAN — allows you to examine or change any global

real register values. Accepts values of 0 or 1.
11
11.4.3.1 Address Ranges
J The address range for local registers is 0 — 31

J The address range for global registers is 1 — 32766

J Global registers are accessed as absolute address values

J The conversion from an LCP global relative register address to an

absolute global register address is given by the following formula:

absolute_address = (global_block--1)*32 -- relative_address

11.4.3.2 Add a Register

Through the Tune Data window, you can add registers for examination.
You may enter a number from 1 to 32 for the number of registers you
wish to add.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Using LCP Trace/Tune F Section 11 179

Error messages appear in the display and an E icon is placed in the

margin to indicate an error condition.

11.4.3.3 View and Tune a Register

Through the Tune Data window, you can view and tune local and global
registers. If the register you wish to see is not displayed, you can add the
register; if it appears in the display, you can remove it. If you remove
overridden I/O channels, the I/O overrides remain in effect until you clear
them manually.

The displayed value field contains the current register value. It is

available for you to change the value, if you want to. Any message
responses from the controller are displayed on the dialog.

If the register you wish to examine is shown in the Tune Data window,
you can change the current register value. The Tune Data window is
updated to show the changed value.

Note ... Any change to a tune data item modifies information in the
target controller and the process that it controls. Make sure you
have complied with all relevant site procedures and fully
understand the effect of any proposed change before
implementing it.

11
11.4.4 View and Tune the Accumulators
You can view and set the value of accumulators — SVA, SVD, SVI, SVP
(Analog, Digital, Integer, Percent Signal Values). Because an
accumulator is a type of local register, the procedure you follow is the
same as for standard local registers. 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.

Accumulators can be one of the following:

J SVA — the analog accumulator signal value (the floating-point

accumulator)

J SVP/SVI — the SVI is the integer accumulator signal value. The SVP
is the SVI in highway percent format (SVP = SVI divided by 256).

Using ENVOXr Server and Control Desktop (Original — May 2000)

 180 Section 11 F Using LCP Trace/Tune

The SVP/SVI accumulator signal value has these additional choices

in the ranges shown:

j INTEGER: --32,768 through 32,767

j PERCENT: --128 through 127.996

j FILE-CARD-CHANNEL: file-card-channel format

j hexadecimal: 2-byte hexadecimal format

J SVD — the discrete accumulator signal value (accepts values of

0 or 1)

11.4.5 View and Tune Point DDPs

You can view and set the state of a point’s Detail Display Parameters
(Point DDPs). The Tune function allows you to display and to change
DDPs on any IFC, UOC+, SR90, or SRx point.

If the point DDP has not been added to the Tune Data window, you can
add this point DDP for periodic update. If, however, it has already been
added, you can remove it from the Tune Data window.

The displayed value is the current point DDP value, which may be
changed. Any change to a tune data item modifies information in the
target controller and the process that it controls. Make sure you have
complied with all relevant site procedures and fully understand the effect
of any proposed change before implementing it.
11
You cannot change the setpoint of a DDP when in computer mode.

Any message responses from the controller are displayed on the dialog.

11.4.6 Monitoring I/O Channels

You can monitor the card types and current value of each input and
output channel of an I/O file.

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 indicates the
value of an overridden channel.

Input and output channels in the OVERRIDE mode are temporarily

suspended. Therefore, 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.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Using LCP Trace/Tune F Section 11 181

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.

11.4.7 View and Tune Operating Parameters

You can view and set the state of Point Operating Parameters.

If the operating parameter has not been added to the Tune Data
window, you can add this operating parameter for periodic update. If,
however, it has already been added, you can remove it from the Tune
Data window.

The Value field contains the current operating parameter value, which
may be changed.

Any message responses from the controller are displayed on the dialog.

11.4.8 Continuous Updates

The information in the LCP Trace/Tune windows is updated continuously
every three seconds, by default. However, depending on the number of
items being displayed and the loading of various elements in the system
— notably the PROVOXr highway and the controller — the update
interval may be considerably longer.

A bullet symbol next to the Continuous Updates option on the View

menu indicates continuous updates. If the bullet is not there but is
instead next to the Snapshot option, the automatic continuous updates
11
have been suspended. In this case, you can activate the automatic
continuous updates. You should see the bullet symbol next to the
Continuous Updates option; it is removed from the Snapshot option.

11.4.9 Suspend Automatic Updates (the Snapshot Mode)

The information in the LCP Trace/Tune windows is updated continuously
every three seconds, by default and the bullet symbol appears next to
the Continuous Updates option on the View menu.

For the debugging work you are carrying out, you want to suspend all
updates so that the data remains as it stands until you specifically elect
to update it. In other words, you want to change from continuous mode
to snapshot mode.

11.4.10 Manually Refresh the Display

You may want to make sure that the display reflects the latest live data.
For example, you want to determine if automatic continuous updates

Using ENVOXr Server and Control Desktop (Original — May 2000)

 182 Section 11 F Using LCP Trace/Tune

have been suspended and LCP Trace/Tune is therefore in Snapshot

mode.

The value fields of the items in the Tune Data window (and other
windows) are updated. If an error occurs during the update, the field
shows the value #Error.

Specific instructions and a detailed view of the Tune Data window can
be found in the online Trace/Tune help file.

11.5 User Preferences

The Tools menu contains options that you can use to switch to other
applications and to define some general preferences for LCP
Trace/Tune:

J Control Desktop — switches to Control Desktop so that you can use

its facilities such as the Logic Editor.

J Function Block Editor — Switches to the Function Block Editor within

Control Designer.

J Options — Displays the LCP Trace/Tune Options dialog, where you

can change the preference settings for LCP Trace/Tune’s
appearance and usability.

11.5.1 Options Dialog

11 The LCP Trace/Tune Options dialog contains standard parameters you

can alter to affect the appearance and basic way you use LCP
Trace/Tune. See the Trace/Tune online help file for an illustration of this
dialog and detailed instructions for its use.

The parameters that are displayed and which may be changed or

selected are the following:

Significant Figures

The Real Values and Percentage Values fields define the number of
figures shown in LCP Trace/Tune. The default settings are the following:

J Real values: 6

J Percentage values: 6

The valid range is 3 to 6 for both fields.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Using LCP Trace/Tune F Section 11 183

Update Interval in seconds

This field defines the fastest frequency of the automatic update. The
actual update frequency depends on the number of tune items. The
default setting is 3 seconds. The valid range is 3 to 60 seconds.

Options

The list of options area on the dialog contains check boxes which you
click to turn on or to turn off. A blank check box means the option is
disabled.

J Close FST Documents on change of LCP — this setting is the

default and displays with a check mark in the check box. This action
takes place when you have made a change in the LCP Tag field.
Click to remove the check mark and to leave the FST document
windows open.

J Close FST Documents on Instruction Mis-match — by default, the

system closes an FST window when it detects an instruction
mismatch. Click to remove the check mark and to leave the FST
document windows open when an instruction mis-match has been
detected.

J Show Registers Numbers e.g. F21 [Yes] or Reg. Names [No] —

by default, the register numbers are shown. You can choose to
display the names of registers instead of the numbers, but you may
lose direct correlation between the register number and any tune
values you have set up and you cannot use the Add Tune Item(s)
option. 11
J Separate prompts for Restore LCP and Restore I/O — the default
is to have a single prompt for both Restore LCP and Restore I/O
operations. Separate prompts enable you to restore the LCP to
Normal while leaving the I/O overrides that you have defined.

J Automatic resizing of docked control bars with mainframe — the

default is to resize automatically the Tune Data and Trace Point
Summary docking windows when you change the size of the LCP
Trace/Tune window. Uncheck the box to leave the docking windows
at their current size when you change the LCP Trace/Tune window.

J List DDPs as Console Mnemonic [Yes] or UOC Mnemonic [No] —

the default is to list DDPs as Console Mnemonics. Uncheck this box
if you want to show those DDPs that are also attributes using the
UOC attributes mnemonic.

11.5.2 Registry Settings

On some sites, it may be preferable to change the settings of more
parameters than are available in the LCP Trace/Tune Options dialog.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 184 Section 11 F Using LCP Trace/Tune

These additional advanced features are available by changing system

registry settings.

Caution ... Change registry settings with great care. Accidental or incorrect
changes can cause system problems.

You can do the following:

J Change the number of registers that can be added in a single Add

command within LCP Trace/Tune. For example, you can make the
error checking stricter by lowering this number. The default setting is
32. To change this to any number in the range 1 to 32, add the
system registry setting RegistersPerCheck in the registry path
HKEY_CURRENT_USER\Software\FRSI\Control
Desktop\5.0\LcpTraceTune\Options and give it the
appropriate number.

J Change the frequency of address checks during an I/O Channel Add

command within LCP Trace/Tune. For example, you may want to
invoke more or less strict error checking during this process.

J Up to 16 I/O Channels can be added for each Add command. By

default, an address check is performed on the initial and the 9th
channels. Occasionally, you may inadvertently request information
from channels that do not exist. After the next update, they will be
shown with a red E symbol and the Error field will indicate that the
11 address is invalid. This approach is usually preferable to viewing
each channel before it is added because individual viewing reduces
performance.

To change the error checking frequency, add the system registry

setting IoChnlsPerCheck in the registry path
HKEY_CURRENT_USER\Software\FRSI\Control
Desktop\5.0\LcpTraceTune\Options and give it an
appropriate number:

1 checks every channel

4 checks the 1st, 5th, 9th and 13th

8 checks the 1st, 9th and 16th

16 disables checking

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Using LCP Trace/Tune F Section 11 185

11.6 Instructions with Parameters That Can Be Added as

Tune Items
Below is a complete list of instructions showing which instructions are
and are not added, and which items are created when you use the Add
Tune Item(s) option. All registers are local registers unless it states
global register.

Table 11-1. Instructions That Can Be Added As Tune Items

Instruction Description Add? Par ID Items Created
ABS Absolute Value No No Suitable Parameters
ADD Add Yes 1 Register Reference
ADDP Add Percent Yes 1 Register Reference
AIN Analog Input Yes 1 Input Location I/O Channel Or
Reg
AIPROC AI Point Processing Yes 1 AI Point -- %PV Op Parameter
AND Logical AND Yes 1 Register Reference In Hex
AOUT Analog Output Yes 2 Output Location I/O Channel Or
Reg
ASR Arithmetic Shift Right Yes 1 Number Of Places As Register
BDET Bi--directional Edge Trigger Yes 1 Trigger Signal Register
BRA Branch Yes 2 Comparison Value As Register
BRAL Branch Literal No No Suitable Parameters
BRAP Branch Percent Yes 2 Comparison Value As Register
CALL Call A Subroutine No No Suitable Parameters
11
CHGBT Change Bit Yes 1 Bit Position As Register In Hex
COS Cosine Of Accumulator No No Parameters
COUNT Count Function Yes 1,2 Count, Limit As Registers
CVRT Convert No No Parameters
DARD Data Access Read Yes 2 Literal Op Parameter Attributes
Only
DAWT Data Access Write Yes 2 Literal Op Parameter Attributes
Only
DDPRD Read DDP Yes 2 DDP
DDPWT Write DDP Yes 2 DDP
DEVSTAT Device Status Yes 1, 3 Channel Location, Bit/Status
Register
DIN Discrete Input Yes 1 Input Location I/O Channel Or
Reg
DIRG Discrete Input Register Yes 1 Input Location Register Only
DIV Divide Yes 1 Register Reference As Register
DIVP Divide Percent Yes 1 Register Reference As Register
DLR Download Restart Detector No No Parameters

Using ENVOXr Server and Control Desktop (Original — May 2000)

 186 Section 11 F Using LCP Trace/Tune

Table 11-1. Instructions That Can Be Added As Tune Items (Continued)

Instruction Description Add? Par ID Items Created
DLS Download Startup Detector No No Parameters
DORG Discrete Output Register Yes 1 Output Location As Register
DOUT Discrete Output Yes 2 Output Location I/O Channel Or
Reg
DT Dead Time Yes 1,2 Reset, Deadtime As Register
DTIME Dead Time Yes 1 Reset As Register
END End Of FST No No Parameters
EUP Engineering Units To No No Suitable Parameters
Percent
EXP Exponent To Power Of E No No Parameters
EXPR Expression No No Suitable Parameters
FFR Flip Flop Reset Yes 1 Reset Register
FFS Flip Flop Set Yes 1 Reset Register
FIL Filter Yes 1,2 Reset, Time Constant Registers
HLV Hold Last Value Yes 1 Boolean Switch Registers
HSM High Select Monitor Yes 1 Reference Value As Register
IFTMOD If True Set Mode Yes 1, 3 Register Ref, Mode Op
Parameter
INT Integrator Yes 1,2,3 Reset, Output, Final Value As
Regs
IOSTAT I/O Status Yes 1,2 Channel Location, Destination
Regs
LABEL No No Suitable Parameters
11 LDBT Load Bit Yes 1 Bit Position As Register In Hex
LDIND Load Indirect Yes 3 Register Reference
LDSV Load Signal Value Yes 1 Value As Register
LDSVG Load Signal Value Global Yes 1 Global Register Reference
LDSVP Load Signal Value Percent Yes 1 Value As Register
LIMIT Limit Check Yes 1,2,3 Upper, Lower, Indicator As Regs
LIMITP Limit Check Percent Yes 1,2,3 Upper, Lower, Indicator As Regs
LL Lead/Lag Compensation Yes 1,2,3,4 Gain, Lead Time, Lag Time,
Reset As Regs
LN Log To Base E Of No No Parameters
Accumulator
LSM Low Signal Monitor Yes 1 Reference Value As Register
MUL Multiply Yes 1 Register Reference
MULP Multiply Percent Yes 1 Register Reference
NDET Negative--direction Edge Yes 1 Trigger Signal Value Register
Trigger
NOP No Operation No No Parameters

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Using LCP Trace/Tune F Section 11 187

Table 11-1. Instructions That Can Be Added As Tune Items (Continued)

Instruction Description Add? Par ID Items Created
NOT Boolean Not Of No No Parameters
Accumulator
OPER Operation Initiation No --
OR Logical OR Yes 1 Register Reference In Hex
PDET Positive--direction Edge Yes 1 Trigger Signal Value Register
Trigger
PEU Percent To Engineering No No Suitable Parameters
Units
PFR Power Fail Restart Detector No No Parameters
PPA Plant Process Area Alarm No --
RDALRM Read Alarm Register Yes 1 Destination Register In Hex
RDFAIL LCP Read Fail Index Yes 1 Destination Register
RDMASK Read Status Mask Register Yes 1 Destination Register In Hex
RDSTAT Read Status Register Yes 1 Destination Register In Hex
RESUME Resume At Label No No Suitable Parameters
RGCHF Register Change Flag No No Suitable Parameters
RGMV Register Move No --
ROTL Rotate Left Yes 1 Number Of Places As Register
ROTR Rotate Right Yes 1 Number Of Places As Register
SCHED Schedule A CHIP Function No --
SGSL Signal Selector Yes 2,3,4 Input 1, 2, 3 Registers
SHL Logical Shift Left Yes 1 Number Of Places As Register
SHR Logical Shift Right Yes 1 Number Of Places As Register 11
SIN Sine Of Accumulator No No Parameters
SMIN SMART Inputs No No Suitable Parameters
SMOUT SMART Outputs No No Suitable Parameters
SQRT Square Root Of No No Parameters
Accumulator
STBT Store Bit Yes 1 Bit Position As Register
STIND Store Indirect Yes 3 Register Reference
STSV Store Signal Value Yes 1 Value As Register
STSVG Store Signal Value Global Yes 1 Global Register Reference
SUB Subtract Yes 1 Register Reference
SUBP Subtract Percent Yes 1 Register Reference
SWR Switchover Restart No No Parameters
TFR Signal Transfer Yes 1,2 Boolean Reg, Transfer Signal As
Regs
TIFMOD True If Mode Matches Yes 2 Point Tag’s Mode Op Parameter
TIMER Timer Yes 1,2,3 Reset, Output, Final Value Regs
VLIM Velocity Limit Yes 1,2 Reset, Limit Velocity Registers

Using ENVOXr Server and Control Desktop (Original — May 2000)

 188 Section 11 F Using LCP Trace/Tune

Table 11-1. Instructions That Can Be Added As Tune Items (Continued)

Instruction Description Add? Par ID Items Created
WAIT Wait Yes 1 Time as Register
WRALRM Write Alarm Register Yes 1 Source Register in Hex
WRMASK Write Status Mask Register Yes 1 Source Register in Hex
WRSTAT Write Status Register Yes 1 Source Register in Hex
XOR Exclusive OR (XOR) Yes 1 Register Reference

11

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Report Writer F Section 12 189

Figure 12-Table 12

12 12 Report Writer
Report Writer is an integrated application that lets you create,
manipulate, view, and print reports for certain Control Desktop
information.

There are two types of reports:

J Standard Reports, which are built in and have a fixed format report

J Custom Reports, which are generated from an SQL query you create

Though you use the Report Writer to create both types of reports the
menus, menu options, and dialogs you use to create and manipulate the
reports are different. When you switch between the two types of reports,
the interface changes. If you have reports of both types open, the menus
change when you move from report to report

12.1 Standard Reports

To create standard report, open Report Writer from the Control Desktop
top level menu by selecting View –> Report Writer. Report Writer opens
the Select Report dialog from which you can select one of the
built-standard reports to work with as shown in Figure 12-1. 12
If Report Writer is already open but the Select Report dialog is not open,
select File --> Open from the Report Writer main menu. Note that if the
custom report interface is open you must close it before the File -->
Open selection appears on the menu.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 190 Section 12 F Report Writer

Figure 12-1. Select Report Dialog

The default list shows every standard report available. You can use the
radio buttons at the bottom of the dialog to limit the type of reports
shown. If you have previously saved a report as a *.PSR (previously
saved report) file, you can open it by clicking Saved PSR Files, then
navigating to the saved report you want to open.

After you create a standard report, you can work with it to change its
appearance, save it, and print it.
12
The online help system contains complete instructions for using the
menu options and dialog boxes to create standard reports. Refer to
Section 3 for instructions on accessing the online help for the Report
Writer module.

12.2 Custom Reports

When you create a custom report, you query the database by setting up
SQL queries. Therefore, it is recommended that you only create a
custom report if you are familiar with Transact SQL and database
structures. If you are not familiar with these, you will not be able to create
useful custom reports.

To create a custom report, begin by selecting Edit --> Custom Reports

from the Report Writer main menu. The Report Writer menus change, the
Custom Reports Query Builder window and the Select Tables dialog
open. From this dialog you can access any table in the database. Select

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Report Writer F Section 12 191

the tables you want to work with and put them in the Query Builder
window..

Use Query Builder SQL functions, such as joins, to collect and arrange
information in non-standard ways.

Caution ... Remember that you are using an open SQL interface on the
ENVOXr database. Fisher-Rosemount Systems recommends
that you only create a custom report if you are familiar with
Transact SQL and database structures.

At this point, you may select the following options from the top-level
menu or the icons in the Toolbar to further refine your query for the
custom report:

J File --> New — displays the Select Tables dialog window from which
you select the table data to be used in the query. When you select a
table or tables, Query Builder displays the information available in an
information window.

J File --> Open Query — opens the Open Query dialog window that
lets you locate Query files previously saved as *.QRY file type.

J File --> Run — executes the query to create the desired report

J Edit --> Edit Joins — lets you change join conditions before you
execute the query

Objects --> Select Tables — opens the Select Tables dialog

12
J
window that lets you select the table data to be used in the query.
When you select a table or tables, Query Builder displays the
information available for the selections in an information window.

J Objects --> Display Columns — highlights the table entries that will
be used as the columns for your report output.

J Objects --> Joins — specifies conditions upon which the report data
is selected

J Objects --> Where Clause — specifies search conditions to apply to

the SQL query

J Options --> Distinct — restrict joint to one-to-one relationships

Using ENVOXr Server and Control Desktop (Original — May 2000)

 192 Section 12 F Report Writer

J Options --> View/Edit SQL — directly edit the SQL query in the
Query Builder (changes you make are not applied to the graphical
version of the query in the Query Builder window)

J Options --> Arrange Tables — moves the tables in the Query

Builder window, if necessary, to prevent them from overlapping

The online help system contains instructions for using the menu options
and dialogs to create custom reports.

12.3 Working with Reports

When you have created a report, either standard or custom, you can do
the following:

J Save the report.

J Change the report’s appearance.

J Print the report.

J Close the report.

J Save set of tags from a report.

12.3.1 Change the Appearance of a Report

You can change how the information is displayed in a standard or

custom report after Report Writer has displayed the report in a report
window. You can change the appearance in the following ways:

12 J Turn gridlines on and off and manipulate columns

Turn gridlines on and off using the Grid field in the Report header.
The gridlines appear on screen and when you print the report.

With the gridlines on, you can use the grid to size and move
columns. To size a column, move the cursor to a vertical grid line.
When the cursor changes, press the left mouse button and drag.

To move a column, move the cursor to a column heading, press and

hold the left mouse button. A vertical border of the column changes
to a heavy gray line. Drag the cursor and the line moves from border
to border. Release the mouse button and the selected column
moves.

J Change font size and report heading

To change the size of the font used in the report and the text printed
in the report heading, select Edit --> Report Options. Use the
Change Report Detail Font spin button to change the font size.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Report Writer F Section 12 193

Enter the heading you want to appear in the Title field. Select the
Date-Time check box to have the current time and date appear in the
report heading.

J Change the report size

Use the Zoom spin button in the Report window to shrink or expand
the report. Zooming affects the appearance of the report both on
screen and when printed.

Note ... If the headings or values in a report are missing or incomplete,

turn the Grid ON and adjust the font size until all of the
information is readable.

12.3.2 Save Tags to a Tag Set

You can save the tags into a tag set, for example, to retrieve the list of
tags as part of your selection criteria when producing a report within
Report Writer.

In particular, you may want to use this option so that you don’t have to
create a complex SQL query, with many joins, in order to produce a
custom report containing all the tags in the list. Instead, you can build up
a tag set from the result of several custom reports and then use that tag
set as part of your selection criteria for a new report.

You can choose to create a new tag set, containing the tags in the report
or the SQL used to create it. Alternatively, you can update an existing 12
tag set with this information.

If the tag set name exists already, then you are prompted to choose to
either overwrite or append the tags to the existing tags set, if the two tag
set types are compatible.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 194 Section 12 F Report Writer

Blank page.

12

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Task Monitor F Section 13 195

Figure 13-Table 13

13 13 Task Monitor
The Task Monitor is a standalone application you can use to examine the
status of jobs currently in the job queue. Task Monitor can be accessed
from within Control Desktop, from within Control Designer, or from the
Windows Start menu.

The types of jobs you can examine are:

J Generate — Information about jobs that create downloads from

configuration data in the database.

J Download — Information about download jobs to devices.

J Translate — Information about jobs that translate Control Designer

data to ENVOXr format in the database.

J Upload — Information about upload jobs that read tuned

configuration data from devices into the database.

J Rename — Information about Rename jobs that rename an item in

the database.

J Export — Information about jobs that export configuration data to

CDV files.

J Import — Information about jobs that import configuration data from 13

CDV files.

In addition, from Task Monitor you can:

J Generate and Download configuration information.

J Display job status by tag item or by job for all job types.

J Filter the job list to either show all jobs or only completed jobs.

J View and print reports for jobs arranged in a variety of ways.

13.1 Opening Task Monitor

From within Control Desktop, select View --> Task Monitor from the
top-level menu. The Task Monitor window appears as shown in
Figure 13-1.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 196 Section 13 F Task Monitor

Figure 13-1. Task Monitor Window

The initial state of the Task Monitor is to show all Generate jobs in a job
list view as shown in the figure. Using menu and pull-down selections
you can show other types of jobs, show jobs by item tag, or show only
completed jobs.

13.2 Task Monitor Functions

The Task Monitor window contains four icons that perform the following
tasks:
13 J Display a Job’s Log file

J Print the current window

J Display the Reports window

J Exit Task Monitor

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Task Monitor F Section 13 197

Task Monitor also contains options in its top-level menu that provide you
with the following selection capabilities:

J File — provides print options as well as the Exit from Task Monitor

J Job — selects the actions that specify the function you want
displayed:

j Select a Report

j Display the current Log File

j Find or search for a particular item by tag

j Generate any of the jobs displayed in Task Monitor (if Job Type is
set to GENERATE or DOWNLOAD)

j Download any of the jobs displayed in Task Monitor (if Job Type
is set to GENERATE or DOWNLOAD)

j Abort a job

J View — Set the view to by job or by tag

J Admin — Provides access to administration functions:

j Login — Log in to a database, if you are not already logged in.

j Disconnect — Sever connection to the current database.

j Set Client Task Daemon — Specify on which machine you want

the client task daemon to run.

Note ... The Client Task Daemon is responsible for running tasks such
as Verify/Generate, Rename, ASCII FST Import, PDX, Import 13
and Export. The Client Task Daemon is installed on the client
workstation when you install Control Desktop.

Change the default from the client workstation only in unusual

circumstances and after much thought.

Running the daemon on the client machine is the default and is

usually acceptable. However, under unusual circumstances there
may be reasons to run it on another machine. For example, if the
client workstation is a low-performance machine and the server has
much higher performance, there may be an advantage to running the
Client Task Daemon on the server.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 198 Section 13 F Task Monitor

The daemon can be run on any machine (it doesn’t have to be a

server or client) but the machine you specify must be in the same
domain as the client and server.

Devices visible from Task Monitor can be resubmitted for Generation or

Download by selecting a device in any view of the Task Monitor in the
right-hand pane or a job in the left-hand pane and choosing the
Generate or Download option from the Job option in the top-level
menu. Only Generate and Download jobs can be resubmitted from the
Task Monitor.

The online help system contains instructions for using the Task Monitor
functions. Refer to Section 3 for instructions on accessing the online help
for the Task Monitor utility.

13.3 Connect to a Different Server or Database

You can connect to a different server or database from within the Task
Monitor. When you connect to a different server with Task Monitor, it
does not affect the server you are connected to from Control Desktop.
This means that you can use Task Monitor to monitor the jobs taking
place on one server while using Control Desktop to work on a different
server.

13.4 Creating Reports

Task Monitor produces two types of reports:

J Log File

J Reports

The online help system contains instructions for generating reports within
13 Task Monitor.

13.5 Displaying Information

While using Task Monitor, you can choose whether to display information
as a list of jobs or by tags.

13.5.1 Displaying Information by Jobs

In the Job List view, Task Monitor displays information in two panes. The
left-hand pane shows the job number, the name of the user than ran the
job and the status of the job. If the job is currently in progress, the status
changes according to the stage the job has reached, for example,
Creating, Executing or Completed.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Task Monitor F Section 13 199

The right-hand pane shows more detailed information about that job,
relating to the tags in the job.

When you are using Task Monitor in the Job List view, you can do the
following:

J Show information about any type of job.

J Order the information in either pane by clicking on a column heading.

J Print the information shown on the screen.

J Search for a specific tag

J Rerun a job, if it is a Generate or Download job.

J Display a report for the job

J Display the log file for a job

13.5.2 Displaying Information by Tags

In the Tag List view, Task Monitor displays the tag, the last time a job
was run on that tag, any warnings and errors and the status.

When you are using Task Monitor in the Tag List view, you can do the
following:

J Show information about tags in any job.

J Order the information by clicking on a column heading.

J Print the information shown on the screen.

Search for a specific tag.

13
J

J Rerun a job, if it is a Generate or Download job.

J Display a report for a tag.

J Display the log file for a job

Using ENVOXr Server and Control Desktop (Original — May 2000)

 200 Section 13 F Task Monitor

Note ... In the Tag List view the status value of devices that are
currently being generated are displayed as Fatal Error. Similarly,
devices being downloaded display Download Failing in the
status column. These are transitional state set at the start of the
generate and that is updated to the correct value when the
generate completes. To see the true current status of generate
or download jobs, open the Job List view.

13.5.3 Displaying Download Information

If you are using the Job List view, Task Monitor displays the following
information about Download jobs:
In the left-hand pane: In the right-hand pane:
the job number. list of device tags within the job selected in
the left-hand pane.
the name of the user who ran the job. the type of download .
status of the job. the time the tags were last downloaded.
the download status of the tag.
the number of packets used in the
download
You can restrict the number of jobs that appear by filtering the jobs. To
filter the jobs, from the Job Filter drop-down list, select All Jobs or
Completed Jobs. Note that jobs that were completed in the current
session are shown in blue text in the left-hand pane.

If you are using the Tag List view, Task Monitor displays the following
information:
13
J the name of the device tag.

J the time this tag was last downloaded.

J the current status of the tag.

In the Tag List view, the Job Filter option is not available.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Task Monitor F Section 13 201

13.5.4 Displaying Generate Information

If you are using the Job List view, Task Monitor displays the following
information for Generate jobs:

In the left-hand pane: In the right-hand pane:

the job number list of device tags within the job selected in
the left-hand pane
the name of the user who ran the job the time that tags were last generated
status of the job the number of any warnings and errors
that resulted from generating those tags
the generation status of the tag

You can restrict the number of jobs that appear by filtering the jobs. To
filter the jobs, from the Job Filter drop-down list, select All Jobs or
Completed Jobs.

If you are using the Tag List view, Task Monitor displays the following
information:

J the name of the device tag

J the time this tag was last generated

J the number of any warnings or errors that resulted when the tag was
generated

J the current status of the tag

In the Tag List view, the Job Filter option is not available.

13.5.5 Displaying Translate Information

13
To display information about Translate jobs in either the Job List or Tag
List view, from the Job Type drop-down list, select TRANSLATE.

If you are using the Job List view, Task Monitor displays the following
information about Translate jobs:

In the left-hand pane: In the right-hand pane:

the job number. list of device tags name within the job
selected from the left-hand pane.
the name of the user who ran the job. the time the tags were last translated.
status of the job. the number of any warnings and errors
that resulted from the translation of the
tags.
the translation status of the tag.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 202 Section 13 F Task Monitor

You can restrict the number of jobs that appear by filtering the jobs. To
filter the jobs, from the Job Filter drop-down list, select All Jobs or
Completed Jobs.

When you display Translate jobs in the Job List view, the Generate and
Download options on the Job menu are no longer available.

If you are using the Tag List view, Task Monitor displays the following
information:

J the name of the device tag.

J the time this tag was last translated.

J the number of any warnings or errors that resulted when the tag was
translated.

J the current status of the tag.

In the Tag List view, the Job Filter option is not available and the only
options available on the Job menu are Report, Find Item, and Abort.

13.5.6 Displaying Other Job Type Information

The task monitor displays similar information for other job types.

13.6 Generating a Device

You can use Task Monitor to generate a device. You might want to do
this if the original generate failed but you are already using Control
Desktop for another job. When you generate a device, all the database
information for that device is collated and verified, ready to be
downloaded to that device. You can generate devices from either the
13 Job List or the Tag List view.

You can also generate a device while displaying Download jobs.

13.7 Downloading a Device

You can use Task Monitor to download database information to a device.
You might want to do this if the original download failed but you are
already using Control Desktop for another job, or if you have generated
a device from Task Monitor. You can download information to devices
from either the Job List or the Tag List view.

You can also download a device while displaying Generate jobs.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Task Monitor F Section 13 203

13.8 Aborting a Job

You can abort the job selected in the job pane. Either select Job -->
Abort or select Abort from the context menu. Note that the Abort occurs
after the current item has been processed.

13.9 Produce a Job Report

You can produce report giving more details about some job types. You
can produce the following report types from either the Job List view or
the Tag List view:

J Generate Report.

J Download Report.

J Translate Report.

J Upload Report

You can also produce a report by double-clicking the column headings or

items in the right-hand pane. Note that Rename, Export, and Import jobs
do not have reports associated with them and therefore the Job -->
Report option is disabled for these types.

For these jobs the details pane does not contain job details but contains
a statement saying to view the log file for more information.

You can save the tags in a Generate, Download, Upload, or Translate

report to a tag set.

Figure 13-2 shows an example Generate report.

13

Using ENVOXr Server and Control Desktop (Original — May 2000)

 204 Section 13 F Task Monitor

Figure 13-2. Generate Report

13

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Utilities F Section 14 205

Figure 14-Table 14

14 14 Utilities
ENVOXr Server and Control Desktop provide utilities that enable you to
perform several important tasks to maintain your data after you have
configured, generated, and downloaded your system. Included in these
utilities are the following:

J Highway Reference List

J Audit Trail Reports

J Export and Import

J Upgrade Devices

14.1 Highway Reference List/Highway Access Control List

The Highway Reference List (HRL)—also known as the Highway Access
Control List (HACL)—contains numbers assigned to points as unique
identifiers. A console uses the Highway Reference List to transfer point
information to other consoles. A console-resident point in a primary
console of a redundant pair uses the numbers to communicate to the
correct backup point in the secondary console.

Highway Reference List numbers are also used to access console point
information from Computer Highway Interface Package (CHIP) programs
using the Highway Reference List number as the point number in the
CHIP request.
14

Using ENVOXr Server and Control Desktop (Original — May 2000)

 206 Section 14 F Utilities

Note ... The Highway Reference List (HRL) has also been called the
Highway Access Control List (HACL), the highway access list,
and the highway control list in other PROVOXr documents,
particularly those relating to the PROVUEr console. Both terms
Highway Reference List and Highway Access Control List
appear in Control Desktop.

To emphasize that these terms are interchangeable, this

subsection uses the pair of acronyms HRL/HACL when
referring to the list.

The control system uses Highway Reference List (HRL/HACL) numbers

to route (or translate) highway requests to internal database references.
The HRL/HACL number allows you to have different configurations in the
primary and secondary console of a redundant pair.

Highway Reference List (HRL/HACL) number for console-resident points

must match between redundant partners. However, the internal database
indices may differ in each console. All access to this information is
translated by the Highway Reference List (HRL/HACL) number.

Console-resident points and UNIT points are assigned HRL/HACL

numbers by Control Desktop when you configure them. You can change
the assigned number from a point’s Item Detail window or from the
Matrix View. Other point types are not automatically assigned HRL/HACL
numbers during configuration, but you can assign them numbers in two
different ways:

J From the Highway Ref No field in the point’s Item Detail window

J Using the Populate Highway Access Control List dialog (see

subsection 14.1.2)
14 The range of valid HRL/HACL numbers is 1 through 22767.

If you do not assign Highway Reference List numbers to points that are
not console-resident, when the console is generated and downloaded a
reference number local to the console is assigned to the point. This local
reference number is not a Highway Reference List number and the
number is not added to the Highway Reference List. This local reference
number may change on subsequent downloads.

The Highway Reference List (HRL/HACL) number is global throughout a

complete system if the point appears in the list. For points that are not
console-resident, it is a good idea to assign them Highway Reference
List numbers if you intend for the Highway Reference List (HRL/HACL)

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Utilities F Section 14 207

number to remain fixed, especially if you are using CHIP programs with
hard-coded HRL/HACL numbers.

If you use activities in a redundant pair you must put unit points in the
Highway Reference List (HRL/HACL).

If you delete a point, then add it, the Highway Reference List number
control desktop assigns to it may change. If you then do a partial
download to every device that uses the old reference number, (including
pairs of redundant consoles), different devices may end up with similar
points that have different Highway Reference List numbers. Assigning
your own Highway Reference List (HRL/HACL) number prevents
unwanted duplication and associated problems.

The Highway Reference List contains all of the points for which a
Highway Reference List number (HRL/HACL) has been assigned. To
view the Highway Reference List, select View --> Highway Reference
List. Figure 14-1 shows an example list.

14

Figure 14-1. Highway Reference List Dialog

Using ENVOXr Server and Control Desktop (Original — May 2000)

 208 Section 14 F Utilities

You can perform the following tasks from the Highway Reference List
dialog:

J Increase the maximum list size — that is, increase the number of
permitted highway reference numbers. You do not have to view the
entire list to be able to do this.

J View the entire list of point tags and their highway reference
numbers.

J Scroll up and down the list.

J Sort the list by clicking on the column headings.

J Search for a specific tag or reference number.

J Copy the list information and paste it into other applications.

J Print the entire list

If the Highway Reference List does not contain any data when you open
it, select Data --> Retrieve Data from Control Desktop when the
Highway Reference List dialog has focus. Retrieving the list may take
some time for a large database.

The entire list of highway reference numbers and the point tags to which
they are assigned is displayed. This list is read-only, except that you can
increase the number of permitted highway reference numbers.
Figure 14-1 shows a filled Highway Reference List dialog.

Use this dialog to scroll through the point tags to reach the desired point.
You can also sort the list of points through the Point Tag heading or the
Reference No. heading. You can also change the maximum number
through the Maximum List Size field.

When you make a change and close the list, you should save the
change when you are prompted.
14
14.1.1 Search the Highway Reference List
You can search the Highway Reference List to locate a point tag or a
reference number. For a detailed description of this procedure, see the
Control Desktop online help file. Figure 14-2 shows the dialog that lets
you specify the criteria for your search. The criteria are the following:

J Find where — search for either a Point Tag or a Reference Number

J Find what — search with some or all of the characters of either the
point tag or highway reference number

J Search — search either Down or Up the list

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Utilities F Section 14 209

J Match Case — find text that exactly matches the case of the entry in
the Find what field

J Find Next — highlight in the Highway Reference List dialog the first
item found that matches the search criteria

You can also copy the information with a standard highlight and copy
procedure. You may want to paste it into another application such as a
word processor.

14
Figure 14-2. Search Dialog for Highway Reference List Data

14.1.2 Populating the Highway Reference List

Your primary tool for enabling redundant activities is the Highway

Reference List (HRL/HACL) number.

You can use the Populate Highway Access Control List dialog to have
Control Desktop software assign HRL/HACL numbers. Open the dialog
by selecting View --> Populate HACL. The dialog appears as shown in
Figure 14-3.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 210 Section 14 F Utilities

Figure 14-3. Populate Highway Access Control List Dialog

There are two options on the Populate Highway Access Control List
dialog in the Add Points Targeted To area:

J All consoles with Global Ack Alarms and PPA Tracking Enabled

This option causes Control Desktop to assign HRL/HACL numbers

only to points targeted to consoles that have been configured for
global alarm acknowledgement.

If you have configured consoles for global alarm acknowledgement

you must ensure that all points targeted to these consoles in the PPA
14 tracking ring are in the Highway Reference List (HRL/HACL). The
system uses HRL/HACL numbers to ensure that the correct points
are acknowledged. If a targeted point is not in the Highway
Reference List the wrong point may be acknowledged in remote
consoles.

J All Consoles

This option populates the Highway Reference List (HRL/HACL) with

points targeted to all consoles.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Utilities F Section 14 211

There are three read-only fields on the dialog in the HACL Properties
area:

J Configured Max List Size — The number set in the Maximum List
Size field of the Highway Reference List dialog.

J Number of Points in HACL — The number of points that are

currently in the Highway Reference List (HRL/HACL).

J Number of Points to Add — The number of points that will be

added to the Highway Reference list if you click the Populate HACL
button. This number can vary depending on which selection is set in
the Add Points Targeted To area.

If the Number of Points to Add field on the dialog is zero, the Populate
HACL button is disabled.

If the Configured Max List Size value is less than the sum of the values
in the Number of Points In HACL and Number of Points to Add fields,
clicking the Populate HACL button Control Desktop displays a message,
increases the configured list size, and adds the points to the list.

Control Desktop increases the list size to 500 greater than the sum of the
number of points currently in the Highway Reference List (HRL/HACL)
and the number of points to add. Note that increasing the maximum list
size requires a total download to the consoles.

If the sum of the number of points to add and the current number of
points in the list is greater than the largest valid size for the Highway
Reference list (22767), Control Desktop displays a message and
disables the Populate HACL button.

Run the utility before console generates whenever database changes

include a point being targeted to a console for the first time. After
populate the Highway Reference List (HRL/HACL), regenerate all
consoles and download them.

The first time you run this utility several points are likely to be 14
regenerated with the new Highway Reference List number allocated
when the consoles are generated. Subsequent runs and regenerates
should only mean that the changed points get regenerated.

For detailed procedures for using the Populate HACL option, see the
Control Desktop online help file.

14.2 Audit Trail

ENVOX Server and Control Desktop provide you with an audit tool that
gives you several ways to view information about database events. The
audit trail contains information about every event that occurs within
Control Desktop.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 212 Section 14 F Utilities

14.2.1 Viewing Events for a Particular Item

To view the audit trail for a particular item, select the Audit Trail tab from
the Item Detail window. Figure 14-4 shows the Audit Trail tab of an
Item Detail window.

Figure 14-4. Audit Trail Tab of Item Detail Window

The tab shows a list of the events that have occurred to the item. You
can sort the list by clicking one of the column headings.
14 To view the details of an event double-click on a row or select Detail
from the context menu for an event in the history summary area of the
Item Detail Audit Trail tab or of the Audit Trail Search dialog. In either
case, the Audit Trail (Event Detail) window appears and contains
information similar to that illustrated in Figure 14-5.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Utilities F Section 14 213

Figure 14-5. Event Detail for a Selected Event

The top area of the window shows the background information about the
event — event number, date and time, user name, and so on. The
bottom area shows the actions that occurred during the event. You can
view previous events in the history summary or the next events with the
click of the Previous or Next buttons, respectively.

You can print these in-depth details.

14.2.2 Searching Events

You can search all events for items of interest by selecting View -->
Audit Trail Search. The Audit Trail Search dialog opens. The dialog
contains three tabs you use to specify your search: 14
J Date Range

J Item Criteria

J Event No

Figure 14-6 shows the Date Range tab.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 214 Section 14 F Utilities

Figure 14-6. The Audit Trail Search Window—Date Range Tab

Use the Date Range tab to specify whether to search all events or only
those events that occurred in a specified time period.

Figure 14-7 shows the Item Criteria tab.

14

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Utilities F Section 14 215

Figure 14-7. Audit Trail Search Window—Item Criteria Tab

Use the Item Criteria tab to narrow your search based on the following:

J Event Type to specify the type of event you want to retrieve

J Tag to specify a tag that the retrieved events affected

J Username to specify which user carried out the events to be

retrieved

J Program to specify which executable program made the changes to

the database
14
J Device Tag to specify which device the retrieved events affected

J Item Type to specify the type of item affected by the events to be

retrieved

Figure 14-8 shows the Event No. tab.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 216 Section 14 F Utilities

Figure 14-8. Audit Trail Search Window—Event No. Tab

Use the Event No. tab to narrow your search to the last event recorded,
a single specified event number, or a range of event numbers.

After you have set the criteria for your search, click the Find Now button.
The events matching the criteria you specified appear in the list at the
bottom of the window.

14.3 Importing Data

This utility runs from the System, the Resource, or the Plant I/O Explorer,
14 and can be accessed by selecting Application --> Import. You are
prompted to identify a path for the folder containing data that you wish to
bring into the database. Figure 14-9 shows the Import dialog.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Utilities F Section 14 217

Figure 14-9. Import Dialog

You can use the Import utility to load previously exported comma
delimited value (CDV)-formatted data into an ENVOX database, and 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.

The Import utility, which can be run either from Control Desktop or from
command lines, lets you:

J Load the CDV-format data into an empty ENVOX database

J Merge the CDV-format data you are importing into an existing

ENVOX database.

14.3.1 Importing from Control Desktop

To import CDV data from Control Desktop:

Step 1: Select Application --> Import from the Control Desktop

menu.
14
The Import dialog appears.

Step 2: Enter or browse to the directory that contains the CDV data
you want to import.

Step 3: If you are importing into an empty database, select the Verify
Database is empty before Importing checkbox. If you are
merging the imported data into an existing database, do not
select this checkbox.

Step 4: Click Import.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 218 Section 14 F Utilities

Step 5: Click Yes on the confirmation dialog that appears.

A message appears telling the Import Utility Job number.

You can view the Import job status using the Task Monitor.

14.3.2 Importing from the Command Line

You can also import CDV data from the command line. The syntax is:

import /S[:]SYBASE /D[:]DATABASE /U[:]USERNAME

/P[:]password [/L] [/F[:]folder]

/S Specify a SYBASE Server to use.

SYBASE The name of the SYBASE Server.

/D Specify a database to use.

DATABASE The name of the database

/U Defines the ENVOX username.

USERNAME The uppercase ENVOX username.

/P Defines the ENVOX user’s password.

password The ENVOX user’s password.

/L Load the data into the database after verifying that the
database is empty. If you are merging data into the
database, omit this option.

/F Specify the folder (directory) which contains the

export set.
folder Can be a local path (e.g. C:\MyExports\Export1) or a UNC
(e.g. \\server\share\Exports\Export2).

Note ... The import command also has a /J switch. Do not use this
14 switch. The Client Task Daemon uses this switch when it runs
this command for Control Desktop.

Importing a device causes that device and all its source and target points
to be deleted if the device already exists in the database. However, if
you are importing a redundant pair of PROVUE or WPCON consoles you
must ensure they are deleted prior to the import.

14.4 Exporting Data

An ENVOX configuration system can include several databases. Each
database may contain the configuration data for a single plant or plant

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Utilities F Section 14 219

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 14-10 shows how the Export utility works.

HOST COMPUTER

ENVOXr SOFTWARE

Database
Database
Database

Utility
:
Import
Utility
:
Export

Format:
CDV

Figure 14-10. Import and Export Utility Flow Diagram

Basically, the export utility copies 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 Control Desktop or from a
command line. The following subsections describe how to run the utility
via either method.

Note ... Running the export utility from a command line is only 14
recommended for experienced users. Users not familiar with the
command line system should use the Control Desktop interface.

14.4.1 Running the Export Utility from Control Desktop

This utility runs from the System, the Resource, or the Plant I/O Explorer
and can be accessed by selecting Application --> Export. You are
prompted to identify a directory path and folder in which you wish to
store data from your database. Notice that you can specify whether to
export the entire database or you can name an Item Tag or Tag Set that

Using ENVOXr Server and Control Desktop (Original — May 2000)

 220 Section 14 F Utilities

contains the data you wish to export. See Figure 14-11 for the Export
dialog.

Figure 14-11. Export Dialog

14.4.1.1 Exporting the Entire Database

To export all of the sourced, targeted, and referenced items from the
database you are currently logged on to:

Step 1: Select Application --> Export... from the main menu.

The Export dialog appears.

Step 2: Select Export whole database on the Export dialog.

Step 3: Enter or browse to an Export Path.

Step 4: Enter an Export Set Name.

The software creates a directory with this name in which all

the exported CDV files are placed.
14
Step 5: Click Export.

You are prompted to confirm the export. If a directory already

exists named as you specified in the Export Set Name field,
the utility prompts you with a message saying that the
directory will be emptied before the export.

Step 6: Click Yes to confirm or click No to return to the export dialog.

If you clicked yes, a message appears telling you the Export

Utility job number.

You can view the Export job status from the Task Monitor.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Utilities F Section 14 221

14.4.1.2 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: Select Application --> Export... from the main menu.

The Export dialog appears.

Step 2: Enter a tag or tag set name in the Tag of item or Tag Set to
Export field on the Export dialog.

Step 3: Enter or browse to an Export Path.

Step 4: Enter an Export Set Name.

The software creates a directory with this name in which all

the exported CDV files are placed.

Step 5: Click Export.

14
You are prompted to confirm the export.

Step 6: Click Yes to confirm.

A message appears telling you the Export Utility job number.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 222 Section 14 F Utilities

14.4.2 Exporting from a Command Line

You may run the Export utility directly from a command line. The
command syntax is:

export /C[:]CDOS /S[:]SYBASE /D[:]DATABASE

/U[:]USERNAME /P[:]password [/F[:]parentFolder]
[/X[:]eXportSetName] [/W] [/T[:]Tag]

where...

/C Connect through a CDOS Open Server.

CDOS ‘The name of the CDOS Open Server.

/S Specify a SYBASE Server to use.

SYBASE The name of the SYBASE Server.

/D Specify a database to use.

DATABASE The name of the database

/U Defines the ENVOX username.

USERNAME The uppercase ENVOX username.

/P Defines the ENVOX user’s password.

password The ENVOX user’s password.

/F Specify the folder (directory) in which to create the

export set’s folder.
parentFolder
Can be a local path (e.g. C:\MyExports) or a UNC
(e.g. \\server\share\Exports). The folder must exist.
For best performance specify a folder on the local
machine.

/X Specify the name of the export set.

eXportSetName
The export files will be created in a folder with this name
14 in the parent folder (/F switch). The export set folder will
be created if it does not already exist. If it does exist,
it will be cleared of all export--related files.

/W Export the whole database.

/T Specify the tag of the item or tag set to export.

Tag Tag of the item to export

You must use either the /W or /T switch.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Utilities F Section 14 223

Note ... The export command also has a /J switch. Do not use this
switch. The Client Task Daemon uses this switch when it runs
this command for Control Desktop.

14.5 Upgrading Devices

Another important utility for the user is the application that enables you
to upgrade your devices to convert older product configurations to newer
product configurations. The following upgrades are possible:

J UOC/IFC to SR90 P2.0 without I/O — 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 UOC/IFC to SR90 P2.0 with 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
upgraded to distributed MUX I/O.

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

configuration to a PROVUE P5.0 configuration. The upgrade process
deletes any configure alarms. You are recommended to obtain
printouts of the data before upgrade, if you require the information.
You must add PMAs and PPAs after using this option, and all
targeted data forms for targeted points must be modified by
supplying the associated PPA.

J PROVUE to OWP P1.2 — Upgrades the configuration of any

PROVUE console version to an Operator Workplace console
configuration, and deletes any PROVUE Station definitions and
Station keys.
14
Before you carry out an upgrade, it is recommended that you document
the I/O (when upgrading Controller configurations), so that your
controllers can be reconfigured after the upgrade.

To upgrade devices, select the Upgrade option from the top-level

Application menu selection. Figure 14-12 illustrates the Upgrade
Devices window that opens.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 224 Section 14 F Utilities

Figure 14-12. Upgrade Devices Window

You must enter the tag name (or tag set name) of the device to be
upgraded. You can select Tag Values from the context menu to select
from a list.

When the type of device is shown, select from the drop-down list the
type of upgrade you want to carry out. The software shows the device’s
current status.

You can create new rows for entering all of the devices you want to
upgrade.

When you have selected all the tags of the devices you wish to upgrade,
select Action --> Upgrade from the menu or click the toolbar icon to
submit the upgrade. The status of the upgrade appears in the Status
column on the Upgrade Devices window.

14

Using ENVOXr Server and Control Desktop (Original — May 2000)

 History 225

History
The list below shows the printed manuals available for each version of
ENVOXr software and Control Desktop.

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
History

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

Using ENVOXr Server and Control Desktop (Original — May 2000)

 226 History

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 The System Manager’s Guide to ENVOX Configuration Software

SM1.0:SW3151 (Original — December 1993) D3R00501002

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
History
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 The System Manager’s Guide to ENVOX Configuration Software

SM1.0:SW3151 (Revision B — December 1994) D3R00501202

Using ENVOXr Server and Control Desktop (Original — May 2000)

 History 227

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

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
History
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 The Technical Reference for ENVOX Configuration Software

TR1.0:SW3151 (Revision F — July 1996) D2R00481602

J ENVOX Tutor
TU4.14:SW3151 (Original — June 1991) D2T00481002

Using ENVOXr Server and Control Desktop (Original — May 2000)

 228 History

J Using ENVOX Configuration Software

UM6.1:SW3151 (Revision H — July 1996) D2U00481802

ENVOX P4.0

J Installing and Upgrading ENVOX Configuration Software on DEC

VAX and DEC AXP Systems, PN6.1:SW3151:VMS
(Revision B — May 1998) D3P01461202

J Installing and Upgrading ENVOX Configuration Software on HP-UX

Systems, PN6.2:SW3153:HPX
(Revision C — May 1998) D3P01381302

J The System Manager’s Guide to ENVOX Configuration Software

SM1.0:SW3151 (Revision E — May 1998) D3R00501502

J The Technical Reference for ENVOX Configuration Software

TR1.0:SW3151 (Revision G — May 1998) D2R00481702

J Using ENVOX Configuration Software, UM6.1:SW3151,

(Revision J — May 1998) D2U00481902

ENVOX P5.0

J Installing ENVOX Server and Control Desktop, PN:SW3159

(Original — May 2000) D3P01701002

J The System Manager’s Guide to ENVOX Server and Control

Desktop, SM:SW3159 (Original — May 2000) D3R01701002

J The Technical Reference for ENVOX Server and Control Desktop,

TR:SW3159 (Original — May 2000) D2R01701002

J Using ENVOX Server and Control Desktop, UM:SW3159:EN

(Original — May 2000) D2U01701002

J Using Control Designer, UM:SW3159:LD (Original — May 2000)

D2U01711002
History
J Using Display Designer, UM:SW3159:DS (Original — May 2000)
D2U01721002

Control Desktop P1.0

J Installing and Using Type SW3311 Control Desktop,

UM6.3:SW3311:CDT (Original — June 1997) D2U01511002

J Using Control Designer with Type SW3311 Control Desktop,

UM6.3:SW3311:DES (Original — June 1997) D2U01521002

Using ENVOXr Server and Control Desktop (Original — May 2000)

 History 229

Control Desktop P2.0

J Getting Started with Control Desktop, UM6.3:SW3311:G (Original —

May 1998) D2U01611002

J Using Control Desktop Modules, UM6.3:SW3311:M (Original — May

1998) D2U01581002

Control Desktop P5.0

See the list of documents available for ENVOX P5.0.

History

Using ENVOXr Server and Control Desktop (Original — May 2000)

 230 History

Blank page.

History

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Glossary 231

Glossary
Address Attribute
One or more integers arranged to identify An individual parameter of a process
the location of a device or logical unit of control point. Also the name of a
an instrumentation system. In PROVOXr PROVOX data type. In some systems,
systems, address values identify such points have just one or two attributes;
things as data highway, device, file, card, however, points in PROVOX systems
and channel. have many. Accordingly, each point of a
PROVOX system commonly provides the
AI control of four or five non-PROVOX
Acronym: Analog Input system points.

Analog Input (AI) Audit Trail

A PROVOX point type. An analog input A record of changes made to the
point receives a single analog value, the ENVOXr database and to the system
process variable. where the database resides. The record
includes the type of change, when the
change was made and who made it.
Analog Output (AO)
A PROVOX point type. An analog output
point generates a single analog value, CDOS
the setpoint. Acronym: Control Desktop Open Server.

AO CDV
Acronym: Analog Output Acronym: Comma Delimited Values

ASCII CHIP
A PROVOX point type. An ASCII point Acronym: Computer/Highway Interface
contains a single real value, referenced Package
by the setpoint attribute, and an
80-character ASCII string.

Glossary

Using ENVOXr Server and Control Desktop (Original — May 2000)

 232 Glossary

Client Task Daemon Control Designer

The Client Task Daemon is part of the The Control Designer module is a tool
CDOS software. It is responsible for you can use to create control strategies
handling tasks such as generate, for PROVOX controllers graphically,
download, rename, import, export, and so using a Function Block language. All
on. In most situations, the Client Task Control Designer data are held in the
Daemon resides on the client ENVOX database.
workstation, though it is possible for it to
reside on a different machine. Control Sequence
A type of primary control algorithm which
Comma Delimited Values Format provides basic functions such as alarms,
An ASCII version of configuration data. data communication, tracking, and error
The configuration data are in a specific signal calculation, but does not provide
order, separated by commas. CDV-format any form of control action. This allows the
files result from both the export utility and user to create a customized control
the migrate utility. algorithm transfer function using FST
instructions.
Computer/Highway Interface
Package (CHIP) Current Resource
A PROVOX software product that allows In Control Designer, this is the resource
user-written programs to interact with the which you selected in the Select Project
PROVOX database. There are different Database dialog box. It is displayed in
CHIP versions, so that any of several the Control Designer project tree.
types of computers can be the host
computer. Database Index (DBI)
A sequential integer by which a computer
Conditionals or other electronic device finds or keeps
Console display elements that change track of storage locations in a database.
color or present messages based on a
change in a point attribute. Databook
The Databook provides information on
Context Menu each function and function block in the
A special menu appears when you click Control Designer database. Each entry in
the right mouse button (or left mouse the Databook shows the graphic for the
button if you have reversed the mouse selected element along with additional
buttons). This menu contains options information such as inputs and outputs.
specific to your current level in Control
Desktop. These options are shortcuts to Datatype
Glossary commands you can run on whatever item Determines the rules that entries for
you have currently selected within specific columns must follow.
Control Desktop or one of its modules.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Glossary 233

DBI Discrete Control Device (DCD)

Acronym: Database Index A PROVOX point type. A DCD point
encompasses as many as 8 discrete
DBMS output and 16 discrete input channels
Acronym: Database Management into a single point. This makes possible
System. The DBMS manages user 16 setpoints and matching input/output
requests (and requests from other states. A common use for a DCD point is
programs) so that users and other to control a discrete device that provides
programs are free from having to feedback about its status. If the point
understand where the data is physically works with a DCD template, it can use
located on storage media and, in a different combinations of channels at
multi-user system, who else may also be different times during the execution of a
accessing the data. process-control algorithm.

DDP Discrete Input (DI)

Acronym: Detail Display Parameter. A PROVOX point type. A DI point
monitors a single discrete value of the
process variable. That is, a DI point reads
Detail Display Parameter (DDP) discrete data from a sensor or other
An item of information usually considered system device.
changeable or tunable for a control loop
or point. Common examples are gain,
rate, reset, and alarm trip points. Discrete Output (DO)
A PROVOX point type. A DO point
generates a single discrete value
Device referenced by the setpoint.
An item that you can create in Control
Desktop. The types of device you can
create include consoles, CHIP devices, Display Designer
and controllers. A module that enables you to create
mimic display diagrams using a graphical
Windows interface. You can save the
Diagnostics displays to file, and can save them to an
A module of Control Desktop designed ENVOX database so that they can be
for maintenance users responsible for viewed on a PROVUEr or Operator
maintaining the availability and operability Workplace console.
of a system once it is in operation. It is
particularly useful in resolving plant
integrity problems. Diagnostics can be Download
run remotely. To transfer configuration instructions and
reference information from a
configuration device to other devices of a Glossary
Diagram Extent process control system.
The area of the window that encloses all
the blocks that have been placed on the
diagram is the extent of the diagram and
is indicated by a blue dashed line. The
diagram extent has a minimum size of
one page.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 234 Glossary

Dump Device Excel Matrix

A tape or disk device to which a A module in Control Desktop that enables
database and its associated transaction you to efficiently configure large numbers
log can be copied to usually for backup of Loop and Enhanced DCD points. You
purposes. can create workbooks for bulk Loop or
Enhanced DCD configuration and
DWG transfer data between the workbooks and
Standard file format for saving vector the database. Excel Matrix uses the
graphics from within Display Designer. Microsoft Excel spreadsheet editor to
provide ease of configuration. Excel
Matrix is a Microsoft Excel add-in.
ED
Acronym: Emergency Download
Exception Reporting
A type of unsolicited reporting: the
Emergency Download (ED) Files reporting device sends a new value only
Emergency download files provide a if the sample period has expired and the
means for you to download a device if value has changed significantly since the
the SYBASE server is not available, or if last transmission.
your ENVOX Server and Control Desktop
database has problems. Each emergency
download file contains data for a single Explorers
device. You can create emergency Graphical User Interface windows that
download files from within Control provide a visual presentation of data in
Desktop. the database that can be viewed at
varying levels through use of a mouse.
There are three basic explorer views
ENVOXDB Database available within Control Desktop: System,
The default user database which stores Resource, and Plant I/O. Other modules
all configuration data and is created by and utilities, such as Client Administration
ENVOX software upon ENVOX also use explorers.
installation.
Export
envox_readonly Database The extraction of ENVOX configuration
An ENVOX system database containing data and placing it in CDV files.
reference data which is used by all of the
ENVOX user databases in the system.
The database is created by ENVOX Export Set
software upon ENVOX installation. CDV files prepared for import to an
ENVOX database.

Glossary Faceplate
An established display figure, used in
Display Designer, that shows the most
important information about a process
control point. Faceplates are vertical
rectangles, several of which fit on a
console screen at once.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Glossary 235

Function Block Group Display

A function block has one or more of the A set of 12 point templates that appear
following attributes: more than one together on a PROVOX console screen,
output; persistent data; an internal state. so that an operator can see at a glance
Graphically, a function block is denoted the most important information about 12
by an occurrence name displayed above different points. During system
it. configuration, the user establishes the
number of group displays, as well as
Function Block Diagram which point faceplates make up each
In Control Designer, a diagram which group display.
defines a control strategy using functions,
function blocks, variables, and their HACL (Highway Access Control List)
interconnections. See Highway Reference List.

Function HART Instrument Locator Tool (HILT)

A function has one or more inputs and a The HART Instrument Locator Tool (HILT)
single output. It has no persistent data is a standalone utility run from the
and no internal state. ENVOX command line. The utility gathers
information about smart field devices
Generate connected to a PROVOX system through
To use Control Desktop to validate and configured controllers. HILT stores the
extract the data you have set up in the collected information in a Comma
database into a configuration file. You Delimited Values (CDV) file specified by
can then download the configuration file the user so that Asset Management
to a device in order to specify how that Solutions (AMS) can correctly address
device functions. the instruments when the need arises.

Group Highway Reference List

A PROVOX point type. A group point Also known as Highway Access Control
controls as many as 8 DCD points so that List (HACL). A console uses the highway
they work in unison. A Group point uses reference list index to transfer information
a Group template which contains up to on points to other consoles.
16 setpoints for driving DCD point
setpoints. the user defines group IEC
templates as part of system Acronym: International Electrotechnical
configuration. Commission

Import
The process of placing configuration data Glossary

into an ENVOX database from CDV file

format.

Information stream
The first stream in a CDV file.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 236 Glossary

International Electrotechnical Links

Commission (IEC) A line element in Control Designer that
An international group developing connects two items. Items can be
standards and certification in electronics functions, function blocks, parameters, or
and electrical engineering. variables. Links are automatically routed
and you must make them between the
ISQL output of one element and the input of
SYBASE’s stand-alone utility program for another.
database queries.
Load
Item A software-initiated action on a database.
A general term for an ENVOX database The term refers to the SYBASE database
entity. Items include device definitions, load function.
points, and templates.
Locks
Join A software-initiated action on a database
A join combines data from multiple tables table. The database software locks tables
into a single result table by comparing the that are being affected by a process. The
values from specified columns. You can ENVOX administrator can determine
use joins in an SQL statement to produce which processes are locking which
a custom report in Report Writer. tables.

Kernel Log
The lowest layer into which a large A record of events that have occurred
operating system is divided -- each layer within the database. A log may consist of
handles some aspect of the system successful and unsuccessful events and
hardware. ENVOX Server and Control any error or warning messages related to
Desktop uses a CHIP kernel. those events.

LCP Logic Control Point (LCP)

Acronym: Logic Control Point A PROVOX point type for an advanced
batch or multifunction controller, such as
a UOC or IFC. A role for a multivariable
LCP Trace/Tune point, an LCP calls a programmed
Integrated module that enables you to subroutine defined by an FST. As
debug the control strategy of an LCP configured, the LCP activates the FST in
point by viewing the functions sequence a continuous loop, as a single shot
tables it uses. program, or as required as part of a
Glossary control loop.
Legacy Subroutine FSTs
The Control Designer module supports Logic Editor
legacy subroutine FSTs which return a A module integrated into Control Desktop
single value to be used from within that you can use to create and edit logic
programs. This support also lets user items.
functions map signals into and out of a
legacy subroutine FST.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Glossary 237

Loop Name
A PROVOX point type. A loop point A unique identifier for any device or
provides control for a continuous logical unit of an operations console
process. Loop points have many system except a point or a controller
attributes, so can provide very (points and controllers have tags instead
sophisticated control. Bias or ratio factors of names).
often can be added to loop points.
Null
Master Database Having no assigned value. In a CDV file,
The central database which holds details null is represented as two commas with
of all of the other databases. It is created zero or more spaces in between.
by SYBASE when SYBASE is installed.
Operand
Matrix 1. In the language editor, a value that
A means of displaying data in column modifies or qualifies a function.
format in Control Desktop, so that you 2. In ASCII configuration source files, an
can quickly and efficiently configure large expression, a simple operand, a phrase
amounts of items. (Item types Loops and list, or an operand list.
EDCDs can be configured in Excel
Matrix.) Operation Parameters
The 32 unit variables that contain default
Migrate grade values. Operation parameters are
The process of converting PROFLEX common to all phases of an operation.
configuration data into CDV file format,
from which the data can be imported into Option Button
an ENVOX database A button that excludes other options
when you select it. Option buttons are
Model Database sometimes known as radio buttons.
The database which is used as the basis
for a new database. It is created by PDF
SYBASE when SYBASE is installed. Acronym: PROVOX Display Format. An
ASCII tab-delimited file format in which
Multiple Document Interface (MDI) Display Designer can store displays.
In a Multiple Document Interface (MDI) These can then be viewed using the
application such as Control Desktop, you ViewPDF utility.
can open several windows at the same Acronym: Adobe Portable Document
time and work on the contents of those Format
windows. In Control Designer, when you
have several program diagrams open at Glossary

once, you can cut and paste between the

diagrams with ease.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 238 Glossary

PDX (Portable Database Transfer) Point

Utility for transferring ENVOX databases A set of process-control parameters and
between computers, and performing data. The makeup and structure of each
database backups. This is the only point depends on its role in collecting and
mechanism for transferring complete reporting data and the type of device in
databases, including download data, which the point resides. Points are the
between different computer platforms. most important logical units of a process
control system; the number of points is a
Plant Area measure of the system’s size and
The collection of equipment in a plant sophistication.
that has common manufacturing A software building block for a
strategies and alarm strategies. configuration in which resides the
information from the process-control
Plant I/O Explorer database, such as data and the action
A database view launched from the necessary to perform a particular control
System Explorer that expands to show task.
the PROVOX Network Highway.
Populate HACL
Plant Management Area (PMA) Control Desktop utility to automatically
A collection of plant process areas add all points that are targeted to
(PPAs). A PMA controls the console point consoles to the Highway Reference List,
reporting load, and indirectly, central if the points are not already in the list.
processing unit (CPU) loading.
PPA
Plant Process Area (PPA) Acronym: Plant Process Area
Within a process-control system, a
collection of equipment that uses a Primary Control Algorithm (PCA)
common alarm strategy. The principle control equation of a
continuos loop in a PROVOX system.
PMA The PCA type and station (STA) type
Acronym: Plant Management Area defined during configuration determine
the main functionality of a point.

Process
A user-initiated action that affects or
accesses a database. Each process
represents one connection to the server.
An ENVOX user typically has three to five
Glossary
processes active at once. Adding a point,
generating files, and downloading files
are examples of processes. The ENVOX
administrator can determine which users
have initiated which processes and can
also kill processes.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Glossary 239

Program Diagram PROVOX Display Format (PDF)

A software entity built using the Control ASCII-based format used for operator
Designer Function Block Editor, which screen displays on PROVOX system
becomes a function sequence table in an consoles.
ENVOX database and in the SR 90 and
SRx controllers. A program diagram PSR file
defines a control strategy. A file that contains a report saved from
Report Writer in a proprietary format.
Project File When you save a report as a PSR file,
A file within Control Designer that you can open the PSR file from Report
contains all the elements that make up a Writer and review it.
control strategy. A Control Designer
project maps directly to an ENVOX QRY file
database. A Control Designer project is A file that contains an SQL query that
associated with a single ENVOX you use to generate a custom report in
database, and an ENVOX database is Report Writer. When you save a query in
associated with one project. a QRY file, you can open the QRY file
from Report Writer and use it to generate
Project Administrator another custom report.
A user for a database who has the
authority to specify which other users can Real
access the database and what users can A PROVOX point type. A real point has a
do once they have access to the single real (floating-point) value
database. Specifically, the project referenced by the setpoint.
administrator can use the Administration
Module to control user access to the
database. Rename
Enhanced ENVOX rename functionality
supports rename of tags in all
Project Engineer configuration tables including Control
A user that has read and write access to Designer tables.
the database by default but cannot
control the access that other users have
to the database The project administrator Report Writer
controls exactly which tasks a project An integrated module used to order, view
engineer can do within a database. and print reports for certain Control
Desktop levels.
Project Tree
The structure of a project. Each level of Resource
the tree which contains subitems is called Resource is an IEC term equivalent to a
Glossary
a branch. A level which contains no PROVOX SR90 or SRX controller.
subitems is called a leaf. You can expand
or collapse the branch of the item.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 240 Glossary

Resource Explorer Status Bar

A device view launched from the System The bottom of the window of most
Explorer of the configuration database Control Desktop modules and utilities
from a device perspective. contains a status bar. This shows
information such as quick help on the
Resume object being selected or highlighted.
A resume block translates directly into
the FST resume instruction. Streams
A series of data fields separated by
Root commas (CDV format), representing a
In the Control Desktop explorers, you can configuration item. Streams begin with a
set a root in the explorer tree so that only keyword called an identifying field. This
information below that point in the tree keyword identifies the stream type (for
appears in the explorer window pane. example, UOC_GROUP). Streams end
with the keyword END.
Scrollable Extent
The area of the window in Control Structured Query Language (SQL)
Designer where you can place or move A language which provides a user
blocks. The scrollable extent is one page interface to relational database
greater than the diagram extent in both management systems. It is often
height and width. embedded in other programming
languages. A user can create an SQL
query in order to obtain specific
Selection Toolbar information from the database.
In Control Designer, a list of all the items
in a specific Group from which you can
select an item to place on the diagram. Substreams
A series of data fields within a stream,
separated by commas (CDV format) that
Server Setup begins with a keyword, and continues
A utility that you can use to set up the until the next keyword.
CDOS Open Server(s) and SYBASE
SQL Server(s) you require when you use
Control Desktop. This is automatically Sybsystemprocs Database
launched when you install Control Used in SYBASE SYSTEM 10. It is the
Desktop. database which holds stored procedures
that were previously held in the master
database. It is created by SYBASE when
SQL SYBASE is installed.
Abbreviation: Structured Query
Language
Glossary Table
A collection of records in a relational
Standard Functions database.
These are the functions and function
blocks which are provided as part of the
Function Block Editor. Many of these Target Device
functions/function blocks are a subset of Any system device that receives point
IEC 1131 standard. You cannot edit information, commonly a display device
standard functions. that shows the information to an operator.

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Glossary 241

Task Text Box

The control element that provides If you want to add some information
periodic execution of the signal about a function block diagram to the
processing functions required by the diagram itself, you can create a text box
control strategy. A Control Designer task to contain this information.
maps directly to an ENVOX logic control
point (LCP). Transact SQL
A subset of SQL commands that you can
Task Daemon use to query a SYBASE server.
The task daemon is part of the CDOS
software and is the name of the process Transaction Log
that handles ancillary tasks such as A log file maintained by the dataserver of
generate and download. There are client all modifications to the database. As
task daemons, server task daemons, and additions, updates, and deletions are
CHIP daemons in P5.0. performed on data, these changes are
written to the transaction log. Once the
Task Monitor changes have been accepted by the user
An integrated utility that displays the process and the transaction is complete,
status of all jobs currently in the Control the changes are applied to the
Desktop job queue. appropriate data file in the database. If
processing errors or system failures
TCP/IP occur, transactions which have not
Acronym: Transmission Control properly completed are not applied to the
Protocol/Internet Protocol data file, and the memory cache copy of
the affected data is restored from the
data file. The transaction log is not the
Tempdb Database Audit Trail log, but rather contains
The database in which all temporary SYBASE-only information.
tables are created. It is created by
SYBASE when SYBASE is installed.
Translate
To convert a diagrammatic control
Template function created in Control Designer into
A pattern for valid relationships among a format that the plant controller can
elements of a control strategy, defined understand.
without specifying particular elements. A
template permits different specific
elements to use the relationships at Unit
different times during the execution of the A PROVOX point type. A unit point has
control algorithm. The user establishes many attributes, enabling it to control the
templates as part of system execution of a unit operation. Glossary

configuration. [See Alias Template, DCD

Template, and Group Template.]

Using ENVOXr Server and Control Desktop (Original — May 2000)

 242 Glossary

Upload ViewPDF
The movement of configuration This utility displays PDF files on a PC,
instructions from system devices to a simulating the appearance of the display
configuration device or interface. An on the console or operator interface. You
upload lets the current values of can use this utility to check the
parameters be incorporated into new appearance of a display before saving
configuration source files, eliminating the display to the database from within
specific user entry. Uploads also may be Display Designer.
used to verify that configuration
instructions are correct. Where Clause
Sets the search conditions to apply to an
User Functions SQL query.
A user function diagram, created with the
same drawing methods as program Window
diagrams, can be used on one or more A particular type of console display that
program diagrams in a current project. has a specific purpose. A DDP window,
These user-created diagrams can contain for example, shows point DDP
standard functions but not other user information. A trend window shows trend
functions. set information. An application window
emulates a computer terminal.
Variable A trace utility mode within LCP
A variable is an IEC concept for a data Trace/Tune, in which accumulator values
type; for example, real, integer, percent, appear on the console screen as trace
or Boolean. point FST steps execute, but FST
execution does not stop at trace points.
Variables Editor
A module of Control Designer that you
use to define and to edit user variables in
addition to the (standard) system
constants. Variables can be local to a
specific program diagram or global and
you can set access to them as read-only,
write-only, or read-write.

Glossary

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Index 243

Index

cloning
console configurations, 80
A restrictions, 81
command lines, entering, 19
abbreviations used in manual, 18
command prompt styles, 19
aborting, from Task Monitor, 203
commands, use of return key, 19
accumulator, 179
comments, language editor, 105
Add menu option, 85
conditional color expressions, creating
adding an item to the database, 85 from the language editor, 100
alarm conditional text expressions, creating from
conventions, 25 the language editor, 100
management, 25
configuration
audit, particular item, 212 conventions
Audit Trail, 211 alarm, 25
searching events, 213 display, 25
copying items, 77
Audit Trail, 31
managing, 59
planning and design, 25
configuration data, validating, 89

B configuration item, copy, 77

console
back up download files, 143 alarm management, 25
cloning, 80
BATCH HISTORY instruction, 112
copying a configuration, 80
BLANK LINES instruction, 113 reports, 110
bulk configuration context menu, 53
EDCD points, 119
Control Desktop
loop points, 119
licensing, 42
logging in, 40
options, 41
reports, 189 Index

C starting, 39
Control Desktop stops, 43
change column heading, matrix view, 77
conventions, typographical, 18
change column width, matrix view, 76
copy, configuration item, 77
client administration navigation, 57

Using ENVOXr Server and Control Desktop (Original — May 2000)

 244 Index

copying, console configuration, 80 from a non-ENVOX machine, 144

copying an item, 65 from an emergency download (ED) file,
144
Create Emergency Download Files, 145 when SYBASE server is unavailable,
creating a new item, 63 144
cross reference conventions, 19 duplicate existing information, matrix view,
72
custom grid, 71, 76
cutting and pasting in the language editor,
106
E
EDCD points, Excel Matrix workbook, 125
D Edit FST! menu option, 100
database editing an item, 66
default, 40 emergency download, 144
listed in server window, 41
emergency download (ED) files,
updating from Excel Matrix, 133
downloading a device from, 147
DDPs, 180
emergency download file, creating from
for uploadable points, 157 Control Desktop, 145
default row information, matrix view, 72 emergency download files
default tag, 95 creating from command prompt, 146
deleting items, 69, 82 naming convention, 147

detail display parameters, 157 encryption algorithm, 44

device, upgrading, 223 entering command lines, 19

displays, conventions, 25 ENVOX document list, 21

dividing line, 76 ENVOX Server, starting, 39

document list, ENVOX, 21 ENVOX Server navigation, 56

documentation, related PROVOX, 21 ENVOX system, software version, 15

DOCVUE documentation, 22 errors

examining in Excel Matrix, 133
download, from Task Monitor, 202 generation, 109
download, 138 event detail, of Audit Trail, 212
backing up, 143
from backup, 143 events, for a particular item, 212

Index
from command prompt, 141 Excel Matrix, 119
from Control Desktop, 139 concurrent users, 128
from emergency download file, 147 connection to ENVOX Server, 120
from Task Monitor, 140 editing a workbook, 133
download data, 139 errors and warnings, 133
external data, 132
downloading configuration data installing the Add-in, 128
download utility, 29

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Index 245

menu options, 127 generating configuration data, 29

sample workbook, 131 generation errors, 137
starting, 130 viewing, 109
transferring data, 132
using, 130 getting help, 22
vs. Open Database, 120 grace period, licenses, 42
workbooks, 122
explorer
plant I/O, 51
resource, 50
system, 49
H
explorers, 47 HCL. See Highway Reference List
functions available from, 60
help
using, 48
display editor, 33
Export utility, 218 field_level, 33
export_setup utility, 222 language editor, 33, 108
menu_option, 33
exporting navigation, 33
from command line, 222
from Control Desktop, 219 help map, 34
from Matrix View, 74 help with system management, 22
exporting database data, 220 hide a column, 76
Highway Access Control List, 205
populating, 209
Highway Reference List, 205
F searching, 208
tasks, 208
F-C-C data, moving, 70
history instructions, 112
find and replace, 106
FORM FEED instruction, 113
form help, 33
forms I
Generation Errors, 93
Tag Set, 93 I--total download, 141

FST I/O channels, 180

editing, 174 Import utility, 216
stepping, 172
Importing, into Matrix View, 75
FST size, 109 Index
importing data
from command line, 218
from Control Desktop, 217
include function, 104
G instructions
adding, 101
generating, from Task Monitor, 202

Using ENVOXr Server and Control Desktop (Original — May 2000)

 246 Index

modifying, 105 LCP Trace/Tune, 165

valid, 101 breakpoint, 172
Instrument signal tags, 87 preferences, 182
registry settings, 183
instrument signal tags, creating, 89 signal processing, 168
Instrument Signal Tags (ISTs), 27 trace modes, 169
user interface, 166
ISQL, 94
license
ISTs, 27
activating keys, 45
item additional, 43
copying, 65 for new hardware, 44
creating, 63 grace period, 42
creating from explorer, 66 keys, 42
deleting, 69 requesting, 43
editing, 66 status, 46
moving, 68 view users, 42
renaming, 82
license pool, 42
item deleting, 82
licensing, 42
Item Detail dialog, 60
LIST HISTORY instruction, 112
Logic Editor
options, 104
print files, 117
J printing from, 116
Logic menu option, 99
job log, 196
logic sequences, 99
job queue, 195
loop points, Excel Matrix Workbook, 124

L
M
language editor, 99
accessing, 100 M--partial download, 141
comments, 105 M--total download, 141
cutting and pasting text, 106
finding and replacing text, 106 making suggestions, 22
help, 108 manuals
LAYOUT, print attributes, 111 in PDF format, 37
online, 37
Index LAYOUT instruction, 110 printed, 35
LCP Matrix View, 61
running, 172 creating items, 72
stopping, 172 customizing, 76
tuning, 175

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Index 247

default tags, 71 operands, 102

deleting items, 73 operating parameters, 181
edit items, 73
exporting data, 74 operation stops, 43
importing data, 75
using, 70
menu
context, 53 P
pulldown, 53
top level, 53 Partial download, 139
menu keys, 52 pattern tag, 95
menu options PHRASE LIST instruction, 113
Add, 85
Plant I/O Explorer, 51
Copy Console Configuration, 80
Logic, 100 POINT HISTORY instruction, 112
menus, 47 POINT LIST instruction, 113
menu bar, 53 points, uploadable, 157
pull_down, 53
populating rows, 73
migration, format, 219
print, logic data, 116
modules, 55
printed manuals, 35
modules and utilities, 55
PROVUE console. See console
moving data, 70
moving items, 68
moving targets, 69
Q
QRY file, 191
N query builder, 191

navigation, 47
help, 33
new blank row, matrix view, 72 R
NEXT instruction, 113
registers, 177
NORMAL, trace mode, 169
renaming, from command line, 84
renaming an item, 82
Index
REPEAT instruction, 113
O report
previewing, 114
on-line help. See help print attributes, 111
online books, 37 Task Monitor, 198

Using ENVOXr Server and Control Desktop (Original — May 2000)

 248 Index

Report Writer, 189 System Explorer, 49

reports, 189
changing appearance of, 192
creating, 110
custom, 190 T
edit display example, 114
previewing, 113 tag set, 91
saving tag set, 193
standard, 189 tag sets
appending tags to, 94
requirements creating, from Tag Set form, 93
hardware, 24 for security areas, 93
software, 25 form for creating, 93
Resource Explorer, 50 contents, 93
using, 79, 92
restore hidden columns, 76
Tag_set, access, ISQL, 94
return key, use for commands, 19
tag
revision control of manual, 19
default, 95
pattern, 95
target, moving, 69

S target devices, 85
Target! menu option, 85
saving instruction sets, 109 targeting point data
search criteria, Audit Trail, 213 source data, 85
security areas, tag sets, 93 target devices, 85

serial number, 43, 44 Task Monitor, 195

server connection, 198
server, default, 40
Task Monitor functions, 196
signal processing, LCP Trace/Tune, 168
toolbar, 54
size, FST or Step , 109
trace, 165
documentation, how supplied, 33
trace mode
software, version, ENVOX, 15 BREAKPOINT MODE, 170
software serial number, 43, 44 changing, 173
NORMAL, 169
source point, 85 BREAKPOINT, 170
SQA writing, 191 WINDOW, 170
SQL function, query builder, 191 trace modes, 169
Index
starting, logging on, 39 trace point, setting, 171
Step size, 109 trace/tune, 30
stepping, 172 tune. See trace/tune
stopped operation, 43 tune items, 185
suggesting changes, 22 Typographical conventions, 18

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Index 249

utilities, 55

U
UNTIL END instruction, 113
V
UNTIL instruction, 113
upgrading devices, 223 validating data, 89
upload, 30 validation
data precision, 152 errors, 89
logs, 154 log, 89
privileges, 151 versions, 23
reports, 155
to LCP registers, 151 view license users, 42

uploading, 148
and Task Monitor, 153
uploading on-line configuration data
detail display parameters (DDPs),
W
149–164
BREAKPOINT, trace mode, 170
limitations, 149
uploadable point types, 149–151 WINDOW, trace mode, 170
using return key for commands, 19

Index

Using ENVOXr Server and Control Desktop (Original — May 2000)

 250 Index

Blank page.

Index

Using ENVOXr Server and Control Desktop (Original — May 2000)

 Notes 251

Notes

Using ENVOXr Server and Control Desktop (Original — May 2000)

252 Notes

Notes

Using ENVOXr Server and Control Desktop (Original — May 2000)

Blank page.
Fisher-Rosemount Systems, Inc.
8301 Cameron Road
Austin, Texas 78754-3895
Tel 1 (512) 835-2190
Fax 1 (512 418-7503

UM:SW3159:EN