The System Manager’s Guide

to ENVOXrr Server and Control

Desktop
This manual applies to ENVOXr Server P5.0 and Control Desktop
P5.0 only. For earlier ENVOX and Control Desktop versions,
retain the applicable manuals.

System Manual
SM:SW3159
Original — May 2000
D3R01701002
DOCVUE, ENVOX, Fisher-Rosemount, Fisher-Rosemount Systems, PROFLEX, PROVOX, and
PROVUE are marks of one of the Fisher-Rosemount group of companies.
All other marks are the property of their respective owners.

ã 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.
The System Manager’s Guide to ENVOXr Server and Control Your Evaluation Please ... iii
Desktop
(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 ... The System Manager’s Guide to 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
FISHER-ROSEMOUNT SYSTEMS USE ONLY — forwarded to:
V Lead Writer V Engineering V Technical Support V Marketing V Project File
The System Manager’s Guide to ENVOXr Server and Control Contents v
Desktop
(Original — May 2000)

Contents

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

2 Administration Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
2.1 Login Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
2.2 Starting Control Desktop and ENVOX Server . . . . . . . . . . . . . . . 23
2.3 Accessing Administration Functions . . . . . . . . . . . . . . . . . . . . . . . . 24
2.4 ENVOX Server Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
2.5 Client Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
2.6 Diagnostics Module Administration . . . . . . . . . . . . . . . . . . . . . . . . . 28
2.7 Database Property Sheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
2.8 Universal File Menu Choices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
2.9 Carefully Choosing File Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
2.10 Specifying File Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
2.11 Product Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
2.12 Product Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
2.13 Computer Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

3 System Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
3.1 Initial Passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
3.2 Access by Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
3.2.1 ENVOX Daemon Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
3.2.2 Machine User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
3.2.3 Control Desktop User Account . . . . . . . . . . . . . . . . . . . . . . . . . . 34
3.2.4 Administration Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
3.3 Administration Passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
3.4 Changing the sa Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
3.5 Changing the envoxutility Password . . . . . . . . . . . . . . . . . . . . . . . 36
3.5.1 Initial Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
3.5.2 Unknown Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
3.6 Using Security Area Tag Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
vi Contents The System Manager’s Guide to ENVOXr Server and Control
Desktop
(Original — May 2000)

3.6.1 Creating Security Area Tag Sets . . . . . . . . . . . . . . . . . . . . . . . . . 37

3.6.2 Assigning Security Area Tag Sets . . . . . . . . . . . . . . . . . . . . . . . . 37
3.6.3 Assigning Global Item Security . . . . . . . . . . . . . . . . . . . . . . . . . . 38

4 Setting User Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

4.1 Grant User Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
4.2 Customize User Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
4.2.1 User Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
4.2.2 Item Editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
4.2.3 Matrix Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
4.2.4 View Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
4.3 Revoke User Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
4.4 Show Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
4.5 Change User Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
4.6 Change Default Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

5 Administering Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
5.1 Viewing Server Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
5.1.1 Show Current Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
5.1.2 View Server Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
5.1.3 View Application Locks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
5.1.4 View SYBASE Locks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
5.2 Stopping and Starting Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
5.3 Server Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
5.3.1 Connection and Network Information . . . . . . . . . . . . . . . . . . . . . 50
5.3.2 Add a Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
5.3.3 Change a Server or Its Address . . . . . . . . . . . . . . . . . . . . . . . . . 51
5.3.4 Delete Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
5.3.5 Validate the Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
5.3.6 Create a Server Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
5.3.7 Delete a Server Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
5.4 Setting the Client Task Daemon . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
5.5 Infrequently Used Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

6 Administering Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
6.1 View Database Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
6.1.1 Database Attributes Information . . . . . . . . . . . . . . . . . . . . . . . . . 56
6.1.2 Logical Device Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
6.1.3 Space Used Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
6.2 Automatically Created Databases . . . . . . . . . . . . . . . . . . . . . . . . . 59
6.3 Add a Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
6.4 Copy a Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
6.5 Rename a Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
6.6 Delete a Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
6.7 Special Considerations for Multiple Database Segments . . . . . . 63
6.8 Using Verify Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
The System Manager’s Guide to ENVOXr Server and Control Contents vii
Desktop
(Original — May 2000)

6.8.1 Setting Verify Mode to OFF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

6.8.2 Setting Verify Mode to ON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

7 Administering Logical Devices . . . . . . . . . . . . . . . . . . . . . . . 69

7.1 Add Logical Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
7.2 View Logical Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
7.3 Delete Logical Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

8 Administering Database Backup and Recovery . . . . . . . 73

8.1 Recommended Backup Frequency . . . . . . . . . . . . . . . . . . . . . . . . 73
8.2 Backup and Recovery Considerations . . . . . . . . . . . . . . . . . . . . . . 74
8.3 Backup and Recovery Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
8.4 Consistency Checks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
8.5 Checking the User Database before Backup . . . . . . . . . . . . . . . . 76
8.5.1 Checking the User Database with Server Administration . . . . 77
8.5.2 Checking the User Database from the Command Line . . . . . 77
8.5.3 Checking the User Database with ISQL . . . . . . . . . . . . . . . . . . 77
8.6 Checking the Master Database Before Backup . . . . . . . . . . . . . . 79
8.6.1 Checking the Master Database with Server Administration . . 79
8.6.2 Checking the Master Database with Command Line . . . . . . . 80
8.7 Database Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
8.7.1 Backing Up SYBASE Created Databases . . . . . . . . . . . . . . . . . 82
8.7.2 Choosing Disk or Tape Dump Devices . . . . . . . . . . . . . . . . . . . . 83
8.7.3 Using the Backup Database Option to Backup . . . . . . . . . . . . 83
8.7.4 Using Operating System Commands to Backup . . . . . . . . . . . 84
8.8 Database Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
8.8.1 Using the Recover Databases Option to Recover . . . . . . . . . . 86
8.8.2 Using Operating System Commands to Recover . . . . . . . . . . 87
8.9 Dump Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
8.9.1 Add Dump Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
8.9.2 View Dump Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
8.9.3 Delete Dump Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
8.10 Backup and Recovery Troubleshooting . . . . . . . . . . . . . . . . . . . . . 90
8.10.1 Databases Marked as Non-Recoverable . . . . . . . . . . . . . . . . . . 90
8.10.2 Standalone (Disk Image) Backup . . . . . . . . . . . . . . . . . . . . . . . . 90
8.10.3 Standalone (Disk Image) Recovery . . . . . . . . . . . . . . . . . . . . . . 90
8.11 Backup Server Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
8.11.1 Starting and Stopping the Backup Server . . . . . . . . . . . . . . . . . 91
8.11.2 Using the Backup Server with Tapes . . . . . . . . . . . . . . . . . . . . . 91

9 Using PDX to Transfer and Backup Databases . . . . . . . . 93

9.1 Supported Database Transfers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
9.2 Transfer Process Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
9.3 Transfer and Backup Requirements and Conditions . . . . . . . . . . 94
9.3.1 Operational Checks at the Source Machine . . . . . . . . . . . . . . . 94
9.3.2 Operational Checks at the Destination Machine . . . . . . . . . . . 95
viii Contents The System Manager’s Guide to ENVOXr Server and Control
Desktop
(Original — May 2000)

9.3.3 Disk Space Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

9.3.4 PDX File Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
9.3.5 Network Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
9.3.6 Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
9.4 Using the PDX Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
9.4.1 Windows Dialog Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
9.4.2 Command Line Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
9.4.3 Understanding Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
9.4.4 Creating a Database on the Destination Machine . . . . . . . . . . 100
9.5 Transferring PROFLEX Databases . . . . . . . . . . . . . . . . . . . . . . . . 101

10 Setting Up Audit Trail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

10.1 Event Tracking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
10.2 Event Recording Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
10.2.1 Audit Trail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
10.2.2 History Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
10.2.3 Field Update Recording . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
10.2.4 Ad Hoc Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
10.3 Event Failure Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
10.4 Setting Up and Maintaining the Audit Trail Facility . . . . . . . . . . . 107
10.5 Archiving the Audit Trail Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
10.6 Truncating the Audit Trail Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

11 Database Management Utilities and Other Help . . . . . . . 111

11.1 Clearing a Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
11.2 Database “House-Keeping” . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
11.3 Getting Help with Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
11.4 Printer Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

12 Tuning the System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

12.1 Factors Affecting Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
12.2 Memory Allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
12.3 Tuning Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
12.4 Extending the Tempdb Database . . . . . . . . . . . . . . . . . . . . . . . . . . 120

13 Managing Transaction Logs . . . . . . . . . . . . . . . . . . . . . . . . . 123

13.1 Manual Dumping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
13.2 Automatic Dumping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
13.3 Dump Methods for ENVOX Server Databases . . . . . . . . . . . . . . . 124
13.4 Recovering from Memory Fill-up . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

14 ISQL Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

14.1 Logging into ISQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
14.2 Restricted Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
14.3 Permitted Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
14.4 Viewing Database Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
The System Manager’s Guide to ENVOXr Server and Control Contents ix
Desktop
(Original — May 2000)

14.5 Accessing Current and Other Databases . . . . . . . . . . . . . . . . . . . 130

14.6 ISQL Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
14.7 Example ISQL Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
14.7.1 Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
14.7.2 Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
14.7.3 Example 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
14.8 Modifying Database Items through ISQL . . . . . . . . . . . . . . . . . . . 134
14.9 Creating Tag Sets through ISQL . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
14.10 Using System Command Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

A Parameters Updateable from ISQL . . . . . . . . . . . . . . . . . . . 137

B Command Line Executables . . . . . . . . . . . . . . . . . . . . . . . . . 155

B.1 Available Administrative Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
B.1.1 Add ENVOX User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
B.1.2 Rename Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
B.1.3 Upgrade Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
B.1.4 Clear Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
B.1.5 Create ENVOX Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
B.1.6 Dump Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
B.1.7 Load Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
B.1.8 Transfer a Database with PDX . . . . . . . . . . . . . . . . . . . . . . . . . . 159
B.1.9 Downloading a Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
B.1.10 Downloading from an Emergency Download File . . . . . . . . . . 161
B.1.11 Check Database Consistency . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
B.1.12 Generate Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
B.1.13 HART Instrument Locator Tool (HILT) . . . . . . . . . . . . . . . . . . . . 164
B.1.14 Import Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
B.1.15 Import ASCII FST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
B.1.16 Export Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
B.1.17 Load ENVOX SQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
B.1.18 Populate HACL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
B.1.19 Populate NT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
B.2 Command Line Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
B.3 Understanding Switches and Parameters . . . . . . . . . . . . . . . . . . . 170
B.3.1 Command Line Switch Format . . . . . . . . . . . . . . . . . . . . . . . . . . 170
B.3.2 Command Line Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
B.3.3 Defining Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

C System Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

C.1 Architecture Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
C.2 Types of Daemons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
C.2.1 Client Task Daemon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
C.2.2 Server Task Daemon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
C.2.3 CHIP Daemons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
x Contents The System Manager’s Guide to ENVOXr Server and Control
Desktop
(Original — May 2000)

History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
The System Manager’s Guide to ENVOXr Server and Control Contents xi
Desktop
(Original — May 2000)

Figures
Figure 2-1. Server Administration Window . . . . . . . . . . . . . . . . . . . . . . . . . 25
Figure 2-2. Menu Selections for ENVOX Server Administration . . . . . . 26
Figure 2-3. Client Administration Window . . . . . . . . . . . . . . . . . . . . . . . . . 27
Figure 2-4. Menu Selections for Client Administration . . . . . . . . . . . . . . . 28
Figure 4-1. User Role Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Figure 4-2. Items Editing Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Figure 4-3. Matrix Access Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Figure 4-4. View Access Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Figure 5-1. Server Setup Dialog Window . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Figure 5-2. Server Login Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Figure 5-3. Set Client task Daemon Dialog . . . . . . . . . . . . . . . . . . . . . . . . 53
Figure 6-1. Attributes Tab on the Database Property Sheet . . . . . . . . . . 56
Figure 6-2. Logical Devices Tab on the Database Property Sheet . . . . 57
Figure 6-3. Space Used Tab on the Database Property Sheet . . . . . . . 58
Figure 6-4. Attributes Tab on the New Database Dialog . . . . . . . . . . . . . 60
Figure 6-5. Logical Devices Tab on the New Database Dialog . . . . . . . 61
Figure 6-6. Copy Database Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Figure 6-7. Rename Database Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Figure 6-8. Dialog for Setting Verify Mode to Off and On . . . . . . . . . . . . 65
Figure 7-1. Dialog for Adding a Logical Device . . . . . . . . . . . . . . . . . . . . . 70
Figure 7-2. Logical Device Attributes Window . . . . . . . . . . . . . . . . . . . . . . 71
Figure 7-3. Database Usage Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Figure 8-1. Sample Script File For DBCC checks of User
Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Figure 8-2. Sample Script File For DBCC checks of Master
Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Figure 8-3. Messages Displayed During the Dump Process . . . . . . . . . 85
Figure 8-4. Messages Displayed During the Load Process . . . . . . . . . . 88
Figure 9-1. Dump to PDX Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Figure 10-1. Audit Trail Option Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Figure 10-2. Audit Trail Tab on the Database Properties Sheet . . . . . . . . 107
Figure 10-3. Archive Log Up To Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Figure 10-4. Truncate Log Before Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Figure 14-1. Example Output from Help Command . . . . . . . . . . . . . . . . . . 131
Figure 14-2. Example SQL Query for Returning Engineering Unit and
Alarm Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Figure 14-3. Example of an SQL Query for Returning Some Data
for AI Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Figure 14-4. Example of an NT Command File . . . . . . . . . . . . . . . . . . . . . . 136
Figure C-1. ENVOX Server P5.0 and Control Desktop
P5.0 Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
xii Contents The System Manager’s Guide to ENVOXr Server and Control
Desktop
(Original — May 2000)

Tables
Table 1-1. Type Style Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Table A-1. Parameters Updateable From ISQL . . . . . . . . . . . . . . . . . . . . 137
 Introduction F Section 1 13

Figure 1-Table 1

1
1

1 Introduction
This system manager’s guide describes how to use the system
administration features in Type SW3159 ENVOXr Server, version P5.0
and Type SW3311 Control Desktop, version P5.0. Control Desktop is the
user interface and client to ENVOX server.

With the administration features, the system administrator can perform

day to day system maintenance, tailor ENVOX Server and Control
Desktop to each user and plant site, and structure the system to support
multiple users and multiple databases.

1.1 Intended Audience

This manual is intended for persons generally considered to be expert
users. They must be familiar with the ENVOX configuration system and
its Control Desktop user interface, the SYBASE dataserver system, and
the NT operating system.

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 system administration functions. The way to actually
perform a function is contained in the online help which is accessible
from various help buttons in the administration 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.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 14 Section 1 F Introduction

1.4 First Release for Windows NT

1 ENVOX Server P5.0 is the first release of ENVOX server for the
Windows NT platform. This release runs only on the Windows NT
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 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.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Introduction F Section 1 15

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

This manual contains the following sections and appendixes:

Section 1 — Introduction: provides general information about this

manual, the intended user, new features in the product, stylistic
conventions used in the manual, and where to find further information.

Section 2 — Administration Overview: provides an overview of Client

and Server administration, definitions of key terms, certain limitations,
navigation information, and computer requirements.

Section 3 — System Security: describes ENVOX software security

features, types of accounts, how to protect your ENVOX databases, and
information on Security Area Tag Sets.

Section 4 — Setting User Privileges: describes the administration

functions for controlling user access to ENVOX databases.

Section 5 — Administering Servers: describes stopping and starting

servers, administration functions for setting up and maintaining the
ENVOX server, and viewing server processes and SYBASE locks.

Section 6 — Administering Databases: describes the administration

functions for setting up and maintaining configuration databases, using
verify mode, and viewing database information and application locks.

Section 7 — Administering Logical Devices: describes how to match

your logical devices to your operating needs.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 16 Section 1 F Introduction

Section 8 — Administering Database Backup and Recovery:

describes how to backup a database to a dump device or recover a
database, and describes backup and recovery troubleshooting
1 procedures.

Section 9 — Using PDX to Transfer and Backup Databases:

describes how to transfer databases between computer platforms using
the Portable Database Transfer (PDX) Utility.

Section 10 — Setting Up Audit Trail: describes how to establish an

audit trail of changes to databases, and how to maintain the audit trail
facility.

Section 11 — Database Management Utilities and Other Help:

describes how to use Clear Database and Housekeeping utilities, and
provides information about additional helps, such as changing the
default printer.

Section 12 — Tuning the System: describes how to tune a system to

improve ENVOX system performance.

Section 13 — Managing Transaction Logs: describes recommended

methods for managing the transaction logs used in ENVOX software.

Section 14 — ISQL Interface: provides guidelines for using the ISQL

interface.

Appendix A — Parameters Updateable from ISQL: provides a table of

parameters which you can update by using ISQL.

Appendix B — Command Line Executables: lists the NT commands

which you can use to perform administration functions. These commands
are also listed with descriptions of their functions throughout this manual.

Appendix C — System Architecture: provides an overview of the

ENVOX Server and Control Desktop architecture and the use of
daemons for running on the NT Windows platform.

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

Control Desktop and ENVOX software.

Glossary — provides definitions of terms used in this manual.

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

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Introduction F Section 1 17

1.7 Conventions Used in This Manual

The following conventions are used in this manual: 1
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
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

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.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 18 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)

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Introduction F Section 1 19

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 1
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
equipment, interruption of normal software operation, or cause
a long term health hazard.

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

1.9 ENVOX Server and Control Desktop Documents

Documents available for ENVOX Server and Control Desktop, version
P5.0, include:

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

— May 2000) describes system requirements and provides
instructions for installing ENVOX Server and Control Desktop on an
IBM-compatible personal computer running an NT4.0 operating
system.

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

(Original — May 2000) provides information for starting up and using
ENVOX server and Control Desktop to configure PROVOXr system
databases.

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

describes how to use Control Designer to configure your SR90 and
SRx controllers.

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

describes how to use Display Designer to configure your PROVUEr
and Operator Workplace operator interface displays.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 20 Section 1 F Introduction

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
1 and changing this data. The manual also defines the ASCII format
(CDV format) used to import data into the ENVOX configuration
database.

J The System Manager’s Guide to ENVOX Server and Control

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

J Online help describes the menu options, forms, and each field on the
forms, and provide navigation help. Online help is embedded in
ENVOX Server and Control Desktop.

J Online books are PDF files of the paper manuals listed above. The
files are page-true to the printed manuals, and can be read with
Adobe Acrobat Reader. Both the files and the reader are included
with ENVOX Server and Control Desktop.

J Configuration engineering manuals describe the functions of the

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

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

1.10 Related Documents

Other PROVOX documents which may be helpful are listed below. See
your Fisher-Rosemount Systems sales representative or office for
copies.

J Installing Type DH6212 Computer/Highway Interface Package (CHIP

NT) Software (PN3.1:DH6212)

J Configuring the Computer/Highway Interface Packages (CHIPs)

(CE8.0:DH6200)

J Using DH6200-Series Computer/Highway Interface Package (CHIP)

(UM14:0:DH6200)

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Introduction F Section 1 21

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.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 22 Section 1 F Introduction

Blank page.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administration Overview F Section 2 23

Figure 2-Table 1

2 2 Administration Overview
Administrative functions are available through two administration
2

facilities: ENVOXr Server and Control Desktop Client. Each facility

provides the administration functions appropriate for the type of work
done.

J ENVOX Server administration allows the creation and administration

of all databases, logical devices, servers, and users in the
configuration system.

J Client Administrating is subset of Server Administration and allows

administration of particular databases.

2.1 Login Types

The administration of ENVOX Server and Control Desktop is governed
by the three types of logins that are available. These are:

J The ’sa’ login. Any user who knows the ’sa’ password can log in as a
system administrator, and can access the ENVOX Server
Administration utility, in order to create and maintain all ENVOX
databases, and all user logins. Therefore, the system administrator
has control over which users can access which databases, and what
their privileges are.

J The ’project administrator’ login. Users with this login can access the
Client Administration utility in order to maintain databases they are
assigned access to, and control access to these databases by
project engineers.

J The ’project engineer’ can use Control Desktop client applications,

modules, and utilities, as determined by their login. Project engineers
cannot access Client Administration.

2.2 Starting Control Desktop and ENVOX Server

Instructions for starting Control Desktop and ENVOX Server, including
initial passwords are given in the manual, Using ENVOX Server and
Control Desktop, UM:SW3159:EN (Original — May 2000).

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 24 Section 2 F Administration Overview

2.3 Accessing Administration Functions

In this manual, administration functions are organized by task, not by
server or client administration. Most administration functions are
available through pull-down menus when you are navigating in Client
2 Administration or ENVOX Server Administration. Some server
administration functions can also be accessed through ISQL and
command lines, and a few can only be accessed through ISQL or
command lines.

In some cases, you can access administration functions with the right
mouse button. For example, when you have clicked on a database name
in the explorer, the right mouse button lets you select New, Properties,
Grant User Access, Dump to PDX, and Backup.

Whether through menus, the right mouse button, ISQL, or command

lines, this manual provides the information you need for the access
method used. As is the case with most current PC application programs,
functions are often accessible through various paths, but this manual
provides a consistent approach from the menu bar.

You can access administration functions anytime that Control Desktop is

running. Access is through the Control Desktop window by selecting
Admin on the window menu bar. The pop-down menu then lets you
choose Client Administration or Server Administration.

You can also access administration functions anytime directly through

the Start program menu on your NT desktop. Both Client Administration
and Server Administration open directly from the Start menu. In both
cases you are presented with a login dialog. For Client Administration
enter your login name and password. You will be allowed access only if
you have Project Administrator privilege. For Server Administration, you
must log in with the sa password.

2.4 ENVOX Server Administration

ENVOX Server Administration runs on a single SQL Server. Access is
through a system administration “sa” password. Only those users who
know the ’sa’ password can run server administration.

Server administration allows creation and maintenance of databases,

logical devices, dump devices, and logins. It also supports system
management functions such as backing up and restoring databases,
performing PDX transfers, checking database consistency, and dumping
transaction logs. Figure 2-1 shows the server administration window.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administration Overview F Section 2 25

Figure 2-1. Server Administration Window

Most of the functions available in server administrator are shown by the

menu selections illustrated in Figure 2-2. A few other functions are
available through ISQL and command lines, and are explained in
appropriate sections.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 26 Section 2 F Administration Overview

File Users Processes Databases Admin Window Help

New Show Users... Client and

ENVOX Server
Properties... Archive Log...
2 Copy... Truncate Log...
Administration
Menu Bar
Rename... Recalculate Space Used
Delete Show Disk Space Usage...
Close Load from PDX...
Save Dump to PDX...
Print Setup... Backup...
Print Recover...
Exit Check Consistency...
Dump Transaction Log

Grant User Access... Server Processes... Login...

Revoke User Access Sybase Locks... Disconnect
Change Password... Application Locks... Set Client Task Daemon...
Change Default Database

Figure 2-2. Menu Selections for ENVOX Server Administration

Only those selections which are applicable for a particular operation are
shown in black letters. Selections which are not applicable are “grayed
out”.

Navigation is always done through the Server Administration explorer

window and list view. Tab screens show the detail for currently selected
explorer items. To see the item detail, you can double-click on an item or
select the properties menu.

The initial role that Control Desktop users are assigned is determined by
their user privileges as created by server administration. Certain
privileges can be later re-assigned in Client Administration, as described
below.

Note ... Fisher-Rosemount Systems recommends that server

administration be run on the same machine that the SQL Server
resides on.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administration Overview F Section 2 27

2.5 Client Administration

Client administration, a subset of server administration, allows controlled
access to certain administration functions without having to use an “sa”
password. Figure 2-3 shows the client administration window.
2

Figure 2-3. Client Administration Window

The functions available in client administration are shown by the menu

selections illustrated in Figure 2-4.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 28 Section 2 F Administration Overview

File Users Processes Databases Admin Window Help

Save Show Users... Client and

Print Setup... Archive Log... ENVOX Server
2 Print Truncate Log...
Administration
Menu Bar
Refresh F5 Recalculate Space Used
Exit

Server Processes...
Grant User Access... Sybase Locks... Login...
Revoke User Access Application Locks... Disconnect

Figure 2-4. Menu Selections for Client Administration

2.6 Diagnostics Module Administration

The Diagnostics Module does not use the ENVOX configuration
database, so it normally applies to a different user and contains its own
administration functions. The system administrator for the Diagnostics
Module has the privilege to grant access to the diagnostics web site for
additional diagnostics users. These users can be granted additional
target device access, as required.

The diagnostics system administrator role is granted by supplying the

CDOS “ca” administrator account password on the diagnostics
administrator login Web page. It is possible to change the ca password
from the Diagnostics administrator Web pages. However, if CDOS needs
to be reinstalled, the ca password must be set back to its default.

Diagnostics administration is not described in this manual. See the

Diagnostics Module description in the manual, Using ENVOX Server and
Control Desktop, UM:SW3159:EN (Original — May 2000).

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administration Overview F Section 2 29

2.7 Database Property Sheet

A database property sheet lets you set various properties for each
database. The sheet appears as a dialog window with tabs. The tab
names indicate the properties you can set, and include:
2
J Attributes (Database Name and Creation Option)

J Logical Devices

J Audit Trail

J Verify Mode

J Space Used

These tabs and their use are described in appropriate sections in this
manual.

A database property sheet can be accessed through both client and

server administration. Since client administration is usually accomplished
per database, the property sheet appears in the client administration
window right-pane. In server administration, you select a database and
then the property sheet for that database can be accessed through the
menu bar at File --> Properties or with the right mouse button
(Properties).

2.8 Universal File Menu Choices

In the Control Desktop Client and ENVOX Server administration window,
the file menu selection in the menu bar contains the usual Save, Print
Setup, Print, and Exit choices. These are used in normal ways.

Anytime that you wish to save your work in any administration function,
choose Save. The Save selection includes saving the additions or
changes to a database. When you wish to print your work, choose Print
Setup or Print. The work is normally printed as shown on the screen
(depending on the printers ability to interpret it). Exit allows you to exit
the administration function.

2.9 Carefully Choosing File Names

Throughout this manual, instructions are given for naming database files.
Some names are reserved, such as master, tempdb, and various ISQL
reserved words. At other times, the nature of the operating system
commands restricts the use of certain names. Therefore, carefully
choose names which do not conflict with the instructions given.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 30 Section 2 F Administration Overview

2.10 Specifying File Location

Specifying the location of files that are created or read by ENVOX
applications, such as CDV files for Import and Export, and Emergency
Download files, is accomplished in the same way as for any file in a
2 Windows NT environment. Control Desktop is the user interface.

If the files are to be located on the same machine as the application, you
can use drive letters in the specified path. However, if the specified file
location is on a different machine, you must carefully specify the path to
ensure that the file becomes located where you wish it to be. If you use a
drive letter which is valid on the machine running the application, but the
file is to be located on another machine, the Client Task Daemon running
the desired program (such as Import or Export) may indicate that the
path is not valid or it may map to a different location than you intended.

For specifying files on different machines, it may be better to use the

Universal Naming Convention (UNC) approach. The best way to
determine a UNC is to use the Browse button to find the desired folder
path. The browser launched by the button is rooted at “My Computer”
and the window shows all of the drives you have mounted as well as
“Network Neighborhood”.

2.11 Product Media

Control Desktop and ENVOX Server are supplied on a CD-ROM, along
with ENVOX050, SYBPRELIM11, SYBASE11, and CDOS050. The
printed manuals for Control Desktop and ENVOX Server are included in
PDF format on the CD-ROM.

2.12 Product Compatibility

ENVOX P5.0, Control Desktop P5.0, and CDOS P5.0 are compatible.
Earlier versions of these products are not compatible with version P5.0.

2.13 Computer Requirements

Control Desktop and ENVOX Server require:

J A personal computer with an Intel Pentium CPU (200 MHz minimum)

J Microsoft Windows NT 4.0 operating system with Service Pack 4.0

or 6.0.

J At least 192 megabytes RAM

J At least 50 megabytes disk storage space

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administration Overview F Section 2 31

J VGA or better video display unit (VDU)

J CD-ROM device

J Network connection

Type DH6032 highway Data Link (HDL) to connect the personal

J
computer to the PROVOX highway system.
2

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 32 Section 2 F Administration Overview

Blank page.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 System Security F Section 3 33

Figure 3-Table 2

3 3 System Security
The security devices built into Control Desktop allow a system
3
administrator much freedom in controlling user access to the system.

3.1 Initial Passwords

When ENVOXr Server is installed, it creates the following initial user
names and passwords:

J A SYBASE dataserver login (username ENVOX, initial password

password) which can be used as the user name on the ENVOX login
screen

J A system administrator login (username sa, initial password

database)

Additionally, when the envox_readonly database is created, the admin

login is created. It has an alias of envoxutility.

3.2 Access by Accounts

Access to ENVOX Server P5.0 and Control Desktop P5.0 is through
Windows NT accounts and Control Desktop application accounts. These
accounts fall into four categories:

J ENVOX Daemon Account — a Windows NT account

J Machine User Accounts — Windows NT accounts

J Control Desktop User Account — a Control Desktop account

J Control Desktop Administration Accounts — Control Desktop

accounts

3.2.1 ENVOX Daemon Account

Control Desktop uses a set of services called the ENVOX Daemons to
run utilities such as Import, Export and PDX. These services may need
to read or write files on the local network. Hence, a Daemon service can

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 34 Section 3 F System Security

access the same set of local network files as any of the Control Desktop
users of an ENVOX server.

The ENVOX Daemon Account is created by the local network

administrator. The account details are normally entered on the ENVOX
Task Daemons property page during client and server installation. When
CHIP is installed on the ENVOX Server, the ENVOX Daemon account
details are used for the CHIP account details.
3
3.2.2 Machine User Accounts
Machine User Accounts allow an administrator with Windows NT
administrator privileges to install ENVOX Server and Control Desktop
P5.0 just once per workstation. As a result, the Control Desktop Start
menu launch icons are available to all valid Windows NT user accounts
on the specific PC. Therefore, multiple user accounts can access a
single copy of Control Desktop on each PC and each user account has
its own specific Control Desktop working area, and its own custom user
environment.

3.2.3 Control Desktop User Account

The Control Desktop User Account allows a Control Desktop user to log
into a workstation, use Control Desktop, and access any network file
services required by the configuration.

3.2.4 Administration Accounts

The Administration Accounts allow administrators to control user access

to specific Control Desktop modules and database capabilities.
Administration is divided into three areas:

J Client Administration

J ENVOX Server Administration

J Diagnostics Module Administration

Diagnostics Module Administration is described in the diagnostics

module section of user manual, Using ENVOX Server and Control
Desktop, UM:SW3159:EN (Original — May 2000).

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 System Security F Section 3 35

3.3 Administration Passwords

ENVOX Server and Control Desktop, version P5.0, administration is
separated as follows:

J Client Administration — allows administration of a particular ENVOX

database and the users of that database.

Users with a privilege of Project Administrator can access client 3

administration using their own login name and password. In addition,
all client administration functions are accessible to the system
administrator.

J ENVOX Server Administration — allows administration of all ENVOX

databases, logical devices, dump devices, and logins on a particular
server.

An “sa” password is required for access. By design, system

administrators cannot delete their own account. The system always
has at least one administrator.

3.4 Changing the sa Password

Caution ... It is highly recommended that you change the password to a

confidential one immediately following installation. The sa login
allows unrestricted access to the data in the database, and thus
a potential exists for damage to the data if the sa password is
not changed for this account.

Note ... The usernames, passwords, and commands are case sensitive.
Therefore, you must follow the upper and lower case
conventions shown in the steps below to change the sa
password.

You cannot change the system administrator, sa, password through

Control Desktop or ENVOX software; you must change it through
SYBASE ISQL commands.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 36 Section 3 F System Security

To change the password:

Step 1: Log in to ISQL at the command prompt:

isql -U sa -P database

The initial sa password is database.

The system responds with the ISQL prompt.

3 Step 2: At the ISQL prompt (1>), enter:

1> sp_password “database”, “new_password”

where database is the initial password, and new_password is

the new password which you wish to use.

3.5 Changing the envoxutility Password

You can change the initial envoxutility password and set a new
envoxutility password if one is unknown as described below.

3.5.1 Initial Change

The initial user name and password for the envoxutility is envoxutility for
both. You should change the password to one for ENVOX system
administration only. Change the password as follows:

Step 1: Enter the following at the command prompt:

isql -U envoxutility -P envoxutility

The system responds with the ISQL prompt.

Step 2: At the ISQL prompt (1>), enter:

1> sp_password “envoxutility”, “new_password”

where new_password is the new password which you wish to

use.

3.5.2 Unknown Password

You can change the envoxutility password if it is no longer known, as

follows:

Step 1: Enter ISQL as the sa user by entering:

isql -U sa -P sa_password

...where sa_password is your current sa password

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 System Security F Section 3 37

Step 2: At the ISQL prompt (1>), enter:

1> sp_password “sa_password”, “new_password”, envoxutility

...where sa_password is your current sa password and

new_password is the new password you wish for the
envoxutility.

3.6 Using Security Area Tag Sets 3

Security area tag sets are tag sets for which you define privileged access
for different devices in different configuration databases.

3.6.1 Creating Security Area Tag Sets

To create a security area tag set, you must have “Project Administrator”
privilege. You can then create security area tag sets in the same way
that you create other tag sets. For tag set information, see the User
manual listed in subsection 1.9. For the administrator, the Tag Set dialog
displays an extra field, allowing you to define and modify a security area.

In each security area tag set, you specify which devices you want users
to modify. You then assign one or more users to a security area.
Because the need to access devices varies among users, you probably
will create different tag sets to reflect the privileges of different users.

3.6.2 Assigning Security Area Tag Sets

Before enabling users to access, modify, download, document, (and so
on) various areas in each database, you must understand how these
functions affect the devices in each area. Allocating privileges must be
carefully considered because a user can indirectly affect other devices.

For example, changing the engineering unit range in a unit operations

controller (UOC) point can affect consoles and other UOCs to which that
point is targeted. If a user has the privilege to modify, generate, and
download the UOC and one targeted console, but does not have the
privilege to generate additional target devices, the user may no be able to
make the change.

If a change is not allowed, the system displays the following message (when
the user attempts to generate the UOC):

Cannot perform update — affects a privileged device.

If this message occurs, you will have to add the affected device(s) to the
user’s security area tag set.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 38 Section 3 F System Security

3.6.3 Assigning Global Item Security

You also must consider global item security. Global items [such as
discrete control device (DCD) templates, group templates, function
sequence tables (FSTs), and operations] are not tied to any one device.

For example, global items may be associated with no devices or with

several devices. If a DCD template is not associated with any DCD point,
any user can change the template. If several DCD points that are
3 sourced in multiple devices reference a DCD template, the user must
have privileges to access all of those devices before he or she can
change the DCD template.

A user can create his or her own version of the DCD template and
associate it with the DCD point. Then the user can change the template
without being restricted by security areas, as long as only points sourced
to devices in the users’ security areas use the template.

As another example, if a user sources an analog input (AI) point on a

UOC and targets it to a console and then changes its UOC database
index, the user must have both the UOC and the console in his or her
security area to generate the UOC because changing the point affects
the targeting console.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Setting User Privileges F Section 4 39

Figure 4-Table 3

4 4 Setting User Privileges

Through client administration, you control who uses the various
databases and what privileges they have. The selections include: 4
J Grant User Access

J Customizing User Access

J Revoke User Access

J Show Users

J Change User Password

4.1 Grant User Access

You can use Client Administration to give a user access to a database.
To give access, select the database from the Client Administration
Explorer, and then select Users --> Grant User Access. From the list of
users in the Grant User Access dialog box, select one or more users
then click the OK button. In Server Administration, you can give a user
access to a database by either selecting the Grant User Access menu
option or by dragging one or more logins onto the required database.
Note that you can drag and drop only in Server Administration.

Upon grant access, the user is added to the list of names for the
database. The default role for user is a Project Engineer with read-write
access. You can change this from the User Role tab. You can now set
up options for the user on a per-database basis.

Granting user access affects only the ability of a user to access the
configuration system. It does not affect the ability of a user to perform
other operations in the computer system or PROVOXr system which is
running ENVOXr Server and Control Desktop software.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 40 Section 4 F Setting User Privileges

4.2 Customize User Access

You can customize the level of access that a user has to database
operations through the user property sheet. The sheet appears as a
dialog window with tabs. The tab names indicate the properties you can
set, and include:

J User Role

J Item Editing
4 J Matrix Access

J View Access

The sheet is available through both Client Administration and Server

Administration. When you open a database in client administration to
display users, the user property sheet appears in the client
administration window right-pane when you select a particular user.

In server administration, you select a database. upon selection, the

database user’s names appear in the server administration window
right-pane. Either through the menu bar at File --> Properties or with the
right mouse button (Properties), you can access the property sheet for
the selected user.

Note ... The default mode for all options is enabled. Therefore, it is
important that you carefully consider the options you wish to
allow for each user. Uncheck a box to disable an option.

4.2.1 User Role

The User Role tab lets you:

J Specify a role for the user — Project Administrator or Project

Engineer. See the definitions in the Glossary. Default is Project
Engineer.

J Specify the level of access that a user has to the configuration

database (read-write or read-only)

J Specify a security area tag set on the User Role tab, you can restrict
a user to performing these functions only on a specified list of
devices in a particular configuration database. See subsection 3.6 for
details on how to create and use security area tag sets.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Setting User Privileges F Section 4 41

Figure 4-1 illustrates the User Role tab.

Figure 4-1. User Role Tab

4.2.2 Item Editing

The Item Editing tab lets you control the level of modifications that can
be made by the user which has been assigned read-write access. Item
editing includes:

J Specify item edit operations

j Copy

j Rename

j Delete

J Specify the privileges available to a user in the explorer

j Copy Items

j Copy I/O

j Delete Items

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 42 Section 4 F Setting User Privileges

j Delete I/O

j Move Points

j Move I/O

j Target To

j Drag and Drop

Figure 4-2 illustrates the Items Editing tab.

Figure 4-2. Items Editing Tab

4.2.3 Matrix Access

The Matrix Access tab lets you control the operations which a user can
perform on Matrix views:

J Point matrixes

J IST matrix

J Target matrixes

J Excel matrix

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Setting User Privileges F Section 4 43

Figure 4-3 illustrates the Matrix Access tab.

Figure 4-3. Matrix Access Tab

4.2.4 View Access

The View Access tab allows you to control the operations which a user
can perform on a database. Selectable operations include:

J Generate

J Download

J Upload

J Import

J Export

J Device Upgrade

J Control Designer

J Standard Report Writer

J Custom Report Writer

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 44 Section 4 F Setting User Privileges

J Display Designer

J LCP Trace/Tune

Figure 4-4 illustrates the View Access tab.

Figure 4-4. View Access Tab

4.3 Revoke User Access

You can use Client Administration to prevent a specific user from having
access to a database. To deny access, you select the database from the
Client Administration Explorer, and then select the user name. From the
Admin menu, select Users --> Revoke User Access. The choice must
be confirmed.

In the same way, you can revoke a users access from Server
Administration. It is not possible for a user to revoke their own access.
This ensures that there is always at least one user who has access.

Revoking user access affects only the ability of a user to access the
configuration system. It does not affect the ability of a user to perform
other operations in the computer system or PROVOXr system which is
running Control Desktop and ENVOX software.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Setting User Privileges F Section 4 45

4.4 Show Users

You can use Client Administration to show a list of the other users
currently logged in to the server and which applications they are using. If
other users are logged in, and they are valid users of the database you
are using, you cannot save changes to the audit trail options.

To show the user list, select Databases --> Show Users. The list of
users is displayed in the Server Users dialog box. From this dialog box,
you can update the list of users by clicking on Refresh.
4
In Server Administration, you must have an ENVOX database selected
before you can select the Databases --> Show Users menu option. The
list of users displayed will be all users who are logged onto the server
and are valid users of the selected database.

You can allow access to a database for any user who has a valid login to
the server.

4.5 Change User Password

Users may change their Control Desktop login password at anytime from
the Control Desktop window by selecting Admin --> Change Password.
The Change Password dialog is displayed.

A password can consist of alpha and numeric characters, and can be

from 6 to 30 characters. Passwords are case sensitive.

If the need arises for the system administrator to change a user

password (for instance, the user has forgotten the password), go to the
Server Administration explorer, and select the login. Then, select Users
--> Change Password.

The Change Password dialog opens. Type the New Password and
then re-enter it in the Confirm New Password field. Click OK. The
password is changed.

4.6 Change Default Database

You may wish to change a user’s default database. To do so, you can
change it through either a menu bar selection or a right-mouse button
menu selection.

To change it from the menu bar, select Users --> Change Default
Database. To change it from the right-mouse button, highlight the login
name and then press the right mouse-button. When the menu appears,
select Change Default Database. From either method, a dialog
appears. Type the name of the desired database into the name field, and
click OK.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 46 Section 4 F Setting User Privileges

Blank page.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Servers F Section 5 47

Figure 5-Table 4

5 5 Administering Servers
Many administration functions can be performed on servers to tailor their
operation to your process requirements as described below.

5.1 Viewing Server Information

5
Through Server Administration, you can view several types of server
information.

5.1.1 Show Current Users

You can view a list of other users currently logged into the server who
are valid users of the ENVOXr database currently highlighted, and which
applications they are using. If there are other users logged into the
server who are valid users of the current database, you cannot save
changes to the audit trail options.

To show the user list, first highlight the database you are interested in,
and then select Databases --> Show Users.

Server Administration displays the list of users in the Server Users dialog
box. From this dialog box, you can update the list of users by clicking
Refresh. To close the dialog box, click OK.

5.1.2 View Server Processes

From the Processes menu option, you can view information about the
processes running on the server. The processes are listed in process
number order, and information such as the user name, database, and
hostname is shown for each process. To view the information, select
Processes --> Server Processes.

5.1.3 View Application Locks

From the Processes menu option, you can view the Control Desktop
application locks held on the ENVOX tables for a selected database.
Application locks are made when Control Desktop puts a lock on an item

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 48 Section 5 F Administering Servers

so that only one copy can be changed at once (for example, when
modifying a tag).

To view application locks, you must have a database selected in the

explorer before you can select the Application Locks menu option. To
view these locks, select Processes --> Application Locks.

5.1.4 View SYBASE Locks

From the Processes menu option, you can view the SYBASE locks held
on SYBASE tables on a server. SYBASE locks are made when
processes, such as item copies and item generates, are started that use
SYBASE tables. To view these locks, select Processes --> Sybase
5 Locks.

5.2 Stopping and Starting Servers

During Server Administration, it is occasionally necessary to stop and
start the SYBASE server, the backup server, and the CDOS open server.
The procedure described below should be used to stop and start any of
these severs.

It is recommended to stop the SYBASE server before you turn off power
to the server. This action ensures that any database changes currently
held in memory or the transaction log are written to the main database
file. This reduces the time it takes to restart the SYBASE server when
you reboot the server. Normally, the SYBASE server is started as part of
a system startup.

Note ... Stopping the SYBASE server loses all work that has not been
saved. Make sure no one is using the SYBASE server before
stopping it.

If the Server machine is shut down without using the following

procedure, then the databases are recovered using data in the
transaction logs stored to disk. This may take up to five minutes
per database before the server is again available for normal
use.

To stop or start the SYBASE server, backup server, or CDOS open

server, use NT Services. Go to the Control Panel and select Services.
In the dialog box, select the server which your want to stop or start, and
then click on the Start or Stop button as appropriate.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Servers F Section 5 49

You can use the following SQL commands to ensure that no one is using
the server and that there are no backups in progress before shutting
down CDOS and the Sybase servers.

Step 1: Ensure that no one is using the Sybase server using the
sp_who command.
1> sp_who

2> go

fid spid status loginame origname hostname blk ...

dbname cmd
------ ------ ------------ ------------ ------------ ---------- ----...
0
0
1
2
running
sleeping
sa
NULL
sa
NULL
WinNT 0
0 5
0 3 sleeping NULL NULL 0
0 4 sleeping NULL NULL 0
0 5 sleeping NULL NULL 0
0 6 sleeping NULL NULL 0
0 7 sleeping NULL NULL 0
0 8 recv sleep admin admin BANQUO 0
0 9 recv sleep admin admin BANQUO 0

Step 2: Ensure that there are no backup operations currently being

run on the backup server.

To see the activity on your Backup Server before executing a

shutdown command, run sp_who on the Backup Server:
> SYB_BACKUP...sp_who

spid status loginame hostname blk cmd

------ -------- -------- ---------- --- ----------------
1 sleeping NULL NULL 0 CONNECT HANDLER
2 sleeping NULL NULL 0 DEFERRED HANDLER
3 runnable NULL NULL 0 SCHEDULER
4 runnable NULL NULL 0 SITE HANDLER
5 running sa heliotrope 0 NULL

Step 3: Select Start --> Control Panel --> Services to display the
Services dialog box.

Step 4: Highlight the CDOS server (”ENVOX CDOS Server”) and click
on Stop to shut it down.

Step 5: Highlight the Sybase server (”Sybase SQL

Server_<servername>”) and click on Stop to shut it down.

Step 6: Highlight the Sybase Backup server (”Sybase SQL

Server_<servername>_BS”) and click on Stop to shut it
down.

The server workstation can now be shut down.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 50 Section 5 F Administering Servers

5.3 Server Options

When you install Control Desktop Client and Server, at least one
SYBASE server and one CDOS server is defined. Subsequently, you
can add SYBASE servers, change a server and change its address,
delete a server, change server logins, check information, and so forth.

Figure 5-1 illustrates a server setup dialog window showing a typical

server setup.

Figure 5-1. Server Setup Dialog Window

5.3.1 Connection and Network Information

Whatever server operation you are performing, the connection and
network information must be in the format:

J Node name, port number (for connection information)

OR

J TCP/IP address, port number (for network address)

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Servers F Section 5 51

In either case, the information must match that of the interfaces file on
the server.

The port number must be in the range of 1025 through 65535. It is usual
to use 2025 for a SYBASE server and 7010 for a CDOS server. If you
use a nodename, make sure that it is the real network machine name
and not an alias. If you use an alias, Control Desktop may not work.

5.3.2 Add a Server

All of the servers which you have defined are listed in the Server
Definition list. To add another server, fill in the server name in the Server
Name field and the network connection information in the Connection
Information/Network Address field. 5
Server names can be 11 characters and must be a valid SYBASE
identifier. Once the new server and its address have been added, click
on the Add Server button. When you add a new server, it is listed in the
Server Definition list, and it becomes the currently-selected server.

5.3.3 Change a Server or Its Address

You can change a server name or its address. In the Server Definition
list, click on the server that you wish to modify. Selecting the name will
display its details in the Server Name and Connection Information/
Network Address fields. Modify the details, and then click the Update
Server button to update the name and address.

If you have changed the server name, the change also appears in the
appropriate CDOS Open Server or Default SYBASE Server field
drop-down boxes. However, the change does not affect the currently
selected default servers.

5.3.4 Delete Server

To delete a server, click on the name of the server that you wish to delete
in the Server Definition list . Then, click on the Delete Server button. A
pop-up dialog appears asking for a confirmation. If you delete the CDOS
Open Server or the Default SYBASE Server, the corresponding fields
become blank.

5.3.5 Validate the Network

To validate network information or a network address, you enter the

network address or node name and port number in the Connection
Information/Network Address field, and Ping the network. A message
appears indicating whether the address was contacted successfully.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 52 Section 5 F Administering Servers

The server definitions you type must match those defined by the CDOS
Open server(s). You can make sure that the server definitions are correct
by logging on to the server machine, and reviewing the information in the
interfaces file.

5.3.6 Create a Server Login

You need to create a user server login before you can grant a user
access to any databases on that server. To create a server login, go to
the root directory in the Server Administration explorer, and select
Logins. In the right-pane, select a user and then select File --> New. The
Server Login dialog opens (see Figure 5-2).
5

Figure 5-2. Server Login Window

In the dialog, enter a unique Login Name and a Password, and then
select a database to which you want the user to have access. Finally,
click OK to save the details and close the dialog.

5.3.7 Delete a Server Login

Note ... Be certain that you want to delete the user’s server login before
carrying this operation out and that the user is not currently
logged in. Also, make sure you delete the correct server login.

To delete a user’s server login, go to the root directory of the Server

Administration explorer, and select the user in the Logins category. Then,
select File --> Delete. The confirmation message is displayed. Finally,
click OK. The user’s server login is deleted. When a server login is
deleted, the user is also removed from all databases on the server to
which the user was granted access.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Servers F Section 5 53

5.4 Setting the Client Task Daemon

The Client Task Daemon is responsible for running tasks such as
Verify/Generate, Rename, ASCII FST Import, PDX, and Import and
Export. During installation, the Client Task Daemon is installed on the
workstation. This placement is usually acceptable.

However, under some circumstances, such as if the workstation has a

very low specification and a server has a very high specification, you
may want to run the Client Task Daemon on a server. It can also be run
on a different machine altogether, providing the machine is in the
domain.

To set a client task daemon to run on a different machine for the

5
workstation:

Step 1: In the Server Administration explorer, select the database.

Step 2: Select Databases --> Set Client Task Daemon. The Set
Client Task Daemon dialog box opens (Figure 5-3).

Figure 5-3. Set Client task Daemon Dialog

Step 3: Enter the server Computer Name on which you want to run
the Client Task Daemon.

Step 4: Click OK. The Client Task Daemon is reset for this workstation
to run on the selected machine.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 54 Section 5 F Administering Servers

5.5 Infrequently Used Functions

For release P5.0, the following infrequently used functions are not
included and can be executed through ISQL:

J Change Server Name

J Shutdown Server

J Kill Process

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Databases F Section 6 55

Figure 6-Table 5

6 6 Administering Databases
Many administration functions can be performed on databases to tailor
their operation to your process requirements. You can view, add, copy,
rename, and delete existing databases. You can also modify database
attributes such as logical device usage and audit trail options once a
database has been created.
6
6.1 View Database Information
You can view information about the database attributes (database name
and creation option), logical devices running on a database, and
information about the amount of space the database is using.

To view the information, go to the Client Administration explorer, and

select the database. Then, from the Database Property Sheet
(right-hand pane of the explorer window), select the appropriate tab.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 56 Section 6 F Administering Databases

6.1.1 Database Attributes Information

The default tab view is the Attributes tab. This tab shows the database
name and creation option (Configuration, For Load, and For PDX Load).
See Figure 6-1.

Figure 6-1. Attributes Tab on the Database Property Sheet

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Databases F Section 6 57

6.1.2 Logical Device Information

To display information about the logical devices running on the database,

select the Logical Devices tab (Figure 6-2).

Figure 6-2. Logical Devices Tab on the Database Property Sheet

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 58 Section 6 F Administering Databases

6.1.3 Space Used Information

To display information about the amount of space the database is using,

select the Space Used tab (Figure 6-3).

Figure 6-3. Space Used Tab on the Database Property Sheet

You can update the information on the Space Used tab by selecting
Databases --> Recalculate Space Used.

The other tabs are explained in appropriate sections. See Section 7 for
information about setting up Logical Devices, subsection 6.8 for
information about Verify Mode, and Section 10 for information about
Audit Trail.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Databases F Section 6 59

6.2 Automatically Created Databases

Six databases are created automatically at installation. Two of the
databases are created automatically when you install ENVOXr Server
and Control Desktop software. The other four are created when SYBASE
is installed.

The two databases created when ENVOX Server and Control Desktop
are installed include:

J envox_readonly

This database contains reference data which is used by all of the

ENVOX user databases, including ENVOXDB and any other
configuration databases you may add. Its size is 10 Mb.

J ENVOXDB
6
This database is the initial ENVOX database. This database may be
the only one you need. However, you can create additional ENVOX
databases. Its size is variable, above about 130 Mb.

The four databases created when SYBASE is installed include:

J Master

This database is the central database which holds details of all of the
other databases. Its size is 20 Mb.

J Sybsystemprocs

This database is a SYBASE SYSTEM11 database, and contains all

of the stored procedures previously held in the Master database. Its
size is 60 Mb.

J Model

This database is the database used as the basis for a new database.
Its size is 2 Mb.

J Tempdb

This database is the database in which all temporary tables are

created. Its size is 37 Mb.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 60 Section 6 F Administering Databases

6.3 Add a Database

To create additional databases, go to the Server Administration explorer,
and select Databases. Then, select File --> New.

Follow the instructions in system administration online help. Figure 6-4

shows the dialog window for adding a database. The Attributes tab lets
you name the database and select the type of database you wish to add.

Figure 6-4. Attributes Tab on the New Database Dialog

Figure 6-5 shows the Logical Devices tab in the New Database dialog. If
there is not enough free space available, you will need to exit from the
dialog and create the necessary logical device. Then, you can return to
this dialog and add the database.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Databases F Section 6 61

Figure 6-5. Logical Devices Tab on the New Database Dialog

Creating a Configuration database may take some time; for instance,

about forty minutes. After creating a new database, it is recommended
that you check its integrity and back it up.

6.4 Copy a Database

You can create a new database that is a copy of an existing one. When
you choose to copy a database, Server Administration actually performs
a dump of the first database immediately followed by a load into the new
database.

To copy a database, go to the Server Administration explorer, and select

the database which you want to copy. Then, select File --> Copy. The
Copy Database dialog opens (Figure 6-6).

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 62 Section 6 F Administering Databases

Figure 6-6. Copy Database Dialog

On the Attributes tab, select the database to be copied From Database

field, and enter the name of the new database in the To Database field.

On the Logical Devices tab, specify the size and usage of the logical
device in which a new database is to be created. At the bottom of the
Logical Devices tab, a field shows the minimum space required in the
destination database.

Click OK in the Attributes tab to create the new database based on the
one you selected.

6.5 Rename a Database

When renaming a database, make sure that the database is not
currently in use and that the name you choose has not been used
already. You cannot rename the databases: envox_readonly, Master,
Sybsystemprocs, Model, and Tempdb. Also, you cannot choose as the
new name: envox_readonly, Master, Sybsystemprocs, Model, Tempdb,
any Transact-isql reserved word, or a database name that already exists.

To rename a database, go to the Server Administration explorer, and

select the database. Then select File --> Rename. The Rename
Database dialog opens (Figure 6-7). Select the name of the database
you wish to rename in the From database field, and then enter the
database’s new name in the To field. Click OK. The database is
renamed.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Databases F Section 6 63

Figure 6-7. Rename Database Dialog

6.6 Delete a Database 6

With this option, you can delete ENVOX configuration databases only.
You cannot delete others.

Caution ... Be certain that you want to delete the database before carrying
this out, and make sure you delete the correct database.
Deleted databases cannot be recovered.

To delete a database, go to the Server Administration explorer, and

select the database. Then, select File --> Delete. The confirmation
message is displayed. Finally, click OK. The database is deleted.

6.7 Special Considerations for Multiple Database

Segments
When you add a database with multiple data and log segments, all of the
data segments are added first, followed by the addition of the log
segments. If a dump of another database is loaded into a new
destination database, each segment of the new database must be of the
same order, size, and type as the source database. However, for a PDX
load of another database, the order of the segments of the new
database is not significant; they may be in any order.

Because of these constraints, you may not be able to create the

destination database completely. Instead, you can create the database
with the first data and log segments, and then modify the database as
many times as necessary to add each additional segment, one at a time.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 64 Section 6 F Administering Databases

For example, a source database has the following structure:

100 Mb Data on ENVOX_DEV1

10 Mb Log on ENVOX_DEV2
30 Mb Data on ENVOX_DEV3
4 Mb Log on ENVOX_DEV4

Creating a new database by using the Add Database procedure, and

adding the four segments results in the following structure:

100 Mb Data on NEW_DEV1

30 Mb Data on NEW_DEV2
10 Mb Log on NEW_DEV3
4 Mb Log on NEW_DEV4

To obtain the correct structure, create the database for the first two
6 segments, as shown:

100 Mb Data on NEW_DEV1

10 Mb Log on NEW_DEV3

When you load a database into another database, the database

segments must be of the same order, size, and type on the destination
database as they are on the source database. When modifying a
destination database to match a source database, add only one
segment at a time. This procedure ensures that each segment is added
in the correct order.

6.8 Using Verify Mode

An ENVOX database is initially created with the Verify Mode set to ON.
You can improve performance during a bulk data entry phase (for
example, when importing from a PROFLEXr database or from full data
of new configuration devices) by setting Verify Mode to OFF.

The Verify Mode tab is used to set verify mode on and off. This tab
appears as part of the database property sheet in both Client
Administration and ENVOX Administration.

When you attempt to make a switch, a dialog appears asking for

confirmation: Yes or No. Click on the Yes or No button. Also in the dialog
is a help button, providing further description.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Databases F Section 6 65

Caution ... Before you switch Verify Mode to OFF, carefully consider the
actions of Verify Mode on your operation when Verify Mode is
switched ON. When it is switched ON, the next generation of
each device in the database will be total verify/generate of the
device, and that after the generation, the next download of the
device will be a total download.

Figure 6-8 shows the Database Property Sheet dialog with the Verify
Mode tab, used to set Verify Mode to OFF and ON.

Figure 6-8. Dialog for Setting Verify Mode to Off and On

6.8.1 Setting Verify Mode to OFF

Certain ENVOX activities are suspended when verify mode is set to OFF,
generation of any device in the database cannot be performed and the
security area tag checking of devices affected by database changes is
not performed.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 66 Section 6 F Administering Databases

The system responds as follows when changing Verify Mode mode from
ON to OFF:

J If the Verify Mode change is attempted when a device generate is in

progress, the Verify Mode change is rejected, and an error message
is displayed.

J If the Verify Mode change is attempted when a Device Delete of any

device type or a Copy Device of a PROVUEr, CHIP, or Trend device
with target data is in progress, the Verify Mode change is rejected,
and an error message is displayed.

J If the Verify Mode change is attempted when a Rename Tag is in

progress, the Verify Mode change is rejected and an error message
is displayed.

6 J If the Verify Mode change is attempted when a database save is in

progress, the Verify Mode change waits until the current database
save is completed before taking action.

J If a device generate is attempted when a Verify Mode change is in

progress, the generate waits until the Verify Mode change is
completed, and then aborts. An explanatory message is displayed.

J If a database save is attempted when the Verify Mode change is in

progress, the database save waits until the Verify Mode change is
completed before taking action.

A generation that is attempted from a command line when the Verify

Mode is OFF results in the generation being aborted, in much the same
manner as it is aborted due to functions such as Rename Tag being in
progress. An explanatory message is displayed.

A generation that is attempted when the Verify Mode is being changed

from OFF to ON results in the generation being aborted. An explanatory
message is displayed.

6.8.2 Setting Verify Mode to ON

When verify mode is set to ON, any changes to items in the database
are flagged to show that the changed item needs to be verified and
regenerated.

Caution ... When Verify Mode is switched ON, the next generation of each
device in the database will be total verify/generate of the
device, and that after the generation, the next download of the
device will be a total download.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Databases F Section 6 67

When Verify Mode is set to ON, a check is made that no Rename Tag,
Device Delete, or Copy Device with target data operation is in progress.
Depending on the situation, messages appear as described below:

J If any of these operations are in progress, an appropriate message

for the operation is displayed. You can attempt to change verify mode
later.

J If none of these operations is in progress as each device in the

database is handled, a confirming message is displayed.

J If all devices are successfully handled, a confirming message is

displayed.

J If any device does not complete successfully, a change-failed

message is displayed. No further devices are processed.

The system responds as follows when changing Verify Mode from OFF 6
to ON:

J If the Verify Mode change is attempted when Rename Tag is in

progress, the Verify Mode change is rejected and an error message
is displayed.

J If the Verify Mode change is attempted when Device Delete of any

device type or a Copy Device of a PROVUE, CHIP, or Trend device
with target data is in progress, the Verify Mode change is rejected
and an error message is displayed.

J If the Verify Mode change is attempted when a database save is in

progress, the Verify Mode change waits until the current database
save has completed before the mode change occurs.

J If a database save, Device Delete or Copy is attempted when the

Verify Mode change is in progress, the database save is rejected and
an error message is displayed.

J If a Rename Tag is attempted when the Verify Mode change is in

progress, the Rename tag is rejected and an error message is
displayed.

The action of changing Verify Mode from OFF to ON takes some time
because the control tables for verify/generate are being re-constructed
from the current contents of the database.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 68 Section 6 F Administering Databases

6
Blank page.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Logical Devices F Section 7 69

Figure 7-Table 6

7 7 Administering Logical Devices

Databases and transaction logs are stored in logical devices, which are
created in disk files or logical volumes. The Server Administration
explorer allows you to match your storage areas to your operating
needs. The options available are:

J Add Logical Device

J View Logical Device Properties

J Delete Logical Device

7
If you intend to use a single database, normally no additional storage
areas are needed. However, very large databases may require more
areas. This section describes how to add more.

7.1 Add Logical Device

During ENVOXr installation, two logical devices are created:

J ENVOX_DEV1 which contains both the main ENVOX database and

the envox_readonly database.

J ENVOX_DEV2 which contains the transaction log for both the main
database and the envox_readonly database.

The main ENVOX database only exists if it is created during installation.

It is not automatically created.

The number of administrator-named logical devices in an ENVOX

system is taken from the devices value configured in the SYBASE
dataserver. This value is initially set to 21.

A logical device can be used for all or part of one or more databases. For
an ENVOX database, the database and the associated transaction log
must be placed on separate logical devices.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 70 Section 7 F Administering Logical Devices

Note ... For maximum I/O throughput, the separate logical devices for
the database and the associated transaction log should be
located on physically separated disk spindles. This separation
allows I/O to occur on both devices concurrently.

To add a new logical device, go to the Server Administration explorer,

and select the Logical Devices category. Then, select File --> New. The
Logical Device -- (New), Figure 7-1, window appears. Follow the
instructions in system administration online help.

Figure 7-1. Dialog for Adding a Logical Device

The minimum size of the ENVOX database is presently 130 megabytes:

120 megabytes for data, and 10 megabytes for the transaction log. The
size entered must be less than, or equal to, the total free space available
on the physical device. If you enter a greater size, an error message is
displayed.

It may take considerable time for the initialization of the logical device.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Logical Devices F Section 7 71

Note ... The master database should be backed up following addition of

a logical device. Section 8 describes how to backup a master
database.

7.2 View Logical Device

You can view the attributes of a logical device and the databases which
have space allocated on a particular logical device through the Logical
Devices property sheet.

To display a logical device’s properties, go to the Server Administration

explorer, and select the logical device. Then, select File --> Properties,
and then select either the Attributes tab or the Database Usage tab.

Figure 7-2 shows an example of a logical device attributes. 7

Figure 7-2. Logical Device Attributes Window

Figure 7-3 shows an example of database usage on a logical device.

You can see the cumulative value for each database fragment located
on the device for each type of usage, and whether the space is allocated
to DATA or LOG. You cannot change information on the Logical Devices
property sheet.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 72 Section 7 F Administering Logical Devices

Figure 7-3. Database Usage Window

7.3 Delete Logical Device

You can delete any logical device which is not in use. Attempting to
delete a device which is in use causes an error. If the error occurs, use
the View Logical Device option to determine which databases or
transaction logs are still located on the device.

Be certain that you want to delete the logical device before carrying this
out, and make sure you delete the correct device. To delete a logical
device, go to the Server Administration explorer, and select the logical
device. Then, select File --> Delete. Follow the instructions in system
administration online help.

Also delete the physical file, in order to free disk space (typically
immediately after carrying out device deletion).

You must restart the dataserver after you delete a logical device. Refer
to subsection 5.2 for more information.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Database Backup and Recovery F Section 8 73

Figure 8-Table 7

8 8 Administering Database Backup and

Recovery

Caution ... The necessity for regularly and correctly backing up your
ENVOXr databases cannot be over-emphasized. If a database
becomes corrupted or unwittingly altered, a current backup is
your best, and sometimes only, recourse. This section describes
proper backup procedures. Please read and follow the
procedures carefully.

8
Along with the recommendations and procedures for backup and
recovery of ENVOX databases, procedures are included for adding,
viewing, and deleting dump devices. Various procedures are available
through Server Administration and through operating system commands.

8.1 Recommended Backup Frequency

It is suggested that you backup databases on the following schedules:

J Backup ENVOX databases regularly, for example, once a day at the

end of the working day.

J Backup the SYBASE master database after any change to

dataserver system tables. Changes include adding logical devices,
adding and modifying databases, and adding or modifying users.

J Daily backup of all affected databases is suggested during

configuration development.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 74 Section 8 F Administering Database Backup and Recovery

8.2 Backup and Recovery Considerations

Note ... The following items are important to understand before

performing the procedures described in Section 8. Please read
them carefully.

As appropriate, the considerations listed below are repeated in the

proper places throughout Section 8.

J As previously noted, the importance of regular backup within the

recommendations listed in subsection 8.1 cannot be
over-emphasized.

J Before you backup a database, and if your system contains sufficient

disk space, it is suggested that you verify and dump the data to disk
before dumping the data to tape. You would then copy the disk dump
8 file to tape through operating system commands. This method
ensures that the data being dumped on tape is good data.

J A PDX dump (as described in Section 9) is a recommended

secondary method for database backup. Having both a database
dump (obtained by the procedures in this section) and a PDX dump
provides added security that a current, usable backup is available.

J Always run database consistency checks (DBCC), in single user

mode, before making a backup. If DBCC cannot be run for all
backups, make sure that it is run on a regular basis.

J Keep a record of the time required to run DBCC, do a Database

Backup, and do a PDX dump for each database, and also record the
amount of disk space required. Compare this backup to previous
backups to ensure that the current backup is good.

J Consider the advantages and disadvantages of performing manual

and automatic backups. For example, manual backups need to be
attended, but they may be more reliable, provide you with more
confidence, and so forth. Automatic backups can be scheduled for off
hours to minimize interference and may allow for more backups, but
they may not be as reliable unless event logging is very good.

J Data taken in a backup cannot be easily verified. The best way to do

so is to recover the data onto a separate database and then run
additional checks to verify that the source and destination databases
are identical.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Database Backup and Recovery F Section 8 75

J When recovering a database (as described in subsection 8.8), the

database structure must be the same at the destination as it was at
the source. Failure to have the same structure can result in indexing
problems, which may make the database unusable and
non-recoverable.

Therefore, it is important to always obtain a copy of the database

structure before backing up a database. Then in the case of the
database having to be restored into a new database, the database
structure obtained of the dumped database can be used to create a
new database of the same structure, followed by loading the dump.

The database structure for any database can be viewed and printed
by selecting the database of interest in Server Administration
explorer, and then using the Databases --> Show Disk Space
Usage menu.

8.3 Backup and Recovery Methods

ENVOX databases are backed up by performing a dump of the
database, and recovered by performing a load of the database. The
terms dump and load are used repeatedly throughout this manual.
8
Dumps and loads are performed by using logical dump devices. These
devices are added, viewed, and deleted as necessary by Server
Administration windows or by Control Desktop utilities. The utility used
for dumping a database is DUMP_DATABASE, and the one used for
loading is LOAD_DATABASE.

Using Server Administration, the following options related to backup and

recovery are available:

J Create a dump device (so that you can backup to it)

J Backup a database

J Recover a database

J Dump to a PDX file

J Load from a PDX file

J Dump to a transaction log

J Show disk space usage

J Database consistency checks

Subsections 8.7 through 8.9.3 describe how to use the Backup database
through Delete Dump Device options. Load From PDX File is used with
the PDX utility. See Section 9 for information.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 76 Section 8 F Administering Database Backup and Recovery

For backing up and recovering databases, a backup server is used,

which is separate from the dataserver (SQL server). The backup server
is run as a process similar to the SQL server. Subsection 8.11 describes
operation of the backup server.

8.4 Consistency Checks

This option allows you to check database consistency and allocation
consistency. Consistency checks may be performed on any database in
the system. These checks check the SYBASE internal database
structures to make sure that no errors exist.

These checks should be run periodically as a safety measure, or after

unusual circumstances, such as power or disk failure. They should
always be run on a database before it is dumped to ensure that its
integrity is good. Any errors are transferred to the dump.

Severe errors can cause a dumped database to be unusable. If errors

are found, it may be necessary to restore the database from the last
known good dump. Report any errors to your Fisher-Rosemount
8 Systems representative or sales office.

To check the consistency and integrity of a database, go to the Server

Administration explorer, and select the database you want to check.
Then, select Databases --> Check Consistency. Follow the instructions
in Server Administration online help.

8.5 Checking the User Database before Backup

Caution ... Before backing up a user database, its integrity should be

checked. This action is necessary to ensure the reliability of
data recovery.

A user database consistency check can be done through Server

Administration, directly through a command line interface, or through
ISQL commands, DBCC CHECKDB and CHECKALLOC, as described
below. But, before you check a user database, consider the following
guidelines:

Note ... The following guidelines can save you time and prevent errors
when you are running consistency checks. You should
understand these guidelines before you proceed.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Database Backup and Recovery F Section 8 77

J To check the master database; see subsection 8.6. Do not use the
information in this subsection.

J The utilities produce a variety of informational messages, but you

need only look for error messages. If error messages occur, you must
fix the problems causing the errors before you can backup the
database.

J Check the user database only when no one is accessing it. Also,
make sure that no ENVOX batch jobs, such as generate or
document, are in progress.

J To avoid spurious 2521 and 2540 errors, place the user database
into single-user mode when you run the checks.

8.5.1 Checking the User Database with Server Administration

The easiest way to check integrity is to use the Databases menu option
of Consistency Checks (see subsection 8.4).

8.5.2 Checking the User Database from the Command Line 8

You may run the database check (db_check) executable directly from a
DOS command line. See Appendix B for the command line syntax.

8.5.3 Checking the User Database with ISQL

If you run user database checks from ISQL, proceed as follows:

Step 1: Create and execute a script file similar to the file,

DBCC_ENVOXDB.SQL, shown below.

A separate script file can be created for each user database

on the system, substituting the appropriate database name in
the file. Use the Control Desktop user account to create the
script files and place them in a suitable file structure.

A sample script file is shown in Figure 8-1.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 78 Section 8 F Administering Database Backup and Recovery

/*------------------- file: dbcc_envoxdb.sql ---------------------------------*/

/* */
/* Do not use this file to run dbcc checks on the master database. */
use master
go
exec sp_dboption ENVOXDB, ”single”, true /*use your database name at ENVOXDB */
go
use ENVOXDB /*use your database name at ENVOXDB */
go
checkpoint
go
dbcc checkdb
go
dbcc checkalloc
go
use master
go
exec sp_dboption ENVOXDB, ”single”, false /*use your database name at ENVOXDB */
go
use ENVOXDB /*use your database name at ENVOXDB */
go
checkpoint
go
/*-------------------end of file: dbcc_envoxdb.sql ---------------------------*/
8
Figure 8-1. Sample Script File For DBCC checks of User Databases

Step 2: Enter the following command at the command prompt (using

your sa password and script file names, and directing the
output to a file):

isql –Usa –Psa_password –idbcc_envoxdb.sql –odbcc_envoxdb.out

Repeat the command for each user database, using the

relevant script file and output file names.

Step 3: Search the output file for error messages by entering the
following command at the command prompt:

find /I “msg” dbcc_envoxdb.out

The find command will list the filename searched, followed by

all lines containing the string “msg” which will correspond to
error messages reported. No errors are found in the database
if the search finds no match.

If errors are found, record the error output, and contact your
Fisher-Rosemount Systems representative or sales office.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Database Backup and Recovery F Section 8 79

8.6 Checking the Master Database Before Backup

Caution ... Before backing up a user database, check its integrity to ensure
the reliability of data recovery.

The master database consistency check can be done through Server

Administration or through command lines as described below. But,
before you check a user database, consider the following guidelines:

Note ... The following guidelines can save you time and prevent errors
when you are running consistency checks. You should
understand these guidelines before you proceed.

8
J Do not use the information in this subsection to check a user
database. See subsection 8.5 for checking a user database.

J The utilities produce a variety of informational messages, but you

need only look for error messages. If error messages occur, you must
fix the faults causing the errors before you can backup the database.

J Check the master database only when no one is accessing it. Also,
make sure that no ENVOX batch jobs, such as generate or
document, are in progress.

J To avoid spurious 2521 and 2540 errors, place the master database
into single-user mode by stopping the dataserver and re-starting it in
single-user mode. While the sever is in this mode, no one may
access any databases.

8.6.1 Checking the Master Database with Server Administration

An easy way to check the master database integrity is to use the
Databases menu option of Consistency Checks (see subsection 8.4).
You may also use the command line procedures described below in
subsection 8.6.2.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 80 Section 8 F Administering Database Backup and Recovery

8.6.2 Checking the Master Database with Command Line

Use the following procedure to run master database checks from
command lines.

Note ... The following procedure requires stopping and starting the
CDOS and SYBASE servers. When the CDOS server is
stopped, all daemon services are also stopped. When the
SYBASE server is started again, the CDOS server and all
daemon services also need to be started again. Instructions for
using NT Services to stop and start servers are given in
Section 6.

Step 1: Use NT services to stop the CDOS server.

Step 2: Use either NT Services or an isql session to stop the

SYBASE server.
8 Step 3: From the NT Explorer, go to the Sybase\Install directory by
entering the following at the Command Prompt window:

> cd %SYBASE%\install

Step 4: From the install directory, copy the RUN_servername.bat file

to RUN_servername_singleuser.bat file, and edit the new file
to add the switch, --m, to the sqlsrvr.exe command line.

Step 5: Start the SYBASE server in single-user mode by entering the

following at the Command Prompt window:

> RUN_your_servername_singleuser.bat

Step 6: Check that the server is running by using the Windows Task
Manager to verify that a process exists for sqlsrvr.exe.

Step 7: Run database consistency checks, using either the db_check

command line or a script file.

J For the db_check command line, see Appendix B. A

sample command line with output going to file,
c:dbcc_master.out, is:

> db_check /S:servername /P:sa_password

/F:c:\dbcc_master.out /d /a /m:s master

J For a script file, use the Control Desktop user account to

create the script file, and place it in a suitable file
structure. A sample script file is shown in Figure 8-2.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Database Backup and Recovery F Section 8 81

/*------------------- file: dbcc_master.sql ----------------------------------*/

/* */
/* Use this file to run dbcc checks on the master database. ....... */
use master
go
dbcc checkdb
go
dbcc checkalloc
go
/*-------------------end of file: dbcc_master.sql ----------------------------*/

Figure 8-2. Sample Script File For DBCC checks of Master Databases

Step 8: Search the output file for error messages by entering the
following command at the Command Prompt window:

> find /I “msg” dbcc_master.out

The find command will list the filename searched, followed by

all lines containing the string “msg” which will correspond to
error messages reported. No errors are found in the database
if the search finds no match. 8
If errors are found, record the error output, and contact your
Fisher-Rosemount Systems representative or sales office.

Step 9: Use either NT Services or an isql session to stop the

SYBASE server.

Step 10: Reboot the machine to start up the SYBASE server, CDOS
server, and daemon services.

Check the SYBASE and CDOS log files to ensure that both
servers have started. Check the daemon log files to ensure
that they are running and registered.

8.7 Database Backup

You may backup (dump) a user database to disk or tape using Server
Administration or you can use operating system commands. Subsection
8.7.3 describes backup via the menu option; subsection 8.7.4 describes
backups via system commands.

Note ... If you are backing up a database to tape, refer to subsection

8.11.2 for important points which must be considered before
you use the backup server.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 82 Section 8 F Administering Database Backup and Recovery

Note ... When you perform a database backup, a backup server

separate from the dataserver (SQL server) is used. The backup
server is automatically selected by the ENVOX system; you do
not need to select it.

8.7.1 Backing Up SYBASE Created Databases

When SYBASE software is installed, SYBASE automatically creates four
additional databases: master, sybsystemprocs, model, and tempdb.

J master is the central database which holds details of all of the other
databases.

J sybsystemprocs contains the stored procedures previously held in

the master database.

model is the database which is used as the basis for a new

8 J
database.

J tempdb is the database in which all temporary tables are created.

The SYBASE sybsystemprocs, model and tempdb databases never

require backup. The SYBASE master database must be backed up
when the information in it has been changed by the following commands:

J Add a Database

J Delete a Database

J Add Logical Device

J Delete Logical Device

J Grant User Access

J Revoke User Access

J Modify Database

J Copy Database

J Rename Database

J Add Dump Device

J Delete Dump Device

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Database Backup and Recovery F Section 8 83

J Add Server Login

J Delete Server Login

When master is entered as the database to be backed up, the master

database created by SYBASE is backed up.

8.7.2 Choosing Disk or Tape Dump Devices

You must consider certain factors when choosing your dump device. If
you backup a user database directly to tape, no read-check or data
verification is performed. Therefore, the more secure backup method is
to dump to a disk dump device and then use operating system backup
commands to copy the operating system file, located on the disk dump
device, to tape.

If you use a disk, you need to make sure that there is sufficient free
space on the disk to hold the dump file when it is created.

If you use tape, at least one tape is required for each database; no more
than one database can be stored on a single tape. However, more than
one tape can be used for a database. 8
There are two tape dump devices specified by SYBASE, named
tapedump1 and tapedump2. These can be viewed using Server
Administration. Specify the name of the tape dump device you are
connected to when performing backup to tape.

8.7.3 Using the Backup Database Option to Backup

Caution ... Before backing up a database, its integrity should be checked.

This action is necessary to ensure the reliability of data
recovery. See Subsection 8.5 for instructions for checking the
database before backup.

To backup a database, you must first define a dump device. Subsections

8.9 and 8.9.2 provide information on adding and viewing a dump device.

Note ... Backing up a database to a disk dump device does not provide
adequate security in the event of a disk failure. For a more
secure backup, copy the disk dump file to tape. Also, if you
have several versions of backup, each should be kept on a
separate tape.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 84 Section 8 F Administering Database Backup and Recovery

To backup a database to disk or tape, go to the Server Administration

explorer, and select the ENVOX or non-ENVOX database you want to
backup. Then, select Databases --> Backup. Follow the instructions in
Server Administration online help.

8.7.4 Using Operating System Commands to Backup

Caution ... Before backing up a database, its integrity should be checked.

This action is necessary to ensure the reliability of data
recovery. See Subsection 8.5 for instructions for checking the
database before backup.

To backup a database, you must define a dump device. The

dump_database.exe program lets you specify the dump device and it
dumps the contents from the specified database to a specified dump
device. Subsections 8.9 and 8.9.2 provide information on adding and
viewing a dump device.
8
Note ... Backing up a database to a disk dump device does not provide
adequate security in the event of a disk failure. For a more
secure backup, copy the disk dump file to tape. Also, if you
have several versions of backup, each should be kept on a
separate tape.

To run the dump_database program, obtain a system prompt, and enter:

Dump_database /S[:]SYBASE /P[:]sa_password database

dumpDevice

Where,
sa_password is the system administrator password
database is the name of the database to be dumped. The
database can be an ENVOX database, a non-ENVOX
database, or the master database.
dump_device is the name of a dump device recognized by
SYBASE. This device can be either a disk device or a
tape drive.
If the database being dumped is the master database, it is necessary to
record the system administrator’s password, and, if the dump device is a
disk, the full disk reference of the dump device (which is not necessarily
the same as its internal SYBASE name). This information is needed if
the database is to be restored using LOAD_DATABASE.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Database Backup and Recovery F Section 8 85

Note ... If you are dumping to multiple tapes, see subsection 8.11.2 for
instructions.

When the command is entered, the backup begins. If you are using
multiple tapes, the software prompts for the tape volume numbers. As
the dump progresses, the software provides displays as shown by
sample in Figure 8-3.

When the backup is complete, the software displays:

Backup of database database to dumpdevice completed

successfully.

ENVOX DUMP DATABASE UTILITY

Fri Feb 4 14:48:41 2000

DUMP_DATABASE : Initiating dump database request...
DUMP_DATABASE : Backup Server session id is: 30. Use this value when executing 8
the ’sp_volchanged’ system stored procedure after fulfilling any volume change
request from the Backup Server.
Msg 602801, Level 1, State 1:
Backup Server: 6.28.1.1: Dumpfile name ’ENVOXDB960330D049’ section number
0001 mounted on tape drive ’mka400:’
Server ’SYB_BACKUP’, line 0:
Msg 405801, Level 1, State 1:
Backup Server: 4.58.1.1: Database ENVOXDB: 3836 kilobytes DUMPed.
Server ’SYB_BACKUP’, line 0:
.
.
.
.
Msg 405801, Level 1, State 1:
Backup Server: 4.58.1.1: Database ENVOXDB: 5548 kilobytes DUMPed.
Server ’SYB_BACKUP’, line 0:
Msg 304201, Level 1, State 1:
Backup Server: 3.42.1.1: DUMP is complete (database ENVOXDB).
Server ’SYB_BACKUP’, line 0:
Fri Feb 4 15:04:35 2000
DUMP_DATABASE : Operation completed.
DUMP_DATABASE : FINISHED - Press RETURN to Exit...

Figure 8-3. Messages Displayed During the Dump Process

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 86 Section 8 F Administering Database Backup and Recovery

8.8 Database Recovery

You may recover (load) a user database from disk or tape with the
Recover Database option using Server Administration or you can use
operating system commands. Subsection 8.8.1 describes recovery via
the menu option; subsection 8.8.2 describes recovery via system
commands.

Note ... If you are loading a user database from tape, refer to
subsection 8.11.2 for important information which must be
considered before you load from tape with the backup server.

Caution ... When recovering a database, the database structure must be

the same at the destination as it was at the source. Failure to
8 have the same structure can result in indexing problems, which
may make the database unusable and non-recoverable.

Note ... When you perform a database recovery, the recovery is from
the backup server. The dataserver is not used in backup and
recovery operations. The backup server is automatically
selected by the ENVOX system; you do not need to select it.

8.8.1 Using the Recover Databases Option to Recover

To recover a database, go to the Server Administration explorer, and
select the ENVOX or non-ENVOX database. Then, select Databases -->
Recover. Follow the instructions in Server Administration online help.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Database Backup and Recovery F Section 8 87

When the recovery is complete, the software displays:

Recovery of database database to dumpdevice completed

successfully.

Note ... Recovery of the master database is not supported by this utility.
To load the master database, refer to the procedure Recovering
the master Database in the Sybase Adaptive Server Enterprise
System Administration Guide

8.8.2 Using Operating System Commands to Recover

The load_database program loads the contents of a specified device into
a specified database. To run the program, obtain a system prompt, and
enter:

Load_database /S[:]SYBASE /P[:]sa_password

[/R[[:]RedoStoredProcs]] [/T[[:]TransferDB]] database 8
dumpDevice

Where,
sa_password is the system administrator password
database is the name of the database to be loaded. The
database can be an ENVOX database, a non-ENVOX
database or the master database.
dump_device is the name of a load device recognized by
SYBASE. This device can be either a disk device or a
tape drive. Additionally, if the database being loaded is
the master database, this name must be the full disk
reference of the dump device, and not its internal
SYBASE name.
[/R| is an optional parameter to select the recreation of stored
procedures. The value is YES or NO. Default is NO.
[/T| is an optional parameter to allow you to “tidy up” server users
on the transferred database. The value is YES or NO.
/T:YES is typically specified if the database was
transferred from another Server and the user-logins
transferred from the old Server are no longer used. Using
this switch removes all users from the database other
than the ENVOX users. If ENVOX is not a valid user of
the database, it is added.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 88 Section 8 F Administering Database Backup and Recovery

Note ... If you are loading from multiple tapes, see subsection 8.11.2 for
instructions.

When you enter the command, the backup begins. If you are using
multiple tapes, the software prompts for the tape volume numbers. As
the load progresses, the software provides displays as shown by sample
in Figure 8-4.

When the recovery is complete, the software displays:

Recovery of database database to dumpdevice completed

successfully.

ENVOX LOAD DATABASE UTILITY

Thu Feb 3 18:23:02 2000

LOAD_DATABASE : Initiating load database request...
8 LOAD_DATABASE : Backup Server session id is: 23. Use this value when executing
the ’sp_volchanged’ system stored procedure after fulfilling any volume change
request from the Backup Server.
Msg 602801, Level 1, State 1:
Backup Server: 6.28.1.1: Dumpfile name ’ENVOXDB960320DE59’ section number
0001 mounted on tape drive ’mka700:’
Server ’SYB_BACKUP’, line 0:
Msg 405801, Level 1, State 1:
Backup Server: 4.58.1.1: Database ENVOXDB: 4740 kilobytes LOADed.
Server ’SYB_BACKUP’, line 0:
Msg 405801, Level 1, State 1:
Backup Server: 4.58.1.1: Database ENVOXDB: 6224 kilobytes LOADed.
Server ’SYB_BACKUP’, line 0:
Msg 405801, Level 1, State 1:
Backup Server: 4.58.1.1: Database ENVOXDB: 9152 kilobytes LOADed.
Server ’SYB_BACKUP’, line 0:
.
.
.
.
Msg 405801, Level 1, State 1:
Backup Server: 4.58.1.1: Database ENVOXDB: 256002 kilobytes LOADed.
Server ’SYB_BACKUP’, line 0:
Msg 304201, Level 1, State 1:
Backup Server: 3.42.1.1: LOAD is complete (database ENVOXDB).
Server ’SYB_BACKUP’, line 0:

Figure 8-4. Messages Displayed During the Load Process

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Database Backup and Recovery F Section 8 89

8.9 Dump Devices

You can add, view, and delete dump devices as necessary for your
backup and recovery operations.

8.9.1 Add Dump Device

Before you add a disk dump device, you may wish to create a special
directory for the disk dump device on the server machine. To do so, go to
the Windows Explorer and select File --> New Folder.

Note ... You can define more than one dump device to point at the
same device or operating system file if you desire.

To create a new dump device, go to the Server Administration explorer,

and select the Dump Devices category. Then, select File --> New. Follow
8
the instructions in Server Administration online help.

8.9.2 View Dump Device

To view a dump device’s properties, go to the Server Administration

explorer, and select the Dump Devices category. Then, select File -->
Properties. Follow the instructions in system administration online help.

8.9.3 Delete Dump Device

Caution ... Be certain that you want to delete the dump device before doing
so, and make sure that you delete the correct device. Any
information on the device cannot be recovered after the device
is deleted.

To delete a dump device, go to the Server Administration explorer, and

select the Dump Devices category. Then, select File --> Delete. Follow
the instructions in Server Administration online help.

Also delete the physical file, in order to free disk space (typically
immediately after carrying out the previous steps). This is not required if
it is a tape device.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 90 Section 8 F Administering Database Backup and Recovery

8.10 Backup and Recovery Troubleshooting

When the backup (dump) or recovery (load) operation is not running as
expected, there are several options you may try. The following
subsections explain procedures you may use to attempt restoration of
the expected operation.

8.10.1 Databases Marked as Non-Recoverable

If a logical device becomes damaged, the database is marked as
suspect or as not recoverable. If this situation occurs, the database
needs to be dropped and recreated before the database backup (dump)
can be loaded back in. A user database can be marked as not
recoverable for reasons other than a damaged logical device. If a
database is marked as not recoverable, it is recommended that you
contact your Fisher-Rosemount Systems representative or sales office
for advice.

8 8.10.2 Standalone (Disk Image) Backup

Each installation of SYBASE is unique. A dump of a database contains
unique SYBASE dataserver information. To insure database
recoverability if the SYBASE dataserver is lost, an image backup of all
disks on the system containing logical devices should be performed,
following ENVOX installation. The procedure for performing an image
backup is contained in the installation manual. See subsection 1.9 to
determine the appropriate installation manual.

Caution ... All devices containing logical devices must be backed up at the
same time. Rebooting the system at any time before all devices
have been backed up will result in a date and time mismatch
between SYBASE logical devices. If this mismatch occurs, the
backups are not usable.

8.10.3 Standalone (Disk Image) Recovery

Restore the image backups created in subsection 8.10.2 by using the
procedure described in the installation manual. See subsection 1.9 to
determine the appropriate installation manual.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Administering Database Backup and Recovery F Section 8 91

Caution ... All disks that contain database logical devices must be restored
at the same time, and the system must not be rebooted at any
time during the restore process. Failure to follow either rule will
result in a mismatch between the time and date stamps in the
SYBASE logical devices, and recovery will not be successful.

Note ... If you need to recover a database from an error, contact your
Fisher-Rosemount Systems representative or sales office
before restoring the image.

8.11 Backup Server Operation

SYBASE 11 has a backup server which is used each time a database
dump or load is performed either through Server Administration or with 8
the standalone utilities dump_database and load_database command
lines. The server is run as a process, in the same way as the SQL server
is. The log for the backup server, backup.log, is located in the
SYBASE\install directory on the server machine.

8.11.1 Starting and Stopping the Backup Server

To stop or start the backup server, use NT Services. Go to the Control
Panel and select Services. In the dialog box, select your backup server,
and then click on the Start or Stop button as appropriate.

8.11.2 Using the Backup Server with Tapes

Usually a database dump will fit onto a single tape. However if this is not
possible, another tape will be requested. When another tape is inserted,
sp_volchanged can be entered at the isql prompt.

When the display appears, access ISQL from another window and enter
the following command at the ISQL prompt:

1> sp_volchanged session_id,devname,”PROCEED”

2> go

where session_id and devname are obtained from the display shown
above. After entering the command, the dump continues.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 92 Section 8 F Administering Database Backup and Recovery

Blank page.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Using PDX to Transfer and Backup Databases F Section 9 93

Figure 9-Table 8

9 9 Using PDX to Transfer and Backup

Databases
This section describes the procedure for using the Portable Database
Transfer (PDX) utility for transferring ENVOXr databases between
computers and for performing database backups. The utility is
embedded in ENVOX P5.0 software, and it is the only factory-supported
means to transfer complete databases (including download data)
between computer platforms. Database dumps cannot be used to
transfer databases between computer platforms.

9.1 Supported Database Transfers

For Control Desktop and ENVOX versions P5.0, the utility lets you dump
and reload databases when you are upgrading SYBASE software from
9
version to 10 to 11 and Control Desktop and ENVOX software, as
follows:

J From Control Desktop P2.0 on any supported platform to ENVOX

P5.0 on an NT platform

J From ENVOX P4.0 on any supported platform to ENVOX P5.0 on an

NT platform

It should be noted that a Control Desktop P2.0 database is an ENVOX

P4.0 database which has been upgraded for use with the P2.0 release
of Control Desktop.

Transferred databases are automatically upgraded to the revision level of

the ENVOX software on the destination platform, whether you use the
windows dialog or command lines to load a database.

Databases cannot be transferred from a later version of ENVOX

software to an earlier version.

The upgrade procedure is described in the installation manual, and

references this section.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 94 Section 9 F Using PDX to Transfer and Backup Databases

9.2 Transfer Process Overview

The PDX utility unloads a database from the source machine into a PDX
file. Then, the windows dialog in ENVOX System Administration can be
used to load the file into a database on the destination machine.

You can always use ENVOX system administration to transfer an

ENVOX database even if you only have one database. You must,
however ensure that there is nobody accessing the database using the
Control Desktop Client software.

The utility copies a database on an object-by-object basis. Each object is

precisely described by a set of attribute values which are represented by
ASCII text. This approach allows databases to be transferred between
dissimilar platforms and different dataserver revisions.

The logical device segments for the database do not have to be the
same order, size and type in the destination database as they are in the
source database. As a result, you can also rationalize the logical device
usage by a database and minimize the number of devices used.

9.3 Transfer and Backup Requirements and Conditions

9
Several requirements and conditions apply to transferring databases
between different platforms and to upgrading SYBASE and ENVOX
software. You should understand the following subsections before
proceeding.

9.3.1 Operational Checks at the Source Machine

Before performing a transfer or backup between source and destination
databases, the PDX utility carries out several operational checks on the
source machine, as follows:

1. Checks that the information in master envox_databases (for pre-P3.2

ENVOX versions) is consistent with the type and revision of the
database to be transferred.

2. Enables the no-code option if the database revision is older than the
revision of the PDX utility.

The no-code option ensures that views, stored procedures, and

triggers are not transferred to the destination machine. A typical case
occurs when you migrate databases from ENVOX source machines
which are at a lower version level than that of the destination
machine. Under this condition, errors can occur when stored
procedures are created on the destination machine, but the no-code
option prevents the errors. Using the destination machine copy of the

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Using PDX to Transfer and Backup Databases F Section 9 95

stored procedures ensures that the stored procedures take into

account any changes between ENVOX database revisions.

3. On P3.2 and later systems, checks the database accessibility

according to fr_databases.

4. On P3.2 and later systems, sets the pdxout status bit before the
transfer starts and clears it when the transfer is complete. Setting the
status bit helps prevent other major database activity from occurring
while the transfer is in progress.

9.3.2 Operational Checks at the Destination Machine

Before performing a transfer or backup between source and destination
databases, the PDX utility carries out several operational checks on the
destination machine, as follows:

1. Checks that fr_databases exists and contains a row of the correct

type.

2. Checks that the ENVOX system is at version P5.0.

3. Sets the no-code option.

4. Checks the database accessibility according to fr_databases status. 9

5. Checks that the database is large enough for the data held in the
PDX file.

6. Sets the pdxin status bit in fr_databases before the transfer starts
and clears it when the transfer is complete.

Note ... Information in open databases should be transferred to Excel

Matrix. OPEN databases are not supported in ENVOX P5.0.

7. On ENVOX databases, encrypts the passwords of any lowercase

logins which were added automatically (this encryption is performed
after a database has been loaded).

8. When the database is loaded, an automatic upgrade is performed if

necessary.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 96 Section 9 F Using PDX to Transfer and Backup Databases

9.3.3 Disk Space Requirements

If you are dumping databases to disk, you must be sure that enough disk
space exists on the source machine to store the created PDX file. The
file is normally about two thirds the size of the database.

If there is a shortage of disk space on the source machine, you may be

able to run the PDX utility on the destination machine while pointing at
the database on the source machine. As a result, the database is
unloaded into a PDX file on the destination machine. However, the
following conditions must be met:

J Both machines must be networked together.

J The machines must be at the same ENVOX version.

The utility creates objects for data segments only; it does not transfer the
transaction log. For this reason, it is not necessary for the device
fragments of the destination database to be the same size and order as
those of the source database.

9.3.4 PDX File Location

9 Specifying the location of the file to which you wish to dump or load a
database is dependant on where the client task daemon is running. If the
client task daemon is running on the client machine, you can browse for
a file on the client machine. However, if the the client task daemon is
running on a different machine than the client, you can browse for a
folder which is accessible to the remote machine. You will need to
specify the file name. On the menu bar, you can use Admin --> Set
Client Task Daemon to set the machine on which the daemon is to run.

9.3.5 Network Requirements

Transferring of a PDX file from a source machine to a destination
machine requires that both machines be on the same network and have
network file transfer facilities available. For transfer between two
machines which are both NT, no additional network services normally are
required.

However, if the source machine is VMS, the VMS machine must have
TCP/IP file transfer services to perform a transfer to the NT machine.
The recommended packages for such provision are MultiNet and UCX.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Using PDX to Transfer and Backup Databases F Section 9 97

9.3.6 Conditions
When you transfer a database, the following conditions must be met:

J Before running the PDX utility, run the database consistency checks
(DBCC) on the source database to make sure that no database
errors exist. See subsection 8.4 for DBCC details.

J After transfer, re-run the DBCC checks on the destination database.

Caution ... To prevent loss of data, the database being transferred must
not be in use while the transfer is taking place.

9.4 Using the PDX Utility

The PDX utility uses windows dialog or a combination of windows dialog
and command lines for dumping or loading a database.

9.4.1 Windows Dialog Access

You can use ENVOX Server Administration explorer to dump a database 9
to a PDX file by selecting Databases --> Dump to PDX (Figure 9-1) and
Databases --> Load from PDX (similar to Figure 9-1). See system
administration online help for instructions.

Figure 9-1. Dump to PDX Dialog

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 98 Section 9 F Using PDX to Transfer and Backup Databases

9.4.2 Command Line Syntax

The command line syntax of the PDX utility is:

PDX [/q] [/s] [/v] [/w] source [/f[:]sourceFileName]

[/S[:]SYBASE /D[:]DATABASE /P[:]password] target
[/f[:]targetFileName] [/C[:]CDOS /S[:]SYBASE
/D[:]DATABASE /P[:]password]

where:

/q No validation
/s Print summary details
/v Validate database without doing a PDX transfer
/w Stop on warning

source Defines the source as file or database

/f Specify source file name

sourceFileName
Name of the source file if parameter 1 is file
/S Specify a SYBASE Server to use
SYBASE The name of the SYBASE Server
/D Specify a database to use
9 DATABASE The name of the database
/P Defines the sa password
password The sa password

target Defines the target as file or database

/f Specify target file name

targetFileName
Name of the target file if parameter 2 is file
/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
/P Defines the sa password
password The sa password

Examples of running PDX

To dump a database to a PDX file :

pdx database /S:SYBASE /D:ENVOXDB /P:database file

/f:ENVOXDB.PDX

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Using PDX to Transfer and Backup Databases F Section 9 99

To load a database from a PDX file :

pdx file /f:ENVOXDB.PDX database /C:CDOS/S:SYBASE

/D:ENVOXDB /P:database

To validate a PDX file and list summary details without doing a PDX
transfer :

pdx /s/v file /f:ENVOXDB.PDX file /f:nul

This example shows that when doing a validation/summary of a PDX file

you may want to specify the nul device as the destination. Using the nul
device prevents the utility from creating an empty file that you have to
delete.

The pdx utility does not directly support backing up to tape. However,
you can use the ntbackup ccommand to move pdx files from disk to tape.

Note ... When loading from a command line, the name of the database
which accepts the data cannot be confirmed. Therefore, ensure
that the correct database name is entered in the command line.

9
9.4.3 Understanding Switches
The global switches used in the PDX utility are an information summary
switch (/s), a validation switch (/v and /q), and a stop-on-warning switch
(/w). The parameters are defined as follows:

J Summary Switch (/s)

When this switch is set, information about the source database is

displayed, such as: database name, database size, reserved disk
space, and log size, and so on. The information is useful when
determining the disk space required on the destination machine.

The displayed information is formatted, for example, as follows:

INFORMATION: Database Name :ENVOXDB

INFORMATION: Database Size :100.00 Mb
INFORMATION: Reserved :89.35 Mb
INFORMATION: Log Size :6.00 Mb

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 100 Section 9 F Using PDX to Transfer and Backup Databases

J Validation Switch (/v) and (/q)

These switches control the validation process and pdx transfer as

follows:

j /v: adding this switch lets you perform a validation without doing a
pdx transfer.

j /q: adding this switch lets you perform a pdx transfer without
doing a validation.

j /v and /q omitted: both the validation and the pdx transfer are
performed.

J Stop on Warning Switch (/w)

Warnings are treated as informational messages and do not stop

data transfer if they occur. However, you can stop on warnings by
setting the /w switch. If you do, warnings are treated as errors and
the error handler stops data transfer for both errors and warnings.

9.4.4 Creating a Database on the Destination Machine

Once the PDX file has been transferred from the source to the
9 destination machine, a destination database must be available for the
PDX file. The database can be created by using the procedures
described in subsection 6.2, Add a Database. The Database Use field
may be set to Configuration or PDX Load.

The size of the database to create can be determined from the

information given when the PDX utility is run with the summary switch.
When the data is loaded into the destination database, three checks are
done on the destination database, as follows:

J Database size in the PDX summary information

A message is displayed if the DATA space in the database is less

than the DATA space that was available to the source database.

J Log size in the PDX summary information

A message is displayed if the LOG space in the database is less

than the LOG space that was available in the source database.

J Reserved space in the PDX summary information

An ERROR is displayed if the data space in the database is not large

enough to hold the amount of data in the PDX file.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Using PDX to Transfer and Backup Databases F Section 9 101

The destination database should be the same size, or larger than, the
source database. If the reserved space on the source database is nearly
the same as the database size, the destination database should be
created larger than the source database because the source database is
almost full.

9.5 Transferring PROFLEX Databases

The PDX utility does not directly support migration of configuration data
located in Type DH6233 PROFLEXr Configuration Software to an
ENVOX database. However, you may migrate a PROFLEX database to
an ENVOX database by using the migrate utility provided with PROFLEX
P5.1 software. If your PROFLEX software is not at version P5.1, you
may order a migration tape from your Fisher-Rosemount Systems
representative or sales office for migrating PROFLEX versions P3.0 up
to P5.1.

You may use the PROFLEX migrate utility in either of the following ways:

J Use the migrate utility to produce comma delimited values (CDVs)

which are compatible with a version P3.0 or later ENVOX system.
Then, import the CDV’s (using ENVOX Import) into a P4.0 ENVOX
database. Finally, use the PDX utility to transfer to the machine
running ENVOX version P5.0. 9
J Use the migrate utility to produce comma delimited values (CDVs).
Then, import the CDV’s (using ENVOX Import) into the ENVOX
version P5.0 database.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 102 Section 9 F Using PDX to Transfer and Backup Databases

Blank page.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Setting Up Audit Trail F Section 10 103

Figure 10-Table 9

10 10 Setting Up Audit Trail

This section describes the Audit Trail facility, the information it tracks,
and how to set up and manage it. The ENVOXr system administrator
determines the contents of the audit trail log and maintains the log.

The Audit Trail facility records changes made to the ENVOX database
and to the system where the database resides. The facility also records
when the changes are made and who makes them. This record is
important for both safety and regulatory perspectives (for example, EPA,
OSHA, FDA).

10.1 Event Tracking

The changes which the Audit Trail facility tracks are called events. An
event is any addition, modification, deletion, or other action performed by
a user including downloads, uploads, exports, imports, and database
administrative functions. 10
The Audit Trail facility can be turned on and off. When the facility is
turned on, selected data about each event are collected and placed in a
log. You can view this information on-line, or create summary or detailed
history reports about selected events for a specified time period.

Each event is assigned a unique event number. Event numbers are

never reused during the life of an ENVOX system. Event number 1 is
always the Audit Trail enable action. Subsequent events are numbered
in contiguous sequence. Once an event number is assigned, information
about the associated event is recorded. Information that is always
recorded for all events includes the following:

J Event type (addition, deletion, download, and so on)

J Event date and time

J User’s login name

J User’s database username

J Program name, as known by the SYBASE dataserver

J Client host name

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 104 Section 10 F Setting Up Audit Trail

The date and time are recorded at the start of the event. This timestamp
is obtained from the SYBASE dataserver (and may differ from the client
machine’s real time clock time). Both the timestamp and the event
number normally increase continuously.

It is possible for two events to have the same timestamp if they occur
very close together. In this case, the event numbers distinguish which
event actually occurred first. It is also possible for an event to have a
later timestamp value than another event with a higher event number
due to a real time clock adjustment on the dataserver.

When available, the following information is also recorded:

J The program name, as known on the client operating system

J The execution mode of the program on the client operating system

(for example, batch or interactive)

J A particular function being performed by the program that led to the

event being logged

J The user’s name as known by the client operating system

10.2 Event Recording Options

The information that the Audit Trail facility records depends on which
10 recording options you enable. Recording options include:

J Audit Trail

J History Log

J Field Update Recording

J Ad Hoc Updates

As shown in Figure 10-1, there is an option hierarchy which organizes

and controls the recording options. For instance, you cannot enable the
History Log option unless the Audit Trail option is enabled. Likewise, you
cannot enable the Ad Hoc Updates or Field Update Recording options
unless the History Log option is enabled.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Setting Up Audit Trail F Section 10 105

Audit Trail

History
Log

Field
Ad Hoc Update
Updates Recording

Figure 10-1. Audit Trail Option Hierarchy

Whether or not you enable these options depends on the requirements

of your site. Instructions for enabling these options are provided in
subsection 10.4.

10.2.1 Audit Trail

The Audit Trail option turns the Audit Trail facility on and records events
which affect the database as a whole. Although this option can be turned
on and off, generally you turn the facility on once and leave it. Normally, 10
you turn the facility on after completing the initial configuration phase of
the database due to the large amount of changes made during the
configuration process.

The events the Audit Trail option records are generally administrative
functions, and include:

J Changing Audit Trail options

J Switching Verify mode on and off

J Extending the database

J Backing up and restoring the database

When a database is backed up, an event is logged before the backup

starts. When the database is restored, an event is logged after the
restoration is complete.

When you switch the Audit Trail option from off to on, an event is logged
immediately. This event is the first one logged in the log file. If you switch
the Audit Trail facility on, and an event is found in the log file indicating
that the Audit Trail was switched off previously, then a warning message
is displayed, advising you to truncate the log first. Likewise, if you switch

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 106 Section 10 F Setting Up Audit Trail

the option from on to off, an event is logged and a warning message is

displayed.

10.2.2 History Log

You can record information about changes to the ENVOX configuration

by using the History Log option. Recorded configuration parameter
changes include:

J Tagged item creations and modifications

J Non-point tagged item deletions

J Point deletions

J Item imports and exports

A single event is logged every time an item change is made.

10.2.3 Field Update Recording

You can record field updates by enabling the Field Update Recording
option. This option applies mainly to modified items. Any changes made
to an item are recorded and, for most attributes, the old and new values
are recorded. Other information recorded by this option includes the
10 device tag of a deleted item, the type of item deleted, and the tags of
any devices that are impacted by the change.

10.2.4 Ad Hoc Updates

The Ad Hoc Updates option allows you to specify what happens when
users try to make changes to the database tables using ISQL. If the
option is enabled (set to LOG), an event is logged for each database
modification made by the ad hoc SQL user. Information recorded when
this option is enabled includes:

J The SQL command used (Update, Delete, or Insert)

J The name of the table modified

J The number of table rows affected by the change

If the option is not enabled (set to REJECT), ad hoc modifications to

database tables are not allowed. If the option is not selectable because
the History Log option is set to NO, then the user can make changes to
the database (provided the required SYBASE access permissions are
granted).

You should set this option to REJECT if the Field Update Recording
option (described below) is enabled because the amount of detail that

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Setting Up Audit Trail F Section 10 107

can be logged about ad hoc changes is limited and can, therefore,

compromise the integrity of other recorded information.

10.3 Event Failure Handling

Some events occur over an extended period of time. In some of these
cases, the completion time is recorded. At the very least, the fact that the
event did or did not complete is recorded. For example, when a device
generation is attempted, the event statement Device Generated or
Device not Generated is recorded.

10.4 Setting Up and Maintaining the Audit Trail Facility

To set up and maintain the audit trail facility, highlight a database in the
explorer window and select File --> Properties from the menu bar. When
the Database Properties Sheet opens, select the Audit Trail tab
(Figure 10-2). Follow the instructions provided in system administration
online help.

10

Figure 10-2. Audit Trail Tab on the Database Properties Sheet

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 108 Section 10 F Setting Up Audit Trail

10.5 Archiving the Audit Trail Log

To archive the Audit Trail Log, select the Databases --> Archive Log
menu option when on the Audit Trail tab. The Archive Log Up To dialog
appears as shown in Figure 10-3.

Figure 10-3. Archive Log Up To Dialog

For information on the fields and buttons in this dialog, refer to the online
help.
10
You can also archive the Audit Trail Log using the at_archivelog
command from a DOS command prompt. The syntax is:

at_archive /f[:]logFileName /d[:]archiveEndDate

/S[:]SYBASE /D[:]DATABASE

/f Specify log file name

logFileName Name of the log file

/d Specify date to archive up to

archiveEndDate
Date to archive up to

/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

For example, to create an Archive of the Audit Trail up to January10,

2000, for the ENVOXDB database:

at_archivelog /d:10-Jan-2000 /f:at_10jan2000.log

/C:CDOS /S:SYBASE /D:ENVOXDB

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Setting Up Audit Trail F Section 10 109

Note that you cannot use Control Desktop or ENVOX Server

Administration to view an archive, but must use a text editor or viewer.

10.6 Truncating the Audit Trail Log

You can shorten the Audit Trail Log by removing events that occurred
before a specified date and time. To remove events, select Databases
--> Truncate Log when on the Audit Trail tab.

The Truncate Log Before dialog appears as shown in Figure 10-4.

Figure 10-4. Truncate Log Before Dialog 10

For information on the fields and buttons of the dialog, refer to the online
help.

Caution ... When you use the Truncate Log option, you remove events
from the Audit Trail log. You cannot recover these events. If you
want to preserve a record of these events, make an archive of
the audit trail log before you truncate the log. You can then use
a text editor to view these events in the archive.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 110 Section 10 F Setting Up Audit Trail

Blank page.

10

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Database Management Utilities and Other Help F Section 11 111

Figure 11-Table 10

11 11 Database Management Utilities and

Other Help
There are utilities, run from command lines, which you may find very
helpful for administrating ENVOXr databases. Additionally, when error
messages occur, you may be able to find further information about the
errors from certain log files. You may also wish to setup different default
printers.

11.1 Clearing a Database

CLEAR_DATABASE is a program which clears all user data from an
ENVOX database, leaving only the default data of the ENVOX system.

The database being cleared becomes temporarily unavailable to all

ENVOX users during this process. This program also deletes all Audit
trail data and re-initializes the Audit trail options.

Caution ... Once CLEAR_DATABASE has run, there is no way to restore

11
the previous contents of the database. If there is any possibility
that the data to be cleared will ever be needed, the database
must be backed up first.

The program only deletes data that is held in tables which are owned by
the user who is invoking the program. If you log in as the “sa”, “admin”,
or “envoxutility” user, only the tables owned by this user are cleared.
Only the “sa”, “admin”, or “envoxutility” user can clear ENVOX
configuration data. Using any other user name results in only the tables
owned by that user being cleared.

Clear Database must be run with the following command line. This
function is not available through windows dialog.

The command for clear database is:

Clear_database /S[:]SYBASE /U[:]USERNAME

/P[:]password [/R] database

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 112 Section 11 F Database Management Utilities and Other Help

where

/S:SYBASE = name of the SYBASE dataserver

/U:USERNAME = SYBASE user to use to clear the database
/P:password = password for USERNAME
/R = Used to run Clear Database in report mode
database = the name of the database which you want to clear

11.2 Database “House-Keeping”

ENVOX_DAEMON is a background process which performs
house-keeping tasks. These tasks include:

J Database clean-up when the process is started up and,

subsequently, as soon as possible after midnight each day. The
clean-up reduces the space used in an ENVOX database and
ensures optimal database performance.

J Continuous tag-id clean up, which reduces the space used in an

ENVOX database.

J Continuous outstanding device verification, which can reduce the

time taken for a user-initiated device generation.

J Continuous calculation of the used space and free space in a

database, and run at the same intervals as database cleanup. You
may also interactively calculate the used space through Server
Administration by highlighting the database, selecting File -->
11 Properties, then selecting the Space Used tab, and finally selecting
Databases --> Recalculate Space Used.

This task can take some time to calculate, but by performing this task
as a background process, the speed at which the information is
available to users is improved.

J Truncation of the master database’s transaction log when the

process is started up and, subsequently, as soon as possible after
midnight each day. Recording the database space used in the
master database fills the log if it is not periodically truncated.

If a task which is being run by ENVOX_DAEMON “crashes”,

ENVOX_DAEMON will go through an automatic re-start cycle. However,
it does not continue the following operations in the re-start:

1. It no longer updates database statistics and cleans up various tables.

2. It no longer truncates the master log.

3. It no longer performs database space-used calculations.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Database Management Utilities and Other Help F Section 11 113

These limitations are applicable for re-start situations only.

ENVOX_DAEMON runs all of the house-keeping tasks when it is started
from NT Services Manager, and runs normally.

11.3 Getting Help with Errors

When the cause for errors cannot be located, helpful information about
ENVOX functions may be located in the log files of certain SYBASE
Dataserver, Document, Export, Import, and Generate files. This
information is required if you contact your Fisher-Rosemount Systems
representative or sales office for support.

You can view this information by accessing the log files as follows:

J To access information found in SYBASE log files

In the Windows NT Explorer, go to the SYBASE install directory. This

directory can be found by getting the value of the SYBASE
environment variable to identify the SYBASE root directory. Double
click on the errorlog file. If a message asks you which program to use
to open the file, specify NOTEPAD or any other text editor.

J To access information found in Document, Export, Import, and

Generate log files

Obtain the log file for a particular job through the Task Monitor utility.
The utility is described in the Control Desktop P5.0 user manual.

11.4 Printer Selection 11

Before you print information from Server Administration, you can change
the printer and the layout for the information you print. You can change
the printer for log files, database reports, audit trail reports, and screen
printer.

To change the printer or layout:

Step 1: Choose File --> Print Setup.

The Printer Setup dialog box opens.

Step 2: From the list, select the printer you want to use.

Step 3: If you want to change how the information is laid out on the
page, click on Setup and use the settings available.

Step 4: Click OK.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 114 Section 11 F Database Management Utilities and Other Help

Blank page.

11

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Tuning the System F Section 12 115

Figure 12-Table 11

12 12 Tuning the System

You may be able to improve the performance of the system on which you
are running SYBASE and ENVOXr Server. This section describes how.

12.1 Factors Affecting Performance

The factors that affect Sybase Performance are many and complex but
the most significant factors are listed below in order of significance:

1. The Central processor unit (CPU) clock speed in MHz and the
number of processors.

2. The amount of main memory allocated to the Sybase server and its
internal allocation.

3. The efficiency of the Disk I/O system: this includes the number and
performance of hard disks drives, disc controllers and disc partitioned
partitions.

4. The number of other applications running on the server machine

which will compete with the server for computing resources.

The most important factor affecting performance is the speed at which 12

your system can process instructions. The speed is determined by the
system’s resources, including both hardware and software components.
The hardware components are such items as CPU performance and
memory size. The software components are such items as the operating
system, and CHIP, SYBASE, and ENVOX Server.

Some of these resources can be easily tuned, some cannot. Resources

such as the system’s CPU performance rating, the amount of physical
memory, the operating system version, and the application software are
not easily changed.

Another factor is the large demands made on the system’s resources by

SYBASE and ENVOX Server. Because of these demands and for
optimum performance, SYBASE and ENVOX Server should be the only
applications installed on your system. Other applications, such as
PROVOXr Data Historian (DH), Batch Data Manager (BDM), and
SIMVOX, directly compete with ENVOX Server for the system’s
resources. If demand for the system’s resources exceeds its hardware

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 116 Section 12 F Tuning the System

capacity, no amount of adjustments to the resources can compensate for

system overloading.

In addition, even a system with a high CPU performance rating can

perform poorly if a large number of ENVOX users are configured or an
incorrect amount of memory has been allocated. It is the synergistic
affect of all resources being properly configured and tuned that results in
good performance.

12.2 Memory Allocation

A significant tunable resource is the amount of memory allocated to the
SYBASE dataserver. Memory allocation should be a minimum of 32
Mbytes, up to 50% of the total physical memory available. The
recommended allocation is 32 Mbytes plus 16 Mbytes for each user up
to the 50% limit.

If your system has enough free memory available, you may decide to
dedicate more than the minimum values to the dataserver. Any additional
memory that is made available to the dataserver is used for ”caching”
frequently accessed data and procedures in memory. Caching provides
faster system performance than if the data and procedures are
frequently read from disk.

If the system memory is over-allocated to the Sybase server, the

operating system spends more time on memory management and less
time is available for user requests on the server. In the worst case, it
temporarily stores process information on the hard drive. When the
information is called for, the process must wait until system memory
becomes available. Both the waiting and the higher disk activity can
12 significantly reduce the system performance.

12.3 Tuning Considerations

The system should be tuned on installation by removing items not
needed for your configuration work such as excess databases and
users. After installation, a system does not normally need tuning unless
more memory, databases, users, and so forth are added.

Note ... To change any of the following tuning parameters requires you
to be logged in to ISQL as the ‘sa’ user. Changes do not
become active until the server is stopped and then restarted.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Tuning the System F Section 12 117

Sybase Total Memory

There are three reasons why you may need to tune the “total memory”
parameter.

J When more physical memory has been added you will probably want
to allocate some of it to the Sybase Server.

J If the server workstation is used primarily as a server and is normally

not used as a client then the amount of memory allocated to Sybase
can be increased.

J If additional services are running on the server workstation, other

than those installed for ENVOX Server P5.0 and Control Desktop the
amount of memory allocated to Sybase may need to be reduced to
achieve an increase in performance.

To increase change the memory allocated first decide how many Kbytes
you want to allocate to Sybase. Then divide by 2 to convert into sybase
pages. The following example allocates 80Mbytes to sybase.

1> sp_configure ”total memory”, 40960

2> go

Procedure Cache Percent

The install program sets the procedure cache percentage at 25%. For
the vast majority of installations this is the correct value.

If you are a single user on a minimal server, or if you have more than
256 Mbytes of memory and less than 5 users, then you may see
improved performance if you reduce the procedure cache percentage to 12
20%. Reducing the procedure cache percentage increases the size of
the main data cache. However, there will be an increased risk that the
procedure cache may become full.

If you get an error message indicating that a function failed because the
procedure cache became full, then you should increase the procedure
cache by say 2%, up to a maximum value of 50%. (Or increase the “total
memory” parameter.)

View or change the “procedure cache percent” parameter:

1> sp_configure ”procedure cache percent”

2> go
Parameter Name Default Memory Used Config Value Run Value
-------------- --------- ----------- ------------ ---------
procedure cache percent 20 26038 25 25

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 118 Section 12 F Tuning the System

1> sp_configure ”procedure cache percent”, 23

2> go

Number of Connections

Sybase allocates a fixed amount of memory for each connection to the

database that can be made. Memory allocated to connections can not be
used by the main data cache, so the number of connections allocated
has an impact on server performance. For optimum performance there
should be just enough connections for the maximum number of users.
This is particularly important if you have a standalone workstation with
minimum memory allocated to Sybase.

A user needs about 22 connections to open all possible Control Desktop

applications simultaneously. The install program will allocate connections
according to the formula ((SybaseTotalMemoryMbytes * 2.5 ) + 20).

That is 220 connections for a computer with 256 Mbytes of main

memory. This should be sufficient for 10 users. If you have more, or less
users you can check and or change the number of connections as
follows:

1> sp_configure ”number of user connections”

2> go
Parameter Name Default Memory Used Config Value Run Value
-------------- ------- ----------- ------------ ---------
number of user connections 25 7997 120 120

1> sp_configure ”number of user connections”, 220

12 2> go

Note that if you do not allocate sufficient connections then users will be
unable to connect or utilities fail. It is better to have a small safety margin
that to run out of connections.

Number of Databases

The install program sets the “number of open databases” parameter to

12. Six databases are created by the install program. An additional 6
databases can be added making a total of 12.

If the Server administration program reports an error indicating that you

can not create any more databases, and you need concurrent access to
more databases then you can increase the “number of open databases”
parameter. However, each open database uses about 112 Kbytes of
memory, thereby reducing the main data cache.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Tuning the System F Section 12 119

If you have a minimal server or you will never need as many as six open
databases then you can reduce the number of open databases. The
minimum value is 6.

1> sp_configure ”number of open databases”

2> go
Parameter Name Default Memory Used Config Value Run Value
----------------------- ------- ----------- ------------ ---------
number of user connections 12 696 12 12

1> sp_configure ”number of open databases”, 14

2> go

Number of Devices

The install program sets the ”number of devices” parameter to 20.

If Server Administration reports an error indicating that you cannot create

any more devices then you can tune this parameter to allow creation of
more devices.

1> sp_configure ”number of devices”

2> go
Parameter Name Default Memory Used Config Value Run Value
-------------------- ------- ----------- ------------ ---------
number of devices 10 #8 20 20

1> sp_configure ”number of devices”, 26

2> go
12
Number of Processors

If the Server workstation has only one processor (CPU), ignore this
section.

If the Server workstation has two or more processors, you can control
maximum amount of available CPU time used by the Sybase server. The
parameter “max online engines” can be increased from the default value
of 1 to allow Sybase to use more than one processor when it has more
then one task to perform.

The “max online engines” parameter specifies the maximum number of

Adaptive Server engines that can be online at any one time in a machine
with multiple processors. At start-up, Adaptive Server starts with a single
engine and completes its initialization, including recovery of all
databases. Its final task is to allocate additional server engines. Each
engine accesses common data structures in shared memory.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 120 Section 12 F Tuning the System

When tuning the “max online engines” parameter:

J Never have more online engines than there are CPUs.

J Depending on overall system load (including applications other than

Adaptive Server), you may achieve optimal throughput by leaving
some CPUs free to run non-Adaptive Server processes.

J Better throughput can be achieved by running fewer engines with

high CPU use, rather than by running more engines with low CPU
use.

As a rule of thumb, you can set “max online engines” to one less than
the number of processors available. This configuration ensures that
other processes on the workstation, such as CDOS, the Control Desktop
user interface, and a Web server always have CPU time available to
them without the need for context switching. This is the default after
installation on a twin processor machine and the recommended setting if
you have more than two processors.

Alternatively, you can choose to set “max online engines” equal to the
number of processors. This maximizes the CPU time available to Sybase
for configuration. However, it may reduce the performance of Trace/Tune
and Diagnostics.

1> sp_configure ”max online engines ”

2> go
Parameter Name Default Memory Used Config Value Run Value
------------------ ------- ----------- ----- ----------
max online engines 1 23 1 1

12
12.4 Extending the Tempdb Database
During certain operations, particularly if several users are on the system
at the same time, you may see a message similar to the following:

Msg 1105, Level 17, State 1: Database tempdb is full.

Cannot allocate space for object -197. If you were
unable to allocate space for Syslogs, dump the
transaction log in this database. For non-log
objects, extend the database or drop other database
objects.

The message indicates that the temporary database is full. To recover, it

is usually sufficient to try the activity (generate, document, and so forth)
again when there are fewer users on the system.

Cross-reference document functions are particularly heavy users of

temporary tables, so if one of these functions is occurring at the same
time as other activities (such as generates), the message is more likely

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Tuning the System F Section 12 121

to appear. Broadly speaking, the more users on a system and the larger
the database, the more likely the message.

To prevent the error, you may need to increase the size of tempdb. There
is no way to definitely calculate the optimum size; it depends on the
types of activities which are running at the time. You can use the space
on any logical device to increase the size.

At installation, 37 Mbytes is allocated to the tempdb.

To increase the size, determine which logical device has space available,
log into ISQL as the sa user, and use an ISQL command, such as:

1> alter database tempdb on ENVOX_DEV3 = 5

2> go

The new space defaults for ”data only” use. Modify it to be used for ”data
and log”. To modify, use the following ISQL command (from the sa login):

1> execute master..envox_data_and_log_tempdb

2> go

To verify that the modification is done correctly, enter in ISQL:

1> sp_helpdb tempdb

2> go

This command should show “data and log” for all rows in the usage
column of the second table.

For example,

device
master
size
2 MB
usage
data and log
12
master 3 MB data and log
ENVOX_DEV3 5 MB data and log

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 122 Section 12 F Tuning the System

Blank page.

12

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Managing Transaction Logs F Section 13 123

Figure 13-Table 12

13 13 Managing Transaction Logs

This section describes the methods used for managing the database
transaction logs found in ENVOXr Server. For every active database,
SYBASE software uses a transaction log to record each addition or
modification of data. These logs are referenced for each database
whenever the SYBASE dataserver is restarted.

13.1 Manual Dumping

You can use Server Administration to dump a transaction log. To dump a
log, go to the Server Administration explorer, and select the database for
which you want to dump the transaction log. Then, select Databases -->
Dump Transaction Log.

When the log is dumped, the following message appears:

Transaction log for database database-name dumped

with truncate-only.

13.2 Automatic Dumping

Transaction logs for the six databases used in ENVOX Server are
dumped automatically. Three methods are available:
13
J Threshold Method

With this method, a stored procedure runs when a threshold is

crossed. The method deletes the inactive portion of the transaction
log and writes a message to the sybase error log. Thus, the
transaction log is only truncated when it needs to be.

Both Last Chance and Free Space thresholds are used. The Last
Chance threshold is crossed when the transaction log is virtually full.
If this happens, all running transactions are suspended until the log is
truncated. To minimize the chance of the log filling up, a Free Space
threshold is included.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 124 Section 13 F Managing Transaction Logs

J Truncate Log on Checkpoint Option Method

With this method, SYBASE periodically dumps the transaction log of

system databases on “checkpoint”. The dump is completely handled
by the SYBASE dataserver and is transparent to the user.

For other databases, SYBASE manages transaction logs by

periodically running a ”checkpoint” on each database to determine if
the transactions represented in the log should be updated to
permanent storage. After the checkpoint process is finished,
SYBASE dumps transactions which have been fully committed to the
database. You cannot explicitly control when a transaction log is
dumped using this option, but you can influence its frequency by
modifying certain system parameters.

J User Scheduled Method

With this method, a user (not the dataserver) schedules the dump
command and controls when logs are dumped. A user can execute a
dump transaction statement for the database through the ISQL
interactive interface or through an external program.

13.3 Dump Methods for ENVOX Server Databases

The transaction logs for the six types of databases in ENVOX Server are
managed as follows:

J ENVOX databases — transaction logs are managed automatically by

SYBASE through Last Chance and Free Space thresholds. The Free
Space threshold is set at 40% and 20%.

J envox_readonly database — transaction log is managed

automatically by SYBASE through the truncate log on checkpoint
13 option.

J master database — transaction log is truncated by the

envox_daemon process shortly after each midnight.

J model database — transaction log is managed automatically by

SYBASE through the truncate log on checkpoint option.

J sybsystemprocs database — transaction log is managed

automatically by SYBASE through the truncate log on checkpoint
option.

J tempdb database — transaction log is managed automatically by

SYBASE through the truncate log on checkpoint option.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Managing Transaction Logs F Section 13 125

13.4 Recovering from Memory Fill-up

Normally, the automatic methods keep transaction logs dumped at
sufficient intervals to prevent the disk used by them from filling up. If, for
some reason, the disk does fill up, the dataserver stops running and
SYBASE can no longer function, preventing further work in the
database.

Note ... If memory space fills up, causing the dataserver to lock, you
can manually dump transaction logs by using the Dump
Transaction Log option described above, or you can extend
memory as described in the error message reproduced below.

If a fill-up occurs the following message appears:

Can’t allocate space for object ’syslogs’ in database

’ENVOXDB’ because the ’logsegment’ segment is full.
If you ran out of space in syslogs, dump the
transaction log. Otherwise, use ALTER DATABASE or
sp_extendsegment to increase the size of the segment.

13

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 126 Section 13 F Managing Transaction Logs

Blank page.

13

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 ISQL Interface F Section 14 127

Figure 14-Table 13

14 14 ISQL Interface
Configuration data is stored in the SYBASE relational database included
in ENVOXr Server. This section provides examples of how to use ISQL
to modify and query an ENVOXr database, and also describes
restrictions for using ISQL. The section assumes that you are familiar
with ISQL.

Refer to your SYBASE TRANSACT_SQL User’s Guide and Commands

Reference Manual for detailed instructions for using ISQL. SYBASE’s
Data Workbench (not included with ENVOX software) may be a useful
front-end tool if you plan to do extensive database management.

Through ISQL, you can:

J View configuration data either at the screen or printer.

J Modify data values of certain attributes or item types in the database.

J Create, modify, or delete tag sets.

J Develop your own database tables and associate them with standard
ENVOX tables (as extensions to those tables).

14.1 Logging into ISQL

Access the ISQL interface through the NT command prompt window by
entering the following command:
14
> isql -SSYBASE -UUSERNAME -Ppassword

where

SYBASE = the name of your SYBASE server

USERNAME and PASSWORD = your username and password.
Usually the username and password will be the same as
those which you use to log into Control Desktop.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 128 Section 14 F ISQL Interface

Note ... The SYBASE login name should always be UPPER CASE.
Using lower case login names can jeopardize the warranty.

If your SYBASE login name is the same as your account name, you only
need to type:

> isql -SSYBASE -Ppassword

where SYBASE and password are your names for these items.

The ISQL prompt 1> appears.

You now have access to your default database. Usually the database
name is ENVOXDB unless you have changed the name. From the 1>
prompt, you can issue ISQL commands.

14.2 Restricted Operations

The following operations are restricted:

Caution ... Adding rows to or deleting rows from the ENVOX database
tables using ISQL jeopardizes database integrity and voids the
warranty. Do not add or delete rows or columns from the
database tables with the ISQL interface.

J You cannot insert or delete rows in any tables other than tag_sets
and required_opn_indices.

Database protections are enforced to prevent you from inserting or

14 deleting rows accidentally. The addition or deletion of rows requires
changes to the indexes that relate data between the various tables. If
the changes are not accomplished properly, the database is
corrupted.

J You cannot alter the structure of any existing table.

J You are not allowed to update items that would affect devices that
are not in your security area.

Security area assignments are still in force when you access the
database from ISQL. The ENVOX server warranty does not support
any attempt to circumvent database security levels for user accounts.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 ISQL Interface F Section 14 129

J You cannot create or modify a security area tag set from ISQL.

Database protections are enforced to prevent the user from

accidentally updating a non-updateable database column.

14.3 Permitted Operations

The following operations are permitted:

J You may use select commands to read the contents of the database.

J You may use update commands for certain columns in certain tables.

The System Manager’s Guide to ENVOX Server and Control

Desktop (SM:SW3159) includes a list of the columns you may
update. The same ENVOX security area restrictions that are applied
from the forms system are also applicable to changes you may make
through ISQL.

J You may use insert and delete commands on ONLY two tables:

j tag_sets

j required_opn_indices

J You may create your own tables and use any select, insert, delete or
update statement.

J You can modify the varchar columns in Control Designer tables if

they contain free format.

J You may disable the ability to make changes through ISQL with Audit
Trail administration.

14.4 Viewing Database Items

Use the Select ISQL command to view items in the database. For 14
example, the following command string allows you to view (at the screen)
all of the items in the database table named tags. Note that all of the
ENVOX tables use lower case letters.

1> select * from tags

2> go

To view only the tag names that do not start with the characters !!, type:

1> select tag from tags where tag not like ’!!%’
2> go

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 130 Section 14 F ISQL Interface

14.5 Accessing Current and Other Databases

To find out which database you are currently accessing, type:

1> select db_name()

2> go

To access another database, type:

1> use database_name

2> go

where database_name is the name of the database you wish to access.

14.6 ISQL Help

The stored procedure sp_help is useful for examining the structure of a
database table. From ISQL, type:

1> sp_help ao
2> go

where, ao is the name of a database table.

This command lists the columns which make up the table, and their
datatypes. Figure 14-1 shows the output from the command.

14

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 ISQL Interface F Section 14 131

Name Owner type Created_on

--------------- --------------- --------------- -----------------------
ao dbo user table Mar 28 1991 1:51PM

Column_name Type Length Nulls Default_name Rule_name

--------------- --------------- ------ ------ ------------------------------
point_tag tag_type 12 0 NULL pattern_tag_rul
res_attr resource_attrib 1 1 NULL resource_attrib
signal_tag tag_type 12 1 NULL tag_rule
out_of_service yes_no_type 3 1 NULL yes_no_rule
failsafe_sp_enb yes_no_type 3 1 NULL yes_no_rule
failsafe_sp analog_type 8 1 NULL NULL
initial_sp analog_type 8 1 NULL NULL
initial_mode mode_type 3 1 NULL ao_mode_rule

index_name index_description index_keys

---------- ----------------- ----------
idxl clustered, unique point_tag No defined keys for this object.

Figure 14-1. Example Output from Help Command

Note that some of the column names are abbreviated in this output if
they are more than 16 characters wide.

Another way to find out what columns are used in each table is to issue
a command like this:

1> select * from ao where 1=2

2> go

Since where 1=2 is never true, no data is returned by this query. The
command lets you list the column headings for the ao table. 14
14.7 Example ISQL Queries
The examples below help explain the use of ISQL queries to access
ENVOX configuration data.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 132 Section 14 F ISQL Interface

14.7.1 Example 1
The following command string allows you to view (at the screen) all of
the items in the database table named tags. Note that all the ENVOX
tables use lower-case letters.

1> select * from tags

2> go

To view only the items that do not contain the characters !!, type:

1> select tag from tags where tag not like ’!!%’
2> go

14.7.2 Example 2
Figure 14-2 is a simple example of the SQL required to return
engineering unit and alarm data for Instrument Signals on a particular
controller:

select tag, high_scale, low_scale,

alarm_a_limit, alarm_b_limit, alarm_c_limit, alarm_deadband
from inst_signals
where type = “ANALOG”
and signal_direction = “INPUT”
and device_tag = “UOC-1”

Figure 14-2. Example SQL Query for Returning Engineering Unit and Alarm Data

14

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 ISQL Interface F Section 14 133

14.7.3 Example 3
Figure 14-3 is an example of an ISQL query that returns various useful
data about AI points.

select indices.point_tag,
device = convert(char(8),inst_signals.device_tag),
type = convert(char(4),tags.type),
ai.signal_tag,
descriptor = convert(char(12),tags.description),
scan = convert(tinyint,ai.scan_rate),
input_filter_mins = ai.input_filter,
repeat_ao = isnull(ai.ao_tag,’ ’),
dbi = indices.index_no,
provue_target_data.ppa_tag,
alarm_disp = provue_target_data.alarm_display_tag
from indices, provue_target_data, tags, ai, inst_signals
where indices.target_id = provue_target_data.target_id
and ai.point_tag = tags.tag
and ai.point_tag = indices.point_tag
and inst_signals.tag = ai.signal_tag
and tags.type like ’AI’
and inst_signals.device_tag like “UOC-%”
order by indices.point_tag

Figure 14-3. Example of an SQL Query for Returning Some Data for AI Points

The syntax, dbi = indices.index_no, causes the string dbi to be

displayed as the column heading rather than the column name. If the
dbi = is omitted, the column heading will read index_no which may not
be as descriptive as dbi. In the above example, this syntax is used for
most of the columns in the select list to provide headings that may be
more meaningful.

The syntax repeat_ao = isnull(ai.ao_tag,’ ’), illustrates the use 14

of the isnull function. This syntax allows you to display a string other than
the default NULL for a value which is not yet specified in the database.
In this example, a space ‘ ’ would be displayed instead of the string
NULL.

This example returns information for all AI points whose Instrument

Signals are located in a controller whose tag begins with UOC--. The
second to last line in the query causes the return. You can substitute
your own match string as appropriate.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 134 Section 14 F ISQL Interface

14.8 Modifying Database Items through ISQL

You can modify data values of certain attributes or item types in the
database by using the Update command.

The following example changes the I/O card number for the instrument
signal tag FIC-101:

Caution ... If you omit the begin transaction command and proceed with
the change, there is no way to revoke the change.

If you omit the where clause from an update statement, the

statement affects all of the rows in the table.

1> begin transaction /* allow change to be revoked */

2> go

3> update inst_signals /* select table to modify */

4> set card = 10 /* change column ’card’ data */

5> where tag = ’FIC-101’/* for specific tag in table

*/

6> go /* execute change */

You can now query the database to ensure that the correct change has
been made. If the change is the one you want, you can confirm the
change to the database by entering:

1> commit transaction /* makes change permanent */

2> go
14 Alternately, to revoke the change to the database, enter:

1> rollback transaction /* ignore the change */

2> go

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 ISQL Interface F Section 14 135

14.9 Creating Tag Sets through ISQL

You can use ISQL to create or modify tag sets. For example, to create a
tag set called TS1 containing the point FIC-1 and to make this point the
first in the sort order, enter:

> isql -SSYBASE -UUSERNAME -Ppassword

where SYBASE, USERNAME, and password are your names for these
items.

1> insert into tag_sets /* select table to modify */

2> values(’TS1’,’FIC-1’,1) /* tag set, item, sort order

*/

3> go

14.10 Using System Command Files

There are two ways to access the database through ISQL: interactively
using ISQL commands at the SYBASE prompt or with an NT command
line. NT command files enable you to execute multiple ISQL commands
easily, quickly, and without syntax mistakes, and are very useful for
frequently used custom commands. Command files may be executing at
the system prompt level while ENVOX batch jobs, such as generates,
continue running. Figure 14-4 is an example of an NT command file.

14

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 136 Section 14 F ISQL Interface

@echo
off setlocal
REM*****************************************************************************
REM Get user inputs from parameters passed to this batch file
REM Usage: repgen database_name device_name
REM where: device_name may contain embedded spaces, so we have multiple
REM parameters and combine them as appropriate.
if “%1”==”” goto enditall
if “%2”==”“ goto enditall
set device_name=%2
if “%3”==”” goto begin
set device_name=%2 %3
if “%4”==”” goto begin
set device_name=%2 %3 %4
if “%5”==”” goto begin
set device_name=%2 %3 %4 %5
if “%6”==”” goto begin
set device_name=%2 %3 %4 %5 %6
if “%7”==”” goto begin
set device_name=%2 %3 %4 %5 %6 %7
if “%8”==”” goto begin
set device_name~%2 %3 %4 %5 %6 %7 %8
if “%9”==”” goto
begin
set device_name~%2 %3 %4 %5 %6 %7 %8 %9:begin
echo...IST, POINT, F-C-C CROSSREFERENCE REPORT...
echo.
echo...wait for data...
REM Modify sql fi!e as required
set gr=%tmp%\istlist.sql
echo set nocount on>%gr%
echo go>>gr%
REM print blank line for appearance
echo print’’>>%gr%
echo print’...INSTRUMENT DATA REPORT ...>>%gr%
echo print’output file name: %tmp%\dat.common’>>%gr%
echo select getdate()>>%gr%
echo use%1>>%gr%
echo go>>%gr%
echo print’’>>%gr%
echo select device_tag, tag, signal=signal_direction,>>%gr%
echo file, card, channel from inst_signals>>%gr%
14 echo where device_tag like “%device_name%” order by file, card, channel>>%gr%
echo go>>%gr%
echo exit>>%gr%
REM make report listing and show user
isql -Uenvoxutility -Penvoxutility -i%gr% -o%tmp%\dat.common
REM User name and null password used to connect to database
type %tmp%\dat.common l more
REM The file istlist.sql and dat.common remain in %tmp%,
REM uncomment following line to delete them.
REM del %tmp%\istlist.sql, %tmp%\dat.common
:enditall
endlocal
REM************************************end**************************************

Figure 14-4. Example of an NT Command File

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Parameters Updateable from ISQL F Appendix A 137

Figure A-Table A

Appendix A
A Parameters Updateable from ISQL
You may use update commands for certain columns in certain database
tables. Table A-1 lists these tables.

Table A-1. Parameters Updateable From ISQL

Item Description Table.Column
Alarm priority description tags.description
strategy tags.strategy
comment tags.comment
Alias template description tags.description
strategy tags.strategy
comment tags.comment
Application definition description tags.description
strategy tags.strategy
comment tags.comment
starts remote application application_defns.application_command
displayed application name application_defns.application_name
operating system application_defns.node_os
determines if a password application_defns.password_required
is required
node address application_defns.remote_node_addr
X--term or DECterm application_defns.terminal_required
required
CHIP device description tags.description
strategy tags.strategy
comment tags.comment
CHIP local 4-bit description tags.description
discrete point strategy tags.strategy
comment tags.comment
channel description chip_4_bit_channels.channel_description
on word chip_4_bit_channels.on_alarm_word
off word chip_4_bit_channels.off_normal_word
CHIP local description tags.description A
accumulation strategy tags.strategy
comment tags.comment
alarm A word chip_accumulations.alarm_a_word
alarm B word chip_accumulations.alarm_b_word
alarm C word chip_accumulations.alarm_c_word
alarm D word chip_accumulations.alarm_d_word
high scale value chip_accumulations.high_scale
low scale value chip_accumulations.low_scale
EU descriptor chip_accumulations.units

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 138 Appendix A F Parameters Updateable from ISQL

Table A-1. Parameters Updateable From ISQL (Continued)

Item Description Table.Column
CHIP local AI point description tags.description
strategy tags.strategy
comment tags.comment
high scale value chip_ai.high_scale
low scale chip_ai.low_scale
units chip_ai.units
alarm A word chip_ai.alarm_a_word
alarm B word chip_ai.alarm_b_word
alarm C word chip_ai.alarm_c_word
alarm D word chip_ai.alarm_d_word
CHIP local AO point description tags.description
strategy tags.strategy
comment tags.comment
high scale value chip_ao.high_scale
low scale value chip_ao.low_scale
units chip_ao.units
alarm A word chip_ao.alarm_a_word
alarm B word chip_ao.alarm_b_word
alarm C word chip_ao.alarm_c_word
alarm D word chip_ao.alarm_d_word
CHIP local ASCII point description tags.description
strategy tags.strategy
comment tags.comment
high scale value chip_ascii.high_scale
low scale value chip_ascii.low_scale
units chip_ascii.units
alarm A word chip_ascii.alarm_a_word
alarm B word chip_ascii.alarm_b_word
alarm C word chip_ascii.alarm_c_word
alarm D word chip_ascii.alarm_d_word
CHIP local DCD point description tags.description
strategy tags.strategy
comment tags.comment
CHIP local DI point description tags.description
strategy tags.strategy
comment tags.comment
on word chip_di.on_alarm_word
off word chip_di.off_normal_word
CHIP local DM point description tags.description
strategy tags.strategy
comment tags.comment
A alarm A word
alarm B word
chip_dm.alarm_a_word
chip_dm.alarm_b_word
alarm C word chip_dm.alarm_c_word
alarm D word chip_dm.alarm_d_word
CHIP local DO point description tags.description
strategy tags.strategy
comment tags.comment
on word chip_do.on_alarm_word
off word chip_do.off_normal_word

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Parameters Updateable from ISQL F Appendix A 139

Table A-1. Parameters Updateable From ISQL (Continued)

Item Description Table.Column
CHIP local EPCI point description tags.description
strategy tags.strategy
comment tags.comment
high scale value chip_epci.high_scale
low scale value chip_epci.low_scale
units chip_epci.units
alarm A word chip_epci.alarm_a_word
alarm B word chip_epci.alarm_b_word
alarm C word chip_epci.alarm_c_word
alarm D word chip_epci.alarm_d_word
CHIP local Group point description tags.description
strategy tags.strategy
comment tags.comment
CHIP local Integer description tags.description
point strategy tags.strategy
comment tags.comment
high scale value chip_integers.high_scale
low scale value chip_integers.low_scale
units chip_integers.units
alarm A word chip_integers.alarm_a_word
alarm B word chip_integers.alarm_b_word
alarm C word chip_integers.alarm_c_word
alarm D word chip_integers.alarm_d_word
CHIP local LCP description tags.description
strategy tags.strategy
comment tags.comment
high scale value chip_lcp.high_scale
low scale value chip_lcp.low_scale
alarm A word chip_lcp.alarm_a_word
alarm B word chip_lcp.alarm_b_word
alarm C word chip_lcp.alarm_c_word
alarm D word chip_lcp.alarm_d_word
CHIP local LOOP point description tags.description
strategy tags.strategy
comment tags.comment
high scale value chip_loop.high_scale
low scale value chip_loop.low_scale
units chip_loop.units
alarm A word chip_loop.alarm_a_word
alarm B word chip_loop.alarm_b_word
alarm C word chip_loop.alarm_c_word
alarm D word chip_loop.alarm_d_word
CHIP local Loop/bias description tags.description
A
point strategy tags.strategy
comment tags.comment
high scale value chip_loop_bias.high_scale
low scale value chip_loop_bias.low_scale
units chip_loop_bias_ratio.units
alarm A word chip_loop_bias.alarm_a_word
alarm B word chip_loop_bias.alarm_b_word
alarm C word chip_loop_bias.alarm_c_word
alarm D word chip_loop_bias.alarm_d_word

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 140 Appendix A F Parameters Updateable from ISQL

Table A-1. Parameters Updateable From ISQL (Continued)

Item Description Table.Column
CHIP local description tags.description
Loop/bias+ratio point strategy tags.strategy
comment tags.comment
high scale value chip_loop_bias_ratio.high_scale
low scale value chip_loop_bias_ratio.low_scale
units chip_loop_bias_ratio.units
alarm A word chip_loop_bias_ratio.alarm_a_word
alarm B word chip_loop_bias_ratio.alarm_b_word
alarm C word chip_loop_bias_ratio.alarm_c_word
alarm D word chip_loop_bias_ratio.alarm_d_word
CHIP local Loop/ratio description tags.description
point strategy tags.strategy
comment tags.comment
high scale value chip_loop_ratio.high_scale
low scale value chip_loop_ratio.low_scale
units chip_loop_ratio.units
alarm A word chip_loop_ratio.alarm_a_word
alarm B word chip_loop_ratio.alarm_b_word
alarm C word chip_loop_ratio.alarm_c_word
alarm D word chip_loop_ratio.alarm_d_word
CHIP local Mon/Dev description tags.description
point strategy tags.strategy
comment tags.comment
high scale value chip_mon_deviations.high_scale
low scale value chip_mon_deviations.low_scale
units chip_mon_deviations.units
alarm A word chip_mon_deviations.alarm_a_word
alarm B word chip_mon_deviations.alarm_b_word
alarm C word chip_mon_deviations.alarm_c_word
alarm D word chip_mon_deviations.alarm_d_word
CHIP local PDO point description tags.description
strategy tags.strategy
comment tags.comment
alarm A word chip_pdo.alarm_a_word
alarm B word chip_pdo.alarm_b_word
alarm C word chip_pdo.alarm_c_word
alarm D word chip_pdo.alarm_d_word
CHIP local Real point description tags.description
strategy tags.strategy
comment tags.comment
high scale value chip_reals.high_scale

A low scale value

units
chip_reals.low_scale
chip_reals.units
alarm A word chip_reals.alarm_a_word
alarm B word chip_reals.alarm_b_word
alarm C word chip_reals.alarm_c_word
alarm D word chip_reals.alarm_d_word

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Parameters Updateable from ISQL F Appendix A 141

Table A-1. Parameters Updateable From ISQL (Continued)

Item Description Table.Column
CHIP local Ref/Dev description tags.description
point strategy tags.strategy
comment tags.comment
high scale value chip_ref_deviations.high_scale
low scale value chip_ref_deviations.low_scale
units chip_ref_deviations.units
alarm A word chip_ref_deviations.alarm_a_word
alarm B word chip_ref_deviations.alarm_b_word
alarm C word chip_ref_deviations.alarm_c_word
alarm D word chip_ref_deviations.alarm_d_word
CHIP target point (any) reporting mode target_data.reporting_mode
deadzone target_data.deadzone
sample interval target_data.sample_interval
Conditional color description tags.description
strategy tags.strategy
comment tags.comment
Conditional text description tags.description
strategy tags.strategy
comment tags.comment
Config DCP point description tags.description
strategy tags.strategy
comment tags.comment
units config_dcp.units
high scale value config_dcp.high_scale
low scale value config_dcp.low_scale
SP high limit config_dcp.sp_high_limit
SP low limit config_dcp.sp_low_limit
ARW high limit config_dcp.arw_high_limit
ARW low limit config_dcp.arw_low_limit
IVP high limit config_dcp_station.ivp_high_limit
IVP low limit config_dcp_station.ivp_low_limit
direct/reverse config_dcp.pca_action
gain config_dcp.pca_gain
reset config_dcp.pca_reset
rate config_dcp.pca_rate
alarm A config_dcp_station.alarm_a_limit+
config_dcp_station.alarm_a_word
alarm B config_dcp_station.alarm_b_type+
config_dcp_station.alarm_b_limit+
config_dcp_station.alarm_b_word
alarm C config_dcp_station.alarm_c_type+
config_dcp_station.alarm_c_limit+
config_dcp_station.alarm_c_word A
increase close config_dcp_station.increase_to_close
input filter config_dcp_fst.pv_in_filter_enb +
config_dcp_fst.pv_in_filter
square root config_dcp_fst.pv_sqrt_enb
Configurable controller description tags.description
strategy tags.strategy
comment tags.comment
DCD template description tags.description
strategy tags.strategy
comment tags.comment

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 142 Appendix A F Parameters Updateable from ISQL

Table A-1. Parameters Updateable From ISQL (Continued)

Item Description Table.Column
Display description tags.description
strategy tags.strategy
comment tags.comment
Equipment list description tags.description
strategy tags.strategy
comment tags.comment
Group template description tags.description
strategy tags.strategy
comment tags.comment
IAC analog ICP point description tags.description
strategy tags.strategy
comment tags.comment
units iac_analog_icp.units
high scale value iac_analog_icp.high_scale
low scale value iac_analog_icp.low_scale
IAC controller description tags.description
strategy tags.strategy
comment tags.comment
IAC DCP point description tags.description
strategy tags.strategy
comment tags.comment
units iac_dcp.units
high scale value iac_dcp.high_scale
low scale value iac_dcp.low_scale
SP high limit iac_dcp.sp_high_limit
SP low limit iac_dcp.sp_low_limit
ARW high limit iac_dcp.arw_high_limit
ARW low limit iac_dcp.arw_low_limit
IVP high limit iac_dcp_station.ivp_high_limit
IVP low limit iac_dcp_station.ivp_low_limit
direct/reverse iac_dcp.pca_action
gain iac_dcp.pca_gain
reset iac_dcp.pca_reset
rate iac_dcp.pca_rate
alarm A iac_dcp_station.alarm_a_limit +
iac_dcp_station.alarm_a_word
alarm B iac_dcp_station.alarm_b_type +
iac_dcp_station.alarm_b_limit+
iac_dcp_station.alarm_b_word
alarm C iac_dcp_station.alarm_c_type +
iac_dcp_station.alarm_c_limit +
A alarm D
iac_dcp_station.alarm_c_word
iac_dcp_station.alarm_d_word
increase close iac_dcp_station.increase_to_close
IAC discrete ICP point description tags.description
strategy tags.strategy
comment tags.comment
units iac_discrete_icp.units
high scale value iac_discrete_icp.high_scale
low scale value iac_discrete_icp.low_scale
channel description iac_icp_channels.channel_description
on word iac_icp_channels.on_alarm_word
off word iac_icp_channels.off_normal_word

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Parameters Updateable from ISQL F Appendix A 143

Table A-1. Parameters Updateable From ISQL (Continued)

Item Description Table.Column
Instrument signal description tags.description
strategy tags.strategy
comment tags.comment
limit to trigger alarm A inst_signals.alarm_a_limit
word displayed for alarm A inst_signals.alarm_a_word
limit to trigger alarm B inst_signals.alarm_b_limit
high or low limit inst_signals.alarm_b_type
word displayed for alarm B inst_signals.alarm_b_word
limit to trigger alarm C inst_signals.alarm_c_limit
high or low limit inst_signals.alarm_c_type
word displayed for alarm C inst_signals.alarm_c_word
deadband for alarms inst_signals.alarm_deadband
MUX card number inst_signals.card
MUX channel number inst_signals.channel
conversion constant for inst_signals.conv_constant
PCI and EPCI signals
MUX file number inst_signals.file
signal high scale value inst_signals.high_scale
input signal inverter inst_signals.invert_input
output signal inverter inst_signals.invert_output
signal low scale value inst_signals.low_scale
word displayed when signal inst_signals.off_normal_word
not active
word displayed when signal inst_signals.on_alarm_word
active
engineering units for signal inst_signals.unit
LCON device description tags.description
strategy tags.strategy
comment tags.comment
LCP FST description tags.description
strategy tags.strategy
comment tags.comment
MUX device description tags.description
strategy tags.strategy
comment tags.comment
MUX DI point description tags.description
strategy tags.strategy
comment tags.comment
MUX address inst_signals.file+card+channel
scan rate mux_di.scan_rate
channel description mux_di_channels.channel_description
on word
off word
mux_di_channels.on_alarm_word
mux_di_channels.off_normal_word A
invert input mux_di_channels.invert_input

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 144 Appendix A F Parameters Updateable from ISQL

Table A-1. Parameters Updateable From ISQL (Continued)

Item Description Table.Column
MUX EXT AC2 point description tags.description
strategy tags.strategy
comment tags.comment
MUX address inst_signals.file+card+channel
high scale value inst_signals.high_scale
low scale value inst_signals.low_scale
units inst_signals.units
invert output inst_signals.invert_output
alarm B inst_signals.alarm_b_type +
inst_signals.alarm_b_limit +
inst_signals.alarm_b_word
alarm C inst_signals.alarm_c_type +
inst_signals.alarm_c_limit +
inst_signals.alarm_c_word
alarm deadband inst_signals.alarm_deadband
filter time constant mux_ext_ac2.filter_constant
first order filter enable mux_ext_ac2.filter_enb
input square root enable mux_ext_ac2.input_sqrt_enb
linearization enable mux_ext_ac2.linearization_enb
scan rate mux_ext_ac2.scan_rate
MUX EXT AI point description tags.description
strategy tags.strategy
comment tags.comment
MUX address inst_signals.file+card+channel
scan rate mux_ext_ai.scan_rate
input filter mux_ext_ai.filter_enb+mux_ext_ai.filter_constant
square root mux_ext_ai.input_sqrt_enb
linearization enable mux_ext_ai.linearization_enb
high scale value inst_signals.high_scale
low scale value inst_signals.low_scale
units inst_signals.units
alarm B inst_signals.alarm_b_type +
inst_signals.alarm_b_limit +
inst_signals.alarm_b_word
alarm C inst_signals.alarm_c_type +
inst_signals.alarm_c_limit +
inst_signals.alarm_c_word
alarm deadband inst_signals.alarm_deadband
invert output inst_signals.invert_output
MUX EXT AO point description tags.description
strategy tags.strategy
comment tags.comment
MUX address inst_signals.file+card+channel
A scan rate mux_ext_ao.scan_rate
invert output inst_signals.invert_output
MUX EXT DO point description tags.description
strategy tags.strategy
comment tags.comment
MUX address inst_signals.file+card+channel
scan rate mux_ext_do.scan_rate
channel description mux_ext_do_channels.channel_description
on word mux_ext_do_channels.on_alarm_word
off word mux_ext_do_channels.off_normal_word

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Parameters Updateable from ISQL F Appendix A 145

Table A-1. Parameters Updateable From ISQL (Continued)

Item Description Table.Column
MUX PCI point description tags.description
strategy tags.strategy
comment tags.comment
MUX address inst_signals.file+card+channel
high scale value inst_signals.high_scale
low scale value inst_signals.low_scale
engineering units inst_signals.units
scan rate mux_pci.scan_rate
MUX REC AO point description tags.description
strategy tags.strategy
comment tags.comment
MUX address inst_signals.file+card+channel
scan rate mux_rec_ao.scan_rate
MUX STD AI point description tags.description
strategy tags.strategy
comment tags.comment
MUX address inst_signals.file+card+channel
scan rate mux_std_ai.scan_rate
high scale value inst_signals.high_scale
low scale value inst_signals.low_scale
units inst_signals.units
MUX STD AC2 description tags.description
strategy tags.strategy
comment tags.comment
MUX address inst_signals.file+card+channel
high scale value inst_signals.high_scale
low scale value inst_signals.low_scale
units inst_signals.units
invert output inst_signals.invert_output
scan rate mux_std_ac2.scan_rate
MUX STD AO point description tags.description
strategy tags.strategy
comment tags.comment
MUX address inst_signals.file+card+channel
invert output inst_signals.invert_output
scan rate mux_std_ao.scan_rate
MUX STD DO point description tags.description
strategy tags.strategy
comment tags.comment
MUX address inst_signals.file+card+channel
Operation description tags.description
strategy tags.strategy A
comment tags.comment
PCIU device description tags.description
strategy tags.strategy
comment tags.comment
PCIU Analog Input description tags.description
point strategy tags.strategy
comment tags.comment
high scale value pciu_ai.high_scale
low scale value pciu_ai.low_scale
units pciu_ai.units

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 146 Appendix A F Parameters Updateable from ISQL

Table A-1. Parameters Updateable From ISQL (Continued)

Item Description Table.Column
PCIU Analog Output description tags.description
point strategy tags.strategy
comment tags.comment
high scale value pciu_ao.high_scale
low scale value pciu_ao.low_scale
units pciu_ao.units
PCIU Discrete point description tags.description
strategy tags.strategy
comment tags.comment
on word pciu_disc_channels.on_alarm_word
off word pciu_disc_channels.off_normal_word
channel description pciu_disc_channels.channel_description
PMA description tags.description
strategy tags.strategy
comment tags.comment
PPA description tags.description
strategy tags.strategy
comment tags.comment
Procedure description tags.description
strategy tags.strategy
comment tags.comment
Procedure list description tags.description
strategy tags.strategy
comment tags.comment
CONSOLE description tags.description
Accumulation point strategy tags.strategy
comment tags.comment
alarm A word provue_accumulations.alarm_a_word
alarm B word provue_accumulations.alarm_b_word
alarm C word provue_accumulations.alarm_c_word
alarm D word provue_accumulations.alarm_d_word
high scale value provue_accumulations.high_scale
low scale value provue_accumulations.low_scale
EU descriptor provue_accumulations.units
accumulate when discrete provue_accumulations.accum_when
on or off
conversion factor provue_accumulations.conv_factor
period provue_accumulations.period
CONSOLE Activity description tags.description
point strategy tags.strategy
A comment
alarm A word
tags.comment
provue_activities.alarm_a_word
alarm B word provue_activities.alarm_b_word
initial mode provue_activities.initial_mode

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Parameters Updateable from ISQL F Appendix A 147

Table A-1. Parameters Updateable From ISQL (Continued)

Item Description Table.Column
CONSOLE DCD point description tags.description
strategy tags.strategy
comment tags.comment
off scan provue_dcd_points.off_scan
out of service provue_dcd_points.out_of_service
retry_counter provue_dcd_points.retry_counter
transition time provue_dcd_points.transition_time
alarm word provue_dcd_points.alarm_word
initial mode provue_dcd_points.initial_mode
initial setpoint provue_dcd_points.initial_sp
scan period provue_dcd_points.scan_period
CONSOLE Device description tags.description
definition strategy tags.strategy
comment tags.comment
filters entries from alarm provue_devices.allow_summary_filter
and OAR summaries
application that runs help provue_devices.cs_help_application
application that runs provue_devices.docvue_application
DOCVUEt
documentation
idle time for selected point provue_devices.input_timeout
type of keyboard provue_devices.keyboard_type
maximum windows provue_devices.max_windows
displayed
message stack size provue_devices.message_stack_size
number of alarms displayed provue_devices.minor_alarmlist_size
in minor list
number of OARs in OAR list provue_devices.oar_list_size
alarm area on top provue_devices.alarm_window_on_top
application that runs provue_devices.sess_mgr_application
session manager
idle time for remote session provue_devices.session_timeout
CONSOLE EPCI point description tags.description
strategy tags.strategy
comment tags.comment
off scan provue_epci.off_scan
high scale value provue_epci.high_scale
low scale value provue_epci.low_scale
units provue_epci.units
CONSOLE integrity description tags.description
point strategy tags.strategy
comment tags.comment
alarm A word
alarm B word
provue_integrity.alarm_a_word
provue_integrity.alarm_b_word
A
alarm C word provue_integrity.alarm_c_word
alarm D word provue_integrity.alarm_d_word
log faults provue_integrity.log_faults
off scan provue_integrity.off_scan
out of service provue_integrity.out_of_service
polling period provue_integrity.period
CONSOLE description tags.description
maintenance point strategy tags.strategy
comment tags.comment

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 148 Appendix A F Parameters Updateable from ISQL

Table A-1. Parameters Updateable From ISQL (Continued)

Item Description Table.Column
CONSOLE target point reporting mode target_data.reporting_mode
(any) deadzone target_data.deadzone
sample interval target_data.sample_interval
local alarm provue_target_data.local_alarms
operator change provue_target_data.operator_changes
message provue_target_data.messages
oper change msg provue_target_data.oper_change_messages
state message provue_target_data.state_messages
step message provue_target_data.step_messages
PPA tag provue_target_data.ppa_tag
alarm group A provue_target_data.alarm_a_group
alarm group B provue_target_data.alarm_b_group
alarm group C provue_target_data.alarm_c_group
alarm group D provue_target_data.alarm_d_group
alarm display appear provue_target_data.alarm_display
alarm display tag provue_target_data.alarm_display_tag
decimal places provue_target_data.decimal_places
scale provue_target_data.scale
bit1 provue_target_data.bit1
bit2 provue_target_data.bit2
bit3 provue_target_data.bit3
bit4 provue_target_data.bit4
expected value provue_target_data.expected value
group number provue_ext_alarms.group_no
alarm word provue_ext_alarms.word
Report description tags.description
strategy tags.strategy
comment tags.comment
Report header description tags.description
strategy tags.strategy
comment tags.comment
Single discrete point description tags.description
strategy tags.strategy
comment tags.comment
off normal word single_discretes.off_normal_word
on alarm word single_discretes.on_alarm_word
Tag set description tags.description
strategy tags.strategy
comment tags.comment
tag of item in the set tag_sets.tag
sorted number of item tag_sets.sort_no

A Trend device description

strategy
tags.description
tags.strategy
comment tags.comment
Trend target point sample interval target_data.sample_interval
UOC device description tags.description
strategy tags.strategy
comment tags.comment
channel xmitter high scale serial_channels.xmitter_high_scale
channel xmitter low scale serial_channels.xmitter_low_scale
channel process high scale serial_channels.process_high_scale
channel process low scale serial_channels.process_low_scale
channel square root enable serial_channels.square_root_enb

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Parameters Updateable from ISQL F Appendix A 149

Table A-1. Parameters Updateable From ISQL (Continued)

Item Description Table.Column
UOC AI point description tags.description
strategy tags.strategy
comment tags.comment
MUX address inst_signals.file+card+channel
tag ai.ao_tag
ao for data record ai.ao_enb
linearization enable ai.linearization_enb
rate filter time ai.rate_filter
rate filter enable ai.rate_filter_enb
rate function enable ai.rate_function_enb
resource attribute ai.res_attr
input filter ai.input_filter_enb+input_filter
input square root ai.input_sqrt_enb
scan rate ai.scan_rate
off scan ai.off_scan
input failure action ai.input_fail_action
configured value ai.configured_value
fail input over/under range ai.fail_inp_ou_rnge_enb
enable
high scale value inst_signals.high_scale
low scale value inst_signals.low_scale
units inst_signals.units
alarm B inst_signals.alarm_b_type +
inst_signals.alarm_b_limit +
inst_signals.alarm_b_word
alarm C inst_signals.alarm_c_type +
inst_signals.alarm_c_limit +
inst_signals.alarm_c_word
alarm deadband inst_signals.alarm_deadband
invert input inst_signals.invert_input
UOC AO point description tags.description
strategy tags.strategy
comment tags.comment
MUX address inst_signals.file+card+channel
out of service ao.out_of_service
invert output inst_signals.invert_output
failsafe setpoint ao.failsafe_sp
failsafe setpoint enable ao.failsafe_sp_enb
initial mode ao.initial_mode
initial setpoint ao.initial_sp
resource attribute ao.res_attr
high scale value inst_signals.high_scale
low scale value inst_signals.low_scale
units inst_signals.units
A

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 150 Appendix A F Parameters Updateable from ISQL

Table A-1. Parameters Updateable From ISQL (Continued)

Item Description Table.Column
UOC DCD point description tags.description
strategy tags.strategy
comment tags.comment
active condition timers dcd_conditions.cond_timer
mode for TRUE condition dcd_conditions.mode_mask
set point condition list dcd_sp_conditions.condition_list
drive output when dcd_sp_conditions.drive_on_clear
conditions clear
failsafe setpoint for a TRUE dcd_sp_conditions.fail_sp
condition
setpoint name for the dcd_sp_conditions.sp_name
condition
type of actions and dcd_sp_conditions.type
interlocks for a condition
failsafe setpoint dcd_points.failsafe_sp
failsafe setpoint enable dcd_points.failsafe_sp_enb
initial mode dcd_points.initial_mode
initial setpoint dcd_points.initial_sp
set off scan to on or off dcd_points.off_scan
set out of service to on or off dcd_points.out_of_service
mode input enable dcd_points.mode_input_enb
instrument signal tag from dcd_points.mode_in_signal_tag
remote device
mode output enable dcd_points.mode_output_enb
instrument signal tag to dcd_points.mode_out_signal_tag
remote device
mode lock enable dcd_points.mode_lock_enb
resource attribute dcd_points.res_attr
retry_counter dcd_points.retry_counter
remote setpoint mode dcd_points.rsp_mode_enb
enable
scan rate dcd_points.scan_rate
transition time dcd_points.transition_time
seconds or minutes for dcd_points.trans_time_units
transition time
setpoint tracks PV in RSP dcd_points.sp_trk_pv_in_rsp_enb
mode enable
drive DCD failure enable dcd_points.drive_dcd_fail_enb
failure output setpoint dcd_points.failure_output_sp
UOC DI point description tags.description
strategy tags.strategy
comment tags.comment
MUX address inst_signals.file+card+channel
A scan rate
off scan
di.scan_rate
di.off_scan
alarm enable di.alarm_enb
alarm value di.alarm_value
resource attribute di.res_attr
invert input inst_signals.invert_input
on alarm word inst_signals.on_alarm_word
off normal word inst_signals.off_normal_word

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Parameters Updateable from ISQL F Appendix A 151

Table A-1. Parameters Updateable From ISQL (Continued)

Item Description Table.Column
UOC DM point description tags.description
strategy tags.strategy
comment tags.comment
MUX address inst_signals.file+card
scan rate dm.scan_rate
off scan dm.off_scan
conversion type dm.conversion
data ready enable dm.data_ready_enb
data ready signal tag dm.ready_signal_tag
resource attribute dm.res_attr
UOC DO point description tags.description
strategy tags.strategy
comment tags.comment
MUX address inst_signals.file+card+channel
Out of service do.out_of_service
failsafe setpoint do.failsafe_sp
failsafe setpoint enable do.failsafe_sp_enb
initial mode do.initial_mode
initial setpoint do.initial_sp
resource attribute do.res_attr
Invert output inst_signals.invert_output
on alarm word inst_signals.on_alarm_word
off normal word inst_signals.off_normal_word
UOC EPCI point description tags.description
strategy tags.strategy
comment tags.comment
address inst_signals.file+card+channel
conversion constant inst_signals.conv_constant
high scale value inst_signals.high_scale
low scale value inst_signals.low_scale
units inst_signals.units
off scan epci.off_scan
rate filter time epci.rate_filter
rate filter enable epci.rate_filter_enb
rate function enable epci.rate_function_enb
resource attribute epci.res_attr
scan rate epci.scan_rate
UOC Group point description tags.description
strategy tags.strategy
comment tags.comment
failsafe setpoint group_points.failsafe_sp
failsafe setpoint enable group_points.failsafe_sp_enb
initial setpoint
initial mode
group_points.initial_sp
group_points.initial_mode
A
off scan group_points.off_scan
out of service group_points.out_of_service
resource attribute group_points.res_attr

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 152 Appendix A F Parameters Updateable from ISQL

Table A-1. Parameters Updateable From ISQL (Continued)

Item Description Table.Column
UOC LCP description tags.description
strategy tags.strategy
comment tags.comment
scan rate lcp.scan_rate
out of service lcp.out_of_service
high scale value lcp.high_scale
low scale value lcp.low_scale
alarm A word lcp.alarm_a
alarm B word lcp.alarm_b
alarm C word lcp.alarm_c
alarm D word lcp.alarm_d
resource attribute lcp.res_attr
UOC Loop point description tags.description
strategy tags.strategy
comment tags.comment
scan rate loop.scan_rate
off scan loop.off_scan
high scale value inst_signals.high_scale
low scale value inst_signals.low_scale
units inst_signals.units
SP high limit loop.sp_high_limit
SP low limit loop.sp_low_limit
ARW high limit loop.arw_high_limit
ARW low limit loop.arw_low_limit
out of service loop.out_of_service
rate filter time loop.rate_filter
rate filter enable loop.rate_filter_enb
rate function enable loop.rate_function_enb
resource attribute loop.res_attr
gain loop.pca_gain
reset loop.pca_reset
rate loop.pca_rate
IVP high limit loop_station.ivp_high_limit
IVP low limit loop_station.ivp_low_limit
alarm A inst_signals.alarm_a_limit +
inst_signals.alarm_a_word
alarm B inst_signals.alarm_b_type +
inst_signals.alarm_b_limit +
inst_signals.alarm_b_word
alarm C inst_signals.alarm_c_type +
inst_signals.alarm_c_limit +
inst_signals.alarm_c_word
alarm deadband inst_signals.alarm_deadband
A direct/reverse
increase close
loop.pca_action
loop_station.increase_to_close
invert input inst_signals.invert_input
PV input filter loop_fst.pv_in_filter_enb +
loop_fst.pv_in_filter
PV square root loop_fst.pv_sqrt_enb
input failure action loop_io.pv_input_fail_action
configured value loop_io.configured_value
track in fail action loop_io.track_in_fail_action
fail PV over/under range loop_io.fail_pv_ou_rnge_enb
enable

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Parameters Updateable from ISQL F Appendix A 153

Table A-1. Parameters Updateable From ISQL (Continued)

Item Description Table.Column
UOC PCI point description tags.description
strategy tags.strategy
comment tags.comment
MUX address inst_signals.file+card+channel
scan rate pci.scan_rate
off scan pci.off_scan
rate filter time pci.rate_filter
rate filter enable pci.rate_filter_enb
rate function enable pci.rate_function_enb
resource attribute pci.res_attr
conversion constant inst_signals.conv_constant
UOC PDO point description tags.description
strategy tags.strategy
comment tags.comment
MUX address inst_signals.file+card
out of service pdo.out_of_service
conversion type pdo.conversion
failsafe setpoint pdo.failsafe_sp
failsafe setpoint enable pdo.failsafe_sp_enb
initial mode pdo.initial_mode
initial setpoint pdo.initial_sp
resource attribute pdo.res_attr
UOC source extended alarm word source_ext_alarms.alarm_word
alarms initial state enable source_ext_alarms.initial_state_enb
UOC target point (any) deadzone target_data.deadzone
reporting mode target_data.reporting_mode
sample interval target_data.sample_interval
conversion constant uoc_target_data.conv_constant
scan rate uoc_target_data.scan_rate
initial state enable target_ext_alarms.initial_state_enb
UOC Unit point description tags.description
strategy tags.strategy
comment tags.comment
resource attribute units.res_attr
User defined key description tags.description
strategy tags.strategy
comment tags.comment

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 154 Appendix A F Parameters Updateable from ISQL

Table A-1. Parameters Updateable From ISQL (Continued)

Item Description Table.Column
User name description tags.description
strategy tags.strategy
comment tags.comment
name of system palette or user_access.color_palette
tag of user palette
cursor shape user_access.cursor_shape
size of directory dialog user_access.directory_dialogsize
sort order on directory user_access.directory_sorting
windows
number of displays in stack user_access.display_stack_size
font used on windows user_access.font_set
initial display user_access.initial_display_tag
instrument area left or right user_access.instr_area_position
language used on console user_access.language
macro window orientation user_access.marco_window_ornt
maximum windows user_access.max_windows
displayed
alarm window on top user_access.alarm_window_on_top
login of remote user user_access.remote_login_name
display update interval user_access.update_interval
single or split window user_access.window_presentation
screen template user_access.screen_template
pointer accelerator user_access.pointer_acceleration
pointer threshold user_access.pointer_threshold
User palette description tags.description
strategy tags.strategy
comment tags.comment
alarm area background user_palettes.alarm_area_bg
color
alarm area foreground user_palettes.alarm_area_fg
color
display control button user_palettes.display_cntrl_button_fg
foreground color
display control button user_palettes.display_cntrl_button_bg
background color
DSR indication color user_palettes.dsr_indication_color
DSR selection color user_palettes.dsr_selection_color
instrument area background user_palettes.instrument_area_bg
color
instrument area foreground user_palettes.instrument_area_fg
color
window background color user_palettes.main_window_bg
window foreground color user_palettes.main_window_fg
A menu bar background color
menu bar foreground color
user_palettes.menu_bar_bg
user_palettes.menu_bar_fg

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Command Line Executables F Appendix B 155

Figure B-Table B

Appendix B
B Command Line Executables
Many administrative functions which are accessible through dialog boxes
can also be performed by administrative utilities. A few administrative
functions are only available through these utilities. This appendix lists
available administrative utilities and describes the general format for their
command lines.

B.1 Available Administrative Utilities

The following utilities are available through command lines.

B.1.1 Add ENVOX User

Use this utility to add an ENVOXr user to a database.

add_user /S[:]SYBASE /P[:]password

[/A[[:]administrator]] /U[:]username /D[:]database

where

/S — Specify a SYBASE Server to use.

SYBASE — The name of the SYBASE Server.
/P — Defines the sa password.
password — The sa password.
/A — Use to specify whether the new user will have administrator
privilege in this database.
administrator — Valid values are YES and NO. Default is NO.
/U — Specify the name of the new user to add to the database
username.
/D — Specify the database that the new user is being added to.
database — The name of the database.

Example of adding a new ENVOX user login:

B
add_user /S:TUBAL /P:database /A:YES /U:USER1
/D:ENVOXDB

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 156 Appendix B F Command Line Executables

B.1.2 Rename Tag

Use this utility to rename tagged items.

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

/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. Recovery mode
should be used when an item rename fails. Old Tag and
New Tag must not be supplied if running in recovery
mode.
[oldTag] — Defines the tag of the item to be renamed.
[newTag] — Defines the new tag for the item.

Example of running an item rename:

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

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

Example of running rename in recovery mode:

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

/U:SMITH /P:password /R

B.1.3 Upgrade Database

Use this utility to upgrade a database.

cd_upgrade /S[:]SYBASE [/D[:]DATABASE] /P[:]password

B [/a] [/l[:]logFileName] [/q]

where

/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.
/P— Defines the sa password.
password— The sa password.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Command Line Executables F Appendix B 157

/a— Upgrade all databases.

/l— Specify log file name.
logFileName— Name of the log file.
/q— Quiet mode.

B.1.4 Clear Database

Use this utility to clear a database.

clear_database /S[:]SYBASE /U[:]username

/P[:]password [/R] database

where

/S— Specify a SYBASE Server to use.

SYBASE — The name of the SYBASE Server.
/U — Defines the username.
username — The username.
/P — Defines the user’s password.
password — The user’s password.
/R — Use to report what tables and stored procedures would be
deleted.
database — Specify the name of the database that is to be
cleared.

Caution ... Clear Database should be used with carefully because it

permanently clears all data.

The username used to run clear database should be the Sybase/ENVOX

user name of a suitably privileged user. This user must be either the
owner of the database (user “envoxutility”) or the system administrator
(user “sa”). It is recommended that “envoxutility” be used.

Note ... The databases — master, tempdb, envox_readonly, model,

sybsystemprocs, and sybsecurity — cannot be cleared.
B

B.1.5 Create ENVOX Database

Use this utility to create an ENVOX or envox_readonly database.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 158 Appendix B F Command Line Executables

create_envox_db /S[:]SYBASE /P[:]password [/L]

databaseName

where

/S — Specify a SYBASE Server to use.

SYBASE — The name of the SYBASE Server.
/P — Defines the sa password.
password — The sa password.
/L — Use this switch if the database has already been created,
and you wish to load the ENVOX tables and stored
procedures into it.
databaseName — Specify the name of the database that is to be
created.

Example of creating an ENVOX database:

create_envox_db /S:TUBAL /P:sapassword ENVOXDB

Example of creating an envox_readonly database:

create_envox_db /S:TUBAL /P:sapassword envox_readonly

By default, the create database utility uses a script file to create the
database prior to loading it with the ENVOX tables and stored
procedures. It looks for the script file in the directory, Program
Files\Frsi\ControlDesktop50\dbscripts. The script file name should be of
the format dbname.tsql.

If the database has already been created, the \L option should be used
to load the ENVOX tables and stored procedures into the database.

B.1.6 Dump Database

Use this utility to dump an ENVOX database to a tape or dump device.

dump_database /S[:]SYBASE /P[:]password database

dumpDevice

where

/S — Specify a SYBASE Server to use.

B SYBASE — The name of the SYBASE Server.
/P — Defines the sa password.
password — The sa password.
database — Specify the name of the database that is to be
dumped.
dumpDevice — Specify the name of the SYBASE dump device.

Example of dumping an ENVOX database:

dump_database /S:TUBAL /P:sapassword ENVOXDB dumpdev1

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Command Line Executables F Appendix B 159

B.1.7 Load Database

Use this utility to load an ENVOX database from a SYBASE dump

device.

load_database /S[:]SYBASE /P[:]password

[/R[[:]RedoStoredProcs]] [/T[[:]TransferDB]] database
dumpDevice

where

/S — Specify a SYBASE Server to use.

SYBASE — The name of the SYBASE Server.
/P — Defines the sa password.
password — The sa password.
/R — Specify whether stored procedures should be recreated.
RedoStoredProcs — Valid values are YES or NO.
/T — Use to specify if database users are to be tidied up for
cases where the database is transferred from another
server.
TransferDB — Valid values are: YES : Tidy up database users;
NO: Do not tidy up database users.
database — Specify the name of the database that is to be
loaded.
dumpDevice — Specify the name of the SYBASE dump device.

Example of loading an ENVOX database:

load_database /S:TUBAL /P:sapassword ENVOXDB dumpdev1

B.1.8 Transfer a Database with PDX

Note ... It is highly recommended that you read Section 9, Using PDX to
Transfer and Backup Databases, before attempting to use this
utility. A good understanding of the design of this utility can
prevent errors in using it.

The command line syntax of the PDX utility is: B

PDX [/q] [/s] [/v] [/w] source [/f[:]sourceFileName]
[/S[:]SYBASE /D[:]DATABASE /P[:]password] target
[/f[:]targetFileName] [/C[:]CDOS /S[:]SYBASE
/D[:]DATABASE /P[:]password]

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 160 Appendix B F Command Line Executables

where:

/q No validation
/s Print summary details
/v Validate database without doing a PDX transfer
/w Stop on warning

source Defines the source as file or database

/f Specify source file name

sourceFileName
Name of the source file if parameter 1 is file
/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
/P Defines the sa password
password The sa password

target Defines the target as file or database

/f Specify target file name

targetFileName
Name of the target file if parameter 2 is file
/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
/P Defines the sa password
password The sa password

Examples of running PDX

To dump a database to a PDX file :

pdx database /S:SYBASE /D:ENVOXDB /P:database file

/f:ENVOXDB.PDX

To load a database from a PDX file :

B
pdx file /f:ENVOXDB.PDX database /C:CDOS/S:SYBASE
/D:ENVOXDB /P:database

To validate a PDX file and list summary details without doing a PDX
transfer :

pdx /s/v file /f:ENVOXDB.PDX file /f:nul

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Command Line Executables F Appendix B 161

This example shows that when doing a validation/summary of a PDX file

you may want to specify the nul device as the destination. Using the nul
device prevents the utility from creating an empty file that you have to
delete.

B.1.9 Downloading a Device

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]

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

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

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 162 Appendix B F Command Line Executables

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.

B.1.10 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:

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.

B B.1.11 Check Database Consistency

Use this utility to run database consistency checks.

db_check /S[:]SYBASE /P[:]password /F[:]outputFile

[/d] [/a] [/m[[:]DBMode]] database

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Command Line Executables F Appendix B 163

where

/S — Specify a SYBASE Server to use.

SYBASE — The name of the SYBASE Server.
/P — Defines the sa password.
password — The sa password.
/F — Specify the file to send the output to.
outputFile — Output file name.
/d — Flag to indicate whether database consistency is to be
checked.
/a — Flag to indicate whether allocation consistency is to be
checked.
/m — Flag to indicate which user mode the database should be
placed in.
DBMode — Valid values are ’s’ for single user mode and ’m’ for
multi-user mode. The default will be single user mode.
database — Specify the name of the database that is to be
checked.

Example of checking database consistency:

db_check /S:TUBAL /P:sapassword /F:c:\dbcheck.out /d

/a /m:m ENVOXDB

B.1.12 Generate Devices

Use this utility to generate devices.

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

/U[:]USERNAME /P[:]password [/J[:]jobNumber]
[/T[:]deviceTag]

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. B
/P — Defines the ENVOX user’s password.
password — The ENVOX user’s password.
/J — Use to specify the job number
jobNumber — The job number.
/T — Use to specify the tag of the device to generate.
deviceTag — The device tag.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 164 Appendix B F Command Line Executables

When running this utility from the command line, do not use the /J
switch. The /J switch is for use when this utility is run by the Client Task
Daemon on behalf of the Control Desktop Verify/Generate Application.

Example of generating a device:

vgexec /C:CEDOS_NTTGT /S:TUBAL /D:ENVOXDB /U:SMITH

/P:password /T:MYDEVICE

B.1.13 HART Instrument Locator Tool (HILT)

Use this utility to locate HART channels and produce a HILT file for AMS.

hilt /S[:]SYBASE /D[:]DATABASE /U[:]USERNAME

/P[:]password [/H[[:]HiltFile]] [/F[:]Inc/ExcFile]

where

/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.
/H — Use to specify the name of the HILT data file which will be
produced.
HiltFile — If no file name is specified, the default name of
HILT.DAT will be used.
/F — Use to specify the name of an inclusion/exclusion file
Inc/ExcFile The name of a file which defines which parts
of the PROVOX configuration are checked for HART
channels.

The HILT Utility may generate a list of more HART Channels than your
AMS Database size can accommodate. Use an “Inclusion/Exclusion” file
to limit search addresses to reflect your AMS database size.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Command Line Executables F Appendix B 165

Example of an Inclusion/Exclusion File:

; Inclusion/Exclusion file for Company XYZ

; Only consider Highway 6..

+6-*-*-*

; But not Device 5..

-*-5-*-*

; The exclusion could have been -6-5-*-*, but it

; works as it stands because only devices on
; Highway 6 are included.
; Also, only one extra card is wanted which is
; not anywhere in Highway 6.

+4-5-10-9.

B.1.14 Import Items

Use this utility to import and item, or items, into an ENVOX database.

Import /S[:]SYBASE /D[:]DATABASE /U[:]USERNAME

/P[:]password [/J[:]jobNumber] [/L] [/F[:]folder]

where
/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.
/J — Specify the job number for this export.
jobNumber — The job number.
/L — Load the data into the database. If not specified, the data
will be merged into the database.
/F — Specify the folder (directory) which contains the export set.
folder — Can be a local path (e.g. C:\MyExports\Export1) or a B
UNC (e.g. \\server\share\Exports\Export2).

When running this utility from the command line, do not use the /J
switch. Instead, use the /F switch and optionally the /L switch. The /J
switch is for use when this utility is run by the Client Task Daemon on
behalf of the Control Desktop Import application.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 166 Appendix B F Command Line Executables

Importing a device will cause that device and all its source and target
points to be deleted if the device already exists in the database. If you
are importing a redundant pair of PROVUEr or WPCON consoles you
must ensure they are deleted prior to the import.

B.1.15 Import ASCII FST

Use this utility to replace the instructions of an LCP FST item with the
text held in the ascii_lcp_fsts table.

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

/U[:]USERNAME /P[:]password [/J[:]jobNumber]
[/F[:]FSTTag] [/I[:]ID] [/R]

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.
/J — Specifies the translate job number for this ASCII FST
import.
jobNumber — The job number.
/F — Specifies the tag of the FST whose instructions are to be
replaced.
FSTTag — The FST tag name.
/I — Specifies the id of the FST text in the ascii_lcp_fsts table.
ID — The id name.
/R — Delete data from ascii_lcp_fsts after loading. This is the
default. Use /--R to disable deleting from ascii_lcp_fsts.

This utility is run by the Client Task Daemon using the /J switch on behalf
of the Control Designer translate process and should not normally be run
from the command line. The /J switch cannot be used with the /F or /I
switches (or vice versa). Both /F and /I are required if either is specified.
B

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Command Line Executables F Appendix B 167

B.1.16 Export Items

Use this utility to export an item, or items, from an ENVOX database.

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

/U[:]USERNAME /P[:]password [/J[:]jobNumber]
[/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.
/J — Specify the job number for this export.
jobNumber = The job number.
/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 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 — The tag name.

When running this utility from the command line, do not use the /J
switch. Instead, use the /F and /X switches together with either the /W
switch or the /T switch. The /J switch is for use when this utility is run by
the Client Task Daemon on behalf of the Control Desktop Export
application.
B

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 168 Appendix B F Command Line Executables

B.1.17 Load ENVOX SQL

Use this utility to load an SQL file into an ENVOX database.

load_envox_sql /f[:]fileName [/l[[:]logFile]] [/v]

/S[:]SYBASE /D[:]DATABASE /U[:]username /P[:]password

where

/f — Input file name

fileName — File to load into the database
/l — Log output to file
logFile — File to log messages to
/v — Verbose logging
/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 username.
username — The username.
/P — Defines the user’s password.
password — The user’s password.

B.1.18 Populate HACL

Use this utility to update the Highway Access Control List (HACL) by
adding all points targeted to Consoles with Global Ack Alarms enabled
(or targeted to all Consoles depending on the /T switch) that are not
already in the HACL. Update the HACL is required for the Console
Global Alarm Acknowledge feature to work properly.

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

/U[:]USERNAME /P[:]password [/T[:]targetType]

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..
B 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.
/T — Use to define criteria to be used for the HACL populate.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Command Line Executables F Appendix B 169

targetType — Valid values are ’ALL CONSOLES’ to populate

points targeted to all consoles or ’GAA CONSOLES’ to
populate points targeted to consoles with GAA enabled.
The default will be ’GAA CONSOLES’.

Example of populating HACL with points targeted to Consoles with GAA

enabled:

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

/U:SMITH /P:password /T:”GAA CONSOLES”

B.1.19 Populate NT
Use this utility to populate the ’need_to’ tables for a specific device tag or
all device tags in a database.

populate_nt /S[:]SYBASE database [deviceTag]

where

/S — Specify a SYBASE Server to use.

SYBASE — The name of the SYBASE Server.
database — Specify the name of the database where ’need_to’
tables are to be populated.
[deviceTag] — Specify the device tag to be populated into
’need_to’ tables.

Example of populating the ’need_to’ tables for a specific device:

populate_nt /S:TUBAL ENVOXDB SH-SR90

Example of populating the ’need_to’ tables for all devices in the

database:

populate_nt /S:TUBAL ENVOXDB

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 170 Appendix B F Command Line Executables

B.2 Command Line Structure

The general structure of a command line is:

progname /S /T:value /-U param1 /V /W:value /-X

Where

progname — Program name

/S — Global switch (no value)
/T:value — Global switch (with value)
/--U — Global switch (undefined)
param1 — a parameter
/V — Parameter switch (no value)
/W:value — Parameter switch (with value)
/--X — Parameter switch (undefined)

B.3 Understanding Switches and Parameters

The following information will help you understand the use of switches in
the command lines available in Control Desktop and ENVOX Server.

B.3.1 Command Line Switch Format

The format of a command line switch is: /-A[[:][”]value[”]]

The switch letter (A) is a single, case-sensitive alphabetic character.

Where the switch parameter value contains white space, it, or the entire
switch definition, must be enclosed by double quotes. Also, if value
contains quotes (”) or slashes (/), then the quotes or slashes must be
preceded by a backslash (\).

For example:

my tag/2 is entered as “my tag\/2” on the command line

val”ue is entered as val\”ue on the command line

Switches need not be separated by white space. The first switch in a

command line can be “run into” the program name; that is, white space is
not required between the program name and the switch’s opening
B forward slash.

An optional minus sign (--) before the switch letter is used to make the
switch undefined. If the switch is mandatory, the application will indicate
such unless the switch is defined later in the command line. Any value
specified when a switch is being undefined in this way will be ignored.

Undefining a switch is useful if the environment variable CDSWITCHES

contains a switch that you do not want to use for a particular command
instance. See subsection B.3.3 for more information on CDSWITCHES.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Command Line Executables F Appendix B 171

The minus sign cannot be used instead of the slash to introduce

switches.

B.3.2 Command Line Arguments

Each command line argument is either a switch or a parameter. Switches

always begin with a forward slash “/”. All other arguments are taken as
parameters. Therefore, user entered parameter values must not start
with a slash since they would be indistinguishable from switches.

A switch that occurs before the first parameter is a general switch that
modifies the whole program’s behavior. A switch that occurs after any
parameter applies to the parameter immediately before it on the
command line, or if that switch letter is not relevant to that parameter it is
treated as a general switch. Therefore, multiple occurrences of the same
switch letter can be included to alter the behavior of the application with
regard to multiple parameters as illustrated below:

tool file1.txt /a:rw file2.txt /a:r

A general switch can be placed anywhere along the command line, as

long as the switch’s letter is not a valid switch letter for the parameter
immediately before it.

Parameters are order sensitive. That is, the first non-switch argument is
parameter 1, the second non-switch argument is parameter 2, and so
forth. Parameters must be preceded by white space to separate them
from the program name or any other command line arguments.

Switches can be “run into” the end of a parameter in the same way that
switches can be run into the end of the program name.

B.3.3 Defining Switches

Switches can be defined in several ways.

J An application can define default values for its switches.

In the case of switches used to allow the specification of CDOS and

SYBASE server names and the database name, default values are
taken from the registry (set by the user from Server Setup). B
J An environment variable ”CDSWITCHES” can be set up containing
switches that are implicitly typed on the command line.

This variable is typically used to define common login arguments,

such as: CDOS server name, SYBASE server name, username,
password, and database name. Typically, this will be a user variable;
not a system variable.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 172 Appendix B F Command Line Executables

The command to set the switches is:

set CDSWITCHES=”/C:CDOS /S:SYBASE /U:USERNAME

/P:password /D:DATABASE”

Normally, this environment variable would be set in batch files or

manually at the DOS prompt as a short term measure. It would not
normally be defined in the “System Properties” Control Panel applet
(Environment tab).

Any switch can appear in CDSWITCHES. An application will

automatically select the ones it wants for each context (global,
parameter 1, parameter 2, etc.) and ignore others.

Selection is governed as follows:

j If a switch in the environment variable has a value (e.g.

/S:value), the switch is selected by the application in every
context where a switch with the same letter exists, as long as the
application’s switch will accept a value.

j If a switch in the environment variable does not have a value

(e.g. /S), the switch is selected by the application in every
context where a switch with the same letter exists, as long as the
application’s switch does not require a value (that is, if the switch
does not have a value, or if it does have a value but the value is
optional).

j If a switch in the environment variable is undefined (e.g. /-S), the

switch is selected by the application in every context where a
switch with the same letter exists, regardless of whether the
switch has a value or not.

These rules are designed to mitigate any problems caused by an

application using a switch letter that is commonly found in
CDSWITCHES for a different purpose. For example, an application
might use a /D switch to enable some particular behavior, yet it is
likely that CDSWITCHES would contain /D:ENVOXDB. This switch
would not be selected because the application does not expect a
value.

The final method for defining switches is to enter them on the

B
J
command line.

If a switch appears more than once in a single context on the command

line, then only the right-most version is used. The precedence of
switches is as follows (most favored to least favored):

1. Right-most definition of the switch on the command line.

2. Value from CDSWITCHES environment variable.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Command Line Executables F Appendix B 173

3. CDOS server and SYBASE server names values from registry.

4. The application’s default value.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 174 Appendix B F Command Line Executables

Blank page.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 System Architecture F Appendox C 175

Figure C-Table C

Appendix C
C System Architecture
Many architectural enhancements are included in ENVOXr Server and
Control Desktop, version P5.0, over previous versions of ENVOX
configuration software and Control Desktop to provide an easy to use
configuration system on an NT Windows platform.

C.1 Architecture Overview

Figure C-1 illustrates the system architecture. For clarity, the figure
shows only some of the modules and utilities contained in ENVOX
Server and Control Desktop.

Client applications provide the user interface, and are part of Control
Desktop. For this release of ENVOX Server and Control Desktop, all
user configuration interfaces are through Control Desktop. The user
interface to the system diagnostics application is through the WEB
Browser and the WEB Server.

As shown in the figure, the system architecture makes extensive use of

daemons. These are used to obtain a similar level of flexibility for
configuration activities on NT machines as is available on previous
ENVOX releases running on OpenVMS and HP-UX machines.

As previously stated, not all items are shown because the figure would
be too complicated. There are several more Client Task Daemons than
the ones shown. Other sections of this manual describe their use. Also,
some direct connections such as the one from Control Designer to the
SYBASE server and the Open Client connection from PDX to the
SYBASE Server are omitted for additional clarity.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 176 Appendix C F System Architecture

Client Applications

User Control Display Client Trace/ Task

Interface Designer Designer Admin Tune Monitor

Client Task CHIP Daemon

Daemon Verify/ Diagnostic Applications
Applications
Generate Daemon

Device
Rename Revision
Daemon

Client Trace/
Task PDX Tune
Daemon Daemon

ASCII
FST Upload
Import CHIP
Task
Daemon
Import/
Downloa
Export
d

CDOS CHIP

Server Task SQL Anywhere

Daemon Server
Applications Task
Daemon

WEB
Create Load
Load Populate Upgrade Server
ENVOXr ENVOX
Database NT Database
Database SQL

C WEB
Browser
SYBASE Server
System
Diagnostics

Figure C-1. ENVOX Server P5.0 and Control Desktop P5.0 Architecture

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 System Architecture F Appendox C 177

C.2 Types of Daemons

Daemons perform the configuration tasks. They are grouped according
to the work that they do. By grouping them as such, they closely
correspond to the various configuration system components which you
can install. There are three groups: Client Task Daemon, Server Task
Daemon, and CHIP Daemons. The daemons are run as NT services.

C.2.1 Client Task Daemon

In general, the Client Task Daemon runs client tasks or applications.

These are usually configuration-related utilities such as Verify/Generate,
Rename, and Import/Export, and PDX. Figure C-1 shows examples of
utilities classed as client task.

Every user-interface client in the system defaults to use the Client Task
Daemon installed on its own machine. The user-interface client refers to
Client Task Daemons by machine name. In effect, then, the name of the
machine on which the daemon is running is the name of the daemon.

When a Client Task Daemon registers with CDOS, the configuration file
instructs the daemon as to which CDOS to register with and where to
place the log file. It is not possible to manually instruct the daemon to
register with a particular CDOS.

C.2.2 Server Task Daemon

In general, the Server Task Daemon runs non-configuration operations
on a configuration database such as dumping, loading, and upgrading.
Figure C-1 shows examples of utilities classed as Server Task.

Both the registration of a server task with CDOS and identification of the
task is by SYBASE sever name. There is a one-to-one relationship
between a SYBASE server and a Server Task Daemon. When you
perform a task and specify the SYBASE server, the server also specifies
which Server Task Daemon to run.

C.2.3 CHIP Daemons

CHIP daemons run on the same machine as CHIP because they need to
“talk” to the PROVOXr highway. There are three types of CHIP
Daemons: CHIP Task Daemon, Diagnostics Daemon, and Trace/Tune C
Daemon.

The CHIP Task Daemon only performs database upload and download.
In a normal system setup, you have only one active CHIP Task Daemon
running at a time. Diagnostic Daemons are the Diagnostic Daemon itself

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 178 Appendix C F System Architecture

and the Device Revision Daemon. Only one runs at a time, so

identification is by daemon type.

The Trace/Tune Daemon allows CDOS and the LCP Trace/Tune client to
“talk” to the PROVOX highway. The daemon is responsible for all
highway access and also for polling the target controller for the values
which the client needs to have updated. Only one runs at a time, so
identification is by daemon type.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 History 179

History
The list below shows the printed manuals available for each version of
ENVOX 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

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 History

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 180 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

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

History
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

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 History 181

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

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 History

TR1.0:SW3151 (Revision F — July 1996) D2R00481602

J ENVOX Tutor
TU4.14:SW3151 (Original — June 1991) D2T00481002

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 182 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

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

D2U01721002

Control Desktop P1.0

J Installing and Using Type SW3311 Control Desktop,

History
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

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 History 183

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

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 184 History

Blank page.

History

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Glossary 185

Glossary
Address Audit Trail
One or more integers arranged to identify A record of changes made to the
the location of a device or logical unit of ENVOXr database and to the system
an instrumentation system. In PROVOXr where the database resides. The record
systems, address values identify such includes the type of change, when the
things as data highway, device, file, card, change was made and who made it.
and channel.
Backup Server
AI The SYBASE server used exclusively for
Acronym: Analog Input database backup (dump) and recovery
from a backup (load). See Dataserver.
Analog Input (AI)
A PROVOX point type. An analog input CDOS
point receives a single analog value, the Acronym: Control Desktop Open Server.
process variable.
CDV
Analog Output (AO) Acronym: Comma Delimited Values
A PROVOX point type. An analog output
point generates a single analog value, CHIP
the setpoint. Acronym: Computer/Highway Interface
Package
AO
Acronym: Analog Output Client Task Daemon
The Client Task Daemon is part of the
ASCII CDOS software. It is responsible for
A PROVOX point type. An ASCII point handling tasks such as generate,
contains a single real value, referenced download, rename, import, export, and so
by the setpoint attribute, and an on. In most situations, the Client Task
80-character ASCII string. Daemon resides on the client
workstation, though it is possible for it to
Attribute reside on a different machine.
An individual parameter of a process
control point. Also the name of a Comma Delimited Values Format
PROVOX data type. In some systems, An ASCII version of configuration data.
points have just one or two attributes; The configuration data are in a specific
however, points in PROVOX systems order, separated by commas. CDV-format
have many. Accordingly, each point of a files result from both the export utility and
PROVOX system commonly provides the the migrate utility.
control of four or five non-PROVOX Glossary

system points.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 186 Glossary

Computer/Highway Interface Current Resource

Package (CHIP) In Control Designer, this is the resource
A PROVOX software product that allows which you selected in the Select Project
user-written programs to interact with the Database dialog box. It is displayed in
PROVOX database. There are different the Control Designer project tree.
CHIP versions, so that any of several
types of computers can be the host Database
computer. A collection of tables, indexes, rules,
procedures, and user accounts, which
Conditionals comprises a complete data set.
Console display elements that change
color or present messages based on a Database Index (DBI)
change in a point attribute. A sequential integer by which a computer
or other electronic device finds or keeps
Context Menu track of storage locations in a database.
A special menu appears when you click
the right mouse button (or left mouse Databook
button if you have reversed the mouse The Databook provides information on
buttons). This menu contains options each function and function block in the
specific to your current level in Control Control Designer database. Each entry in
Desktop. These options are shortcuts to the Databook shows the graphic for the
commands you can run on whatever item selected element along with additional
you have currently selected within information such as inputs and outputs.
Control Desktop or one of its modules.
Dataserver
Control Designer The SYBASE SQL server used for all
The Control Designer module is a tool database operations, except database
you can use to create control strategies backup. See Backup Server.
for PROVOX controllers graphically,
using a Function Block language. All
Control Designer data are held in the
Datatype
ENVOX database. Determines the rules that entries for
specific columns must follow.
Control Sequence
A type of primary control algorithm which
DBI
Acronym: Database Index
provides basic functions such as alarms,
data communication, tracking, and error
signal calculation, but does not provide
any form of control action. This allows the
user to create a customized control
algorithm transfer function using FST
instructions.

Glossary

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Glossary 187

DBMS Discrete Control Device (DCD)

Acronym: Database Management A PROVOX point type. A DCD point
System. The DBMS manages user encompasses as many as 8 discrete
requests (and requests from other output and 16 discrete input channels
programs) so that users and other into a single point. This makes possible
programs are free from having to 16 setpoints and matching input/output
understand where the data is physically states. A common use for a DCD point is
located on storage media and, in a to control a discrete device that provides
multi-user system, who else may also be feedback about its status. If the point
accessing the data. works with a DCD template, it can use
different combinations of channels at
DDP different times during the execution of a
Acronym: Detail Display Parameter. process-control algorithm.

Detail Display Parameter (DDP) Discrete Input (DI)

An item of information usually considered A PROVOX point type. A DI point
changeable or tunable for a control loop monitors a single discrete value of the
or point. Common examples are gain, process variable. That is, a DI point reads
rate, reset, and alarm trip points. discrete data from a sensor or other
system device.
Device
An item that you can create in Control Discrete Output (DO)
Desktop. The types of device you can A PROVOX point type. A DO point
create are AI, Alarm Priority, AO, generates a single discrete value
FieldVUE AO, Application or CHIP referenced by the setpoint.
devices.
Display Designer
Diagnostics A module that enables you to create
A module of Control Desktop designed mimic display diagrams using a graphical
for maintenance users responsible for Windows interface. You can save the
maintaining the availability and operability displays to file, and can save them to an
of a system once it is in operation. It is ENVOX database so that they can be
particularly useful in resolving plant viewed on a PROVUE or Operator
integrity problems. Diagnostics can be Workplace console.
run remotely.
Download
Diagram Extent To transfer configuration instructions and
The area of the window that encloses all reference information from a
the blocks that have been placed on the configuration device to other devices of a
diagram is the extent of the diagram and process control system.
is indicated by a blue dashed line. The
diagram extent has a minimum size of
one page.

Glossary

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 188 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.

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

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Glossary 189

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
into an ENVOX database from CDV file
format.

Information stream
The first stream in a CDV file.

Glossary

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 190 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 and not the Open database
points, and templates. load utilities embedded in ENVOX
software.
Join
Locks
A join combines data from multiple tables
A software-initiated action on a database
into a single result table by comparing the
table. The database software locks tables
values from specified columns. You can
that are being affected by a process. The
use joins in an SQL statement to produce
ENVOX administrator can determine
a custom report in Report Writer.
which processes are locking which
tables.
Kernel
The lowest layer into which a large
Log
operating system is divided -- each layer
A record of events that have occurred
handles some aspect of the system
within the database. A log may consist of
hardware. ENVOX Server and Control
successful and unsuccessful events and
Desktop uses a CHIP kernel.
any error or warning messages related to
those events.
LCP
Acronym: Logic Control Point
Logic Control Point (LCP)
A PROVOX point type for an advanced
LCP Trace/Tune batch or multifunction controller, such as
Integrated module that enables you to a UOC or IFC. A role for a multivariable
debug the control strategy of an LCP point, an LCP calls a programmed
point by viewing the functions sequence subroutine defined by an FST. As
tables it uses. configured, the LCP activates the FST in
a continuous loop, as a single shot
Legacy Subroutine FSTs program, or as required as part of a
The Control Designer module supports control loop.
legacy subroutine FSTs which return a
single value to be used from within
programs. This support also lets user
functions map signals into and out of a
Glossary
legacy subroutine FST.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Glossary 191

Logic Editor Multiple Document Interface (MDI)

A module integrated into Control Desktop In a Multiple Document Interface (MDI)
that you can use to create and edit logic application such as Control Desktop, you
items. can open several windows at the same
time and work on the contents of those
Logical Device windows. In Control Designer, when you
A designated area on a disk for have several program diagrams open at
databases and transaction logs. A once, you can cut and paste between the
database and its related transaction log diagrams with ease.
should not be on the same physical
devices, if possible. Name
A unique identifier for any device or
Loop logical unit of an operations console
A PROVOX point type. A loop point system except a point or a controller
provides control for a continuous (points and controllers have tags instead
process. Loop points have many of names).
attributes, so can provide very
sophisticated control. Bias or ratio factors Null
often can be added to loop points. Having no assigned value. In a CDV file,
null is represented as two commas with
Master Database zero or more spaces in between.
The central database which holds details
of all of the other databases. It is created Operand
by SYBASE when SYBASE is installed. 1. In the language editor, a value that
modifies or qualifies a function.
Matrix 2. In ASCII configuration source files, an
A means of displaying data in column expression, a simple operand, a phrase
format in Control Desktop, so that you list, or an operand list.
can quickly and efficiently configure large
amounts of items. (Item types Loops and Operation Parameters
EDCDs can be configured in Excel The 32 unit variables that contain default
Matrix.) grade values. Operation parameters are
common to all phases of an operation.
Migrate
The process of converting PROFLEX Option Button
configuration data into CDV file format, A button that excludes other options
from which the data can be imported into when you select it. Option buttons are
an ENVOX database sometimes known as radio buttons.

Model Database
The database which is used as the basis
for a new database. It is created by
SYBASE when SYBASE is installed.

Glossary

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 192 Glossary

PDF Point
Acronym: PROVOX Display Format. An A set of process-control parameters and
ASCII tab-delimited file format in which data. The makeup and structure of each
Display Designer can store displays. point depends on its role in collecting and
These can then be viewed using the reporting data and the type of device in
ViewPDF utility. which the point resides. Points are the
Acronym: Adobe Portable Document most important logical units of a process
Format control system; the number of points is a
measure of the system’s size and
sophistication.
PDX (Portable Database Transfer)
Utility for transferring ENVOX databases A software building block for a
between computers, and performing configuration in which resides the
database backups. This is the only information from the process-control
mechanism for transferring complete database, such as data and the action
databases, including download data, necessary to perform a particular control
between different computer platforms. task.

Plant Area Populate HACL

The collection of equipment in a plant Control Desktop utility to automatically
that has common manufacturing add all points that are targeted to
strategies and alarm strategies. consoles to the Highway Reference List,
if the points are not already in the list.
Plant I/O Explorer
A database view launched from the PPA
System Explorer that expands to show Acronym: Plant Process Area
the PROVOX Network Highway.
Primary Control Algorithm (PCA)
Plant Management Area (PMA) The principle control equation of a
A collection of plant process areas continuos loop in a PROVOX system.
(PPAs). A PMA controls the console point The PCA type and station (STA) type
reporting load, and indirectly, central defined during configuration determine
processing unit (CPU) loading. the main functionality of a point.

Plant Process Area (PPA)

Within a process-control system, a
collection of equipment that uses a
common alarm strategy.

PMA
Acronym: Plant Management Area

Glossary

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Glossary 193

Process Project Tree

A user-initiated action that affects or The structure of a project. Each level of
accesses a database. Each process the tree which contains subitems is called
represents one connection to the server. a branch. A level which contains no
An ENVOX user typically has three to five subitems is called a leaf. You can expand
processes active at one time. Adding a or collapse the branch of the item.
point, generating files, and downloading
files are examples of processes. As PROVOX Display Format (PDF)
ENVOX server administrator, you can ASCII-based format used for operator
determine which users have initiated screen displays on PROVOX system
which processes. consoles.

Program Diagram PSR file

A software entity built using the Control A file that contains a report saved from
Designer Function Block Editor, which Report Writer in a proprietary format.
becomes a function sequence table in an When you save a report as a PSR file,
ENVOX database and in the SR 90 and you can open the PSR file from Report
SRx controllers. A program diagram Writer and review it.
defines a control strategy.
QRY file
Project File A file that contains an SQL query that
A file within Control Designer that you use to generate a custom report in
contains all the elements that make up a Report Writer. When you save a query in
control strategy. A Control Designer a QRY file, you can open the QRY file
project maps directly to an ENVOX from Report Writer and use it to generate
database. A Control Designer project is another custom report.
associated with a single ENVOX
database, and an ENVOX database is
associated with one project. Real
A PROVOX point type. A real point has a
single real (floating-point) value
Project Administrator referenced by the setpoint.
One who has the administrative privilege
to determine the Control Desktop
features which a user can have (for Rename
example, read-only or write) through Enhanced ENVOX rename functionality
client administration. The project supports rename of tags in all
administrator of a database can grant configuration tables including Control
and revoke user access to that database, Designer tables.
according to a project requirements of the
user. Report Writer
An integrated module used to order, view
Project Engineer and print reports for certain Control
A user that has read and write access to Desktop levels.
the database by default but cannot
control the access that other users have Resource
to the database The project administrator Resource is an IEC term equivalent to a
Glossary
controls exactly which tasks a project PROVOX SR90 or SRX controller.
engineer can do within a database.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 194 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
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
Glossary
standard functions. that shows the information to an operator.

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Glossary 195

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.
configuration. [See Alias Template, DCD
Template, and Group Template.]

Glossary

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 196 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

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Index 197

Index

recovery, 73
server, 24, 47
Numbers altering existing table structure, 128
2521 and 2540 errors, 77 application locks, viewing, 47
archiving, Audit Trail log, 108
Audit Trail, setting up, 103
audit trail
A Event Failure Handling, 107
recording options, 104
abbreviations used in manual, 17 setting up and maintaining, 107
access audit trail administration, 129
by account, 33
customizing, 40 audit trail enable action number, 103
granting, 39 Audit Trail log
revoking, 44 archiving, 108
accessing another database, 130 truncating, 109

accessing isql command, 91

account
administration, 34
Control Desktop User, 34
B
daemon, 33
backup, frequency, 73
Machine User, 34
Backup Database menu option, 81
accounts created at installation, 33
backup methods
Ad Hoc Updates recording option, 106
checking master database, 79
Add Database, special considerations, 63 checking user database, 76
Add Dump Device database
creating special directory, 89 description, 75
menu option, 89 using operating system commands,
84
Add Logical Device menu option, 69 using the pull-down menu, 83
Add User, menu option, 39 SYBASE created databases, 82
troubleshooting, 90
administering logical devices, 69
backup server, stopping and starting
administration
command, 91
client, 27
database backup, 73 Backup server, stopping and starting, 91
Diagnostics, 28 begin transaction command, 134
of databases, 55
Index

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 198 Index

C D
checking master database integrity, easiest daemon, 33
way, 79 setting for Client Task, 53
checking user database integrity, easiest DAT cartridge tapes, 30
way, 77
Data Workbench, 127
clearing a database, 111
database
Client administration, 27 administration, restricted commands,
menu items, 28 36–38, 40
Client Task Daemon, 53 attributes, 56
backing up, 81
command files, 135 backup and recovery troubleshooting,
command lines 90
accessing isql, 91 backup frequency, 73
Add Dump Device, 89 changing default, 45
backup server start and stop, 91 checking, 76, 79
database backup, 84 checking master before backup, 79
database recovery, 87 checking user before backup, 76
dataserver start and stop, 48 clearing, 111
dump database, 84 copying, 61
entering, 17 creating, 60
load database, 87 deleting, 63
logging in ISQL, 127 envox_readonly, 59
output file error messages, 78 ENVOXDB, 59
PDX command line syntax, 98 house keeping, 112
searching output file, 81 housekeeping, 112
starting ENVOX software, 23 ISQL operations, 129
stopping and starting the backup server, management utilities, 111
91 Master, 59
tempdb size increase, 121 Model, 59
user database check, 78 query and modify, 127
recovering, 86
command prompt styles, 17
renaming, 62
commands, use of return key, 17 space used, 58
compatibility, ENVOX, 30 structure, 63
Sybsystemprocs, 59
consistency check utilities, 76, 79 Tempdb, 59
Consistency Checks menu option, 76 transaction logs, 124
conventions, typographical, 17 database access methods, 135
creating tag sets, 135 database administration, 55
cross reference conventions, 17 database consistency, effect of severe
errors, 76
current database, which one?, 130

Index

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Index 199

database information, viewing, 55

database properties, 29
E
database structures, 64
database tables, develop your own, 127 entering command lines, 17
database transfer, 93 ENVOX compatibility, 30
limitations, 93 ENVOX document list, 19
supported paths, 93
ENVOX table letter case, 129
database triggers. See modify database
ENVOX version for this manual, 13
databases, created automatically, 59
ENVOX_DEV1, 69
dataserver
stopping and starting, 48 ENVOX_DEV2, 69
stops functioning, 125 envox_readonly, 59
DBCC, consistency checks, 76 envox_readonly transaction log, 124
default database, changing, 45 ENVOXDB, 59
default database name, 128 ENVOXDB transaction log, 124
delete commands, 129 errors, getting help, 113
Delete Dump Device, menu option, 89 event, recording, 104
Delete Logical Device, menu option, 72 Event Failure Handling, 107
Revoke User Access menu option, 44 event tracking, 103
deleting rows, 128 examining database table structure, 130
determining table columns, 131
devices value, initial value, 69
Diagnostics administration, 28
F
document history list, purpose of, 13
document list, ENVOX, 19 Field Update recording option, 106
documentation file, location, 30
audit trail, 104 file names, general information, 29
related PROVOX, 20
finding current database, 130
DOCVUE documentation, 21
forms, Recover Database, 86
download
free space threshold, 123
from command prompt, 161
from emergency download file, 162
dump database command, 84
dump database utility, 75
dump devices, 83, 89
dumping, Server databases, 124

Index

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 200 Index

G L
getting help, 21 last chance threshold, 123
getting your attention, 19 letter case, ENVOX tables, 129
load database command, 87
load database utility, 75

H logical device, 57
adding, 69
administration, 69
hardware, not supported, 30
deleting, 72
hardware requirements, 30 viewing, 71
help logical devices, created by software, 69
ISQL, 130
logical devices property sheet, 71
with errors, 113
login
help command output, 130
creating for server, 52
help with system management, 21 deleting on server, 52
History Log recording option, 106 login types, 23
housekeeping databases, 112

M
I
making suggestions, 21
initial passwords, 33 Master database, 59
insert commands, 129 checking, 79
inserting rows, 128 Model database, 59
ISQL master database transaction log, 124
logging in, 127 matrix access, 42
permitted operations, 129
memory
restrictions, 128
allocating, 116
restrictions for using, 127
minimum for sybase server, 116
updateable parameters, 137
user manuals, 127 memory allocation, system tuning, 116
using system commands, 135 memory fill--up, 125
ISQL menu
accessing command, 91 client administration, 28
checking user database, 77 Server administration, 26
ISQL interface, 127 menu options
ISQL queries, 131 Add Dump Device, 89
Add Logical Device, 69
item editing, 41
Index

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Index 201

Add User, 39–46 PDX utility, 93

Backup Database, 81 ENVOX databases, 97
Consistency Checks, 76 PROFLEX databases, 101
Delete Dump Device, 89 performance factors, system tuning, 115
Delete Logical Device, 72
Revoke User Access, 44–46 permitted operations, ISQL, 129
Recover Database, 86 printer, selecting, 113
Users, 39–46
privileges, setting, 39
View Dump Device, 89
View Logical Device, 71 PROFLEX database, 64
View User, 45–46 PROFLEX database transfer, 101
model database transaction log, 124 project administrator, 23
modifying data values, 134 project engineer, 23
modifying database items, 134 properties, database, 29
modifying tag sets, 135
multiple database segments, 63

Q
N queries, ISQL, 131
query database for correct change, 134
network, validating, 51

R
O
reader requirements, 13
options, for server, 50 recording options
output file error message command, 78 Ad Hoc Updates, 106
Audit Trail, 105
description, 104
Field Update, 106
History Log, 106
P Recover Database menu option, 86
password, 127, 135 recovery methods
changing, 35, 36 database
changing for Control Desktop user, 45 description, 75
Control Desktop user, 45 using operating system commands,
envoxutility, 36 87
sa, 35 using the pull-down menu, 86
sa (system administrator), 35–37 troubleshooting, 90
passwords, initial, 33 reporting severe database consistency
errors, 76
PDX command, 98
Index

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 202 Index

restrictions, ISQL, 128 stopping and starting backup server

command, 91
return key, use for commands, 17
structures, database, 64
revision control of manual, 17
suggesting changes, 21
revoke database change, 134
switch parameters, 98, 99
SYBASE, Data Workbench, 127
sybase created databases, 82
S SYBASE locks, viewing, 48
sa, 23 SYBASE name, 135
sa password, 35–37 Sybsystemprocs, 59
searching output file command, 81 sybsystemprocs transaction log, 124
security, system, 33 system tuning, 115
security area, 128
security areas
global items, 38
tag sets, 37 T
select command, 129 tag names without ”!!”, 129
select commands, 129 tag sets
server for security areas, 37
adding, 51 modifying, 135
address, 51 tag sets , creating, 135
connection, 50
creating a login for, 52 tapes
deleting, 51 DAT cartridge, 30
deleting a login, 52 TK50 cartridge, 30
network information, 50 Tempdb, 59
options, 50 extending, 120
setup, 50
tempdb database, error recovery, 120
Server administration, 24, 47
tempdb resizing command, 121
menu items, 26
tempdb transaction log, 124
server database, dumping, 124
threshold method, transaction logs, 123
server processes, viewing, 47
thresholds, last chance and free space,
servers, starting and stopping, 48
123
setup, of server, 50
TK50 cartridge tapes, 30
software, how supplied, 30
transaction logs
software requirements, 30 dumping, 123, 125
space used, 58 error log files, 125
managing, 123
special attention getters, 19

Index

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 Index 203

transaction logs defined, 124 username, 127, 135

transferring databases. See database users, viewing current, 47
transfer
using return key for commands, 17
triggers, database. See modify database
utilities, database management, 111
truncate log on checkpoint method,
transaction logs, 124
tuning adjustments, system tuning, 116
tuning the system, 115 V
Typographical conventions, 17
varchar columns, 129
Verify mode
description, 64
messages, 66, 67
U OFF to ON, 66
ON to OFF, 65
update command, 134
view access, 43
update commands, 129
View Dump Device menu option, 89
user access, 39
View Logical Device menu option, 71
user database, checking, 76
View User menu option, 45
user database check command, 78
viewing database items, 129
user manuals, ISQL, 127
user property sheet, 40
user requirements, 13
user role, 40 W
user scheduled method, transaction logs,
where clause, 134
124

Index

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 204 Index

Blank page.

Index

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
 History 205

Notes

The System Manager’s Guide to ENVOXr Server and Control Desktop (Original — May 2000)
206 History

Notes

The System Manager’s Guide to 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

SM:SW3159