D/3® DCS
Administratorʹs User Guide
UG1.0047.V12.3‐2A
Administratorʹs User Guide
Proprietary Notice
NovaTech Process Solutions, LLC (NovaTech) has exercised great care to ensure that the
information contained in this document is accurate and current, however, no guaranty or warranty
in this regard is given or implied.
The policy of NovaTech is to periodically improve and update its documentation. Therefore, the
information in this document is subject to change without notice.
The information disclosed herein is considered confidential and/or proprietary to NovaTech.
Neither this document nor any information disclosed herein shall be reproduced or transferred in
any manner, in whole or in part, or used or disclosed to others for any purpose whatsoever, except
as specifically authorized in writing by an authorized representative of NovaTech.
This proprietary notice shall not be construed as a warranty of the information herein contained,
nor as a limitation of the right of NovaTech to make revisions thereto.
TotalVision, D/3, D/3 DCS, FlexBatch, and SABL are registered trademark of NovaTech Process
Solutions, LLC. The NovaTech logo is a trademark of NovaTech. Microsoft, MS, Windows,
Windows XP, Windows 2003 Server and Excel are registered trademarks of Microsoft Corporation.
All other brand and product names are trademarks or registered trademarks of their respective
owners.
Copyright © 1982‐2009 NovaTech Process Solutions, LLC.
Administratorʹs User Guide
Contents
Preface ............................................................................................................................................1
Purpose of this Manual...........................................................................................................................................1
Intended Audience..................................................................................................................................................1
Structure of this Document.....................................................................................................................................1
Related Documentation ..........................................................................................................................................2
Safety Notice ..........................................................................................................................................................2
Safety Guidelines ............................................................................................................................................2
ICS 3-304.81 Safety Recommendations..........................................................................................................2
Notification de Sécurité..........................................................................................................................................2
Directives de Sécurité......................................................................................................................................2
Recommandations de Sécurité ICS 3-304.81 ..................................................................................................3
Pre‐Installation Guidelines........................................................................................................5
Overview ................................................................................................................................................................6
Determining Which Nodes Require an Installation ................................................................................................6
Naming the Nodes ..................................................................................................................................................7
Determining the Required Products for a Node......................................................................................................8
CDCM software ..............................................................................................................................................8
DCM Software ................................................................................................................................................8
Console Node Software...................................................................................................................................9
Data Collector Software ................................................................................................................................10
Data Historian Software ................................................................................................................................10
Other Products...............................................................................................................................................10
D/3 Licensing ..............................................................................................................................11
Overview ..............................................................................................................................................................11
D/3 License Files..................................................................................................................................................12
Viewing D/3 License Information........................................................................................................................16
License Types.......................................................................................................................................................17
Frequently Asked Questions.................................................................................................................................17
D/3 Directory Structure.............................................................................................................23
D/3 Directories .....................................................................................................................................................23
The D3App Directory Tree ...........................................................................................................................24
The D3Bin Directory Tree ............................................................................................................................32
The D3SSDB Directory Tree ........................................................................................................................33
The D3Uninstall Directory Tree....................................................................................................................34
The D3Update Directory Tree.......................................................................................................................34
D/3 Tools..............................................................................................................................................................34
File Versioning .....................................................................................................................................................36
Environment Variables.........................................................................................................................................38
UG1.0047.V12.3‐2A i
Administratorʹs User Guide
Installation and Setup...............................................................................................................41
System Requirements ...........................................................................................................................................41
Hardware ROM Revision Table....................................................................................................................42
Installing D/3 Licenses .........................................................................................................................................43
DCM, CDCM and Data Historian Operating System Settings.............................................................................43
Installing the D/3 System Software on Windows Server 2003 and XP Professional Editions .............................51
To install D/3 V12.3 system software: ..........................................................................................................52
Post Installation Procedures..................................................................................................................................63
System Reboot...............................................................................................................................................63
Set up existing user accounts.........................................................................................................................64
Using Active Directory Accounts .................................................................................................................66
Configure D3_Servers...................................................................................................................................66
Configure the Data Historian Server .............................................................................................................67
Configure the Data Historian Server's TCP/IP address .................................................................................68
Configure D/3 Node Manager .......................................................................................................................69
Create Initial CDCM Settings file .................................................................................................................70
Start D/3 ........................................................................................................................................................70
Create Initial CDCM Faceplate groups .........................................................................................................72
Copy Required D/3 Notebook Notes.............................................................................................................73
D/3 DCS Security .................................................................................................................................................74
To assign the “Manage auditing and security log” privilege to a Group:......................................................75
The TotalVision® Registry Servers ......................................................................................................................76
Host Files..............................................................................................................................................................79
DCM Software Installation Procedure..................................................................................................................79
Historian Software Installation on non-D/3 node .................................................................................................80
Historian Software Installation Procedure.....................................................................................................80
Modifying D/3 System Software on Windows Server 2003 and Windows XP Professional Editions.................80
Uninstalling D/3 Software....................................................................................................................................84
Installing D/3 Patches...........................................................................................................................................89
Before installing a D/3 patch:........................................................................................................................89
To Install a D/3 patch: ...................................................................................................................................89
To Uninstall a D/3 patch: ..............................................................................................................................90
Online Upgrades ........................................................................................................................91
Overview ..............................................................................................................................................................91
Pre Online Upgrade Checklist ..............................................................................................................................94
Preparing the Legacy System .............................................................................................................................101
Continuous Database...................................................................................................................................102
SABL Programs ..........................................................................................................................................104
Other PCM Databases .................................................................................................................................104
Custom PCM Tasks.....................................................................................................................................105
DCM Display Groups..................................................................................................................................105
Annunciator Panel Buttons..........................................................................................................................105
TotalVision® Graphics ................................................................................................................................105
FlexBatch™ ..................................................................................................................................................105
SimSuite Pro................................................................................................................................................105
Custom DCM Tasks ....................................................................................................................................105
Deleting Unwanted Files .............................................................................................................................106
Pre Installation Guidelines .................................................................................................................................106
Administrator Privileges..............................................................................................................................106
Disk Image of CDCM .................................................................................................................................106
System Requirements ..................................................................................................................................107
Upgrading PCM Sboot PROMs ..................................................................................................................107
Upgrading PCM I/O PROMs ......................................................................................................................107
UG1.0047.V12.3‐2A ii
Administratorʹs User Guide
Licenses 107
Demo Mode.................................................................................................................................................107
Networking Issues .......................................................................................................................................108
System Functionality During an Online Upgrade .......................................................................................108
FlexBatch™ ..................................................................................................................................................108
SimSuite Pro®..............................................................................................................................................108
Suspending an Online Upgrade ..........................................................................................................................109
Activating the Online Upgrade Procedure..........................................................................................................110
OLU Install Procedure States Diagram .......................................................................................................110
Backing Out of an Online Upgrade ....................................................................................................................112
Starting the Online Upgrade ...............................................................................................................................113
Setup Instructions........................................................................................................................................114
Setup Actions ..............................................................................................................................................115
Selecting OLU Options ...............................................................................................................................116
Upgrading a CDCM vs. Replacing a CDCM .....................................................................................................117
CDCM Upgrade Options.............................................................................................................................117
Copy Options for Legacy Applications and Settings ..................................................................................118
Installation Overview .........................................................................................................................................119
Material Prerequisites to an Online Upgrade......................................................................................................119
Access Network Settings File......................................................................................................................120
Verifying System Prerequisites ..........................................................................................................................121
Operational Prerequisites to an Online Upgrade ................................................................................................123
CDCM—Additional Prerequisites...............................................................................................................123
Verify Operational Prerequisites .................................................................................................................124
DCM Verification .......................................................................................................................................124
PCM Verification ........................................................................................................................................124
Operating System Upgrade.................................................................................................................................125
Archiving Legacy Files ......................................................................................................................................126
Archiving Legacy Files—Location of additional files and utilities.............................................................126
Shortcut Folder Location....................................................................................................................................127
Location of OU Components..............................................................................................................................128
Acquiring the Legacy Application Files.............................................................................................................128
Locating the Windows folder ......................................................................................................................129
Archiving the Legacy Application Files.............................................................................................................129
Archiving Legacy Databases ..............................................................................................................................130
Additional Verification Actions ..................................................................................................................132
Pre-Installation of Legacy Files..........................................................................................................................134
Disconnect This CDCM .....................................................................................................................................135
Automated D/3® Uninstallation..........................................................................................................................136
Activating the D/3® Uninstallation Procedure.............................................................................................137
Resuming the Online Upgrade Procedure ...................................................................................................139
Activating the D/3® 12.3 Installation Procedure ................................................................................................140
D/3® Installation Preparation Instructions...................................................................................................141
Resuming Online Upgrade Procedure .........................................................................................................143
Apply D/3® Software Updates.....................................................................................................................144
License Installation.............................................................................................................................................145
Install License Dongle.................................................................................................................................145
Post D/3 Installation Steps..................................................................................................................................146
CDCM Post-Installation Steps ....................................................................................................................148
DCM Post Installation Steps .......................................................................................................................148
Configuring the Replacement CDCM on the Network ......................................................................................149
Converting the Configuration Table to V12.3.............................................................................................150
Configuring the IP Address.........................................................................................................................151
Renaming the PC to the Previous CDCM name..........................................................................................157
Resuming the Previous In-Progress Online Upgrade ..................................................................................159
Converting Database Text Files on the CDCM ..................................................................................................161
UG1.0047.V12.3‐2A iii
Administratorʹs User Guide
Starting the D/3® ................................................................................................................................................163
Rebuilding I/O Configurations on the CDCM....................................................................................................164
Building New Databases on the CDCM.............................................................................................................165
Rebuild D/3® Applications—Instructions ...................................................................................................165
Rebuild D/3® Applications—D/3 Architect™ Actions ...............................................................................166
Upgraded D/3® Startup Preparation ............................................................................................................167
Establish Console Passwords ......................................................................................................................169
Rename Console Password File ..................................................................................................................169
Configure Node Manager Service ...............................................................................................................170
Disconnect Legacy CDCM.................................................................................................................................171
DCM Upgrade ....................................................................................................................................................172
Automated Preparation for PCM Online Upgrade .............................................................................................173
Performing a PCM Online Upgrade ...................................................................................................................176
Concluding an Online Upgrade ..........................................................................................................................182
Distribute Changes to Network Configuration............................................................................................183
Close Out Online Upgrade ..........................................................................................................................183
Recreate User Accounts and Settings..........................................................................................................184
Uninstalling the Online Upgrade Procedure.......................................................................................................185
Troubleshooting..................................................................................................................................................187
Canceling the OU Procedure.......................................................................................................................187
Location of Setup and OUInstallProc Logs.................................................................................................188
System Messages.........................................................................................................................................188
Error Message Reference ........................................................................................................193
Error Messages ...................................................................................................................................................193
Index ...........................................................................................................................................218
UG1.0047.V12.3‐2A iv
Administratorʹs User Guide
Preface
Purpose of this Manual
This document provides the information necessary to install and operate the D/3 System software.
The information in this manual is subject to change at the discretion of NovaTech Process Solutions,
LLC.
Intended Audience
This document is intended for users who are familiar with the configuration and the operation of
the D/3 System responsible for the installation, licensing and setup of a D/3 system.
Structure of this Document
This document contains the following chapters:
Chapter One Pre‐Installation Guidelines.
This chapter provides pre‐installation guidelines for the D/3.
Chapter Two D/3 Licensing.
This chapter discusses the D/3 Licensing requirements and implementation.
Chapter Three Installation and Setup.
This chapter discusses the D/3 Installation and Setup. Post‐Installation procedures and license
installation are also described.
Chapter Four Online Upgrade.
This chapter discusses how to perform an online upgrade.
Chapter Five D/3 Directory Structure.
This chapter discusses the D/3 Directory Structure.
UG1.0047.V12.3‐2A 1
Administratorʹs User Guide
Related Documentation
Configuration and Management Tools User’s Guide
Continuous Control Package (CCP) Reference Manual
Continuous Control Package (CCP) User’s Guide
Sequence and Batch Language (SABL) Reference Manual
Safety Notice
Safety Guidelines
Control devices can fail in an unsafe condition. This means that unless proper safeguards are incorporated,
certain malfunctions of these devices could lead to unexpected equipment operation. Such unexpected
equipment operation could result in property damage and/or severe physical injury to the equipment
operator. Safety devices and techniques must be used in all industrial control systems to prevent injury to
personnel or equipment. NEMA ICS 3‐304 provides general recommendations, which apply for the design
and installation of systems controlled by automated electronic systems as follows:
ICS 3‐304.81 Safety Recommendations
This section is Consideration should be given to the use of an emergency stop function,
reproduced by which is independent of the programmable controller. Where the operator
permission of the is exposed to the machinery, such as in loading or unloading a machine
National Electrical tool, or where the machine cycles automatically, consideration should be
Manufacturers given to the use of an electromechanical override or other redundant
Association from NEMA means, independent of the programmable controller, for starting and
3‐304 Programmable interrupting the cycle. If the provision is required for changing programs
Controller Standard. while the equipment is in operation, consideration should be given to the
use of locks or other means of assuring that such changes can be made
only by authorized personnel. These recommendations are intended as
safeguards against failure of critical components and the effects of such
failures or the inadvertent errors that might be introduced if programs are
changed while the equipment is in operation.
Notification de Sécurité
Directives de Sécurité
Les dispositifs de commande peuvent faire défaut dans des conditions hasardeuses. Ceci signifie
quʹà moins que des sauvegardes appropriées soient incorporées, certains défauts de
fonctionnement de ces dispositifs pourraient entraîner un déclenchement inattendu du matériel. Un
UG1.0047.V12.3‐2A 2
Administratorʹs User Guide
tel déclenchement inattendu du matériel pourrait causer des dégâts au matériel et/ou des lésions
physiques graves à lʹopérateur du matériel. Des dispositifs et techniques de sécurité doivent être
employés dans tous les systèmes de commande industriels pour empêcher des dommages au
personnel ou au matériel. La NEMA ICS 3‐304 fournit les recommandations générales, qui sont
dʹapplication pour le développement et lʹinstallation des systèmes contrôlés par des systèmes
électroniques automatisés comme suit :
Recommandations de Sécurité ICS 3‐304.81
Cette section est Lʹutilisation dʹune fonction dʹarrêt dʹurgence, qui est indépendant du
reproduite par la contrôleur programmable, doit être considérée. Là où lʹopérateur est
permission de exposé à la machinerie, comme dans le chargement ou déchargement
lʹAssociation Nationale dʹune outillage de la machine, ou à lʹendroit où la machine fonctionne
de Fabricants de automatiquement, considération devrait être donnée à lʹutilisation
Matériel Electrique dʹun dépassement électromécanique ou autres moyens
NEMA 3‐304. Norme supplémentaires, indépendant du contrôleur programmable, pour
du Contrôleur commencer et interrompre le cycle. Si la disposition est exigée pour
Programmable. des programmes changeants pendant le fonctionnement du matériel,
considération devrait être donnée à lʹutilisation dʹun verrouillage ou
autres moyens qui assurent que de tels changements peuvent être
faits seulement par le personnel autorisé. Ces recommandations ont
pour but la sauvegarde contre toute panne de composants critiques et
les effets de telles pannes ou des erreurs introduites par inadvertance
lors dʹun changement de programme pendant le fonctionnement du
matériel.
UG1.0047.V12.3‐2A 3
Administratorʹs User Guide
Pre‐Installation Guidelines
This chapter provides pre‐installation guidelines for the D/3.
In This Chapter
Overview
Determining Which Nodes Require an Installation
Naming the Nodes
Determining the Required Products for a Node
UG1.0047.V12.3‐2A 5
Administratorʹs User Guide
Overview
This section provides an overview of the steps required to prepare to install the D/3 software.
This section helps you to plan for the installation of D/3 software onto all nodes in your
configuration. The steps involved in installing the D/3 software include:
• Determining which nodes require an installation
• Naming the nodes
• Ensuring adequate licenses are available for the desired system configuration
• Determining the order in which nodes will have the software installed
• Determining the baseline software and layered products required for each system
• Setting up user accounts
Determining Which Nodes Require an Installation
The first step in planning the installation of the D/3 software is to determine how many nodes
require an installation.
Each system that executes D/3 software falls into one of six categories (node types):
UG1.0047.V12.3‐2A 6
Administratorʹs User Guide
Node Type Definition Maximum
Number
Per D/3 System
D3CONSOLE Operator console client node, used to execute the Unlimited
PVN, VersaTrend, InstAlarm, TotalVision and
Console Manager programs. Not configured into
the D/3 system configuration, and must be
connected to a DCM as a server to obtain process
data and alarm history.
D3 DATA A DCM node responsible for collecting the 2
COLLECTOR TrendR data.
D3 DATA A node responsible for storing and retrieving the 2
HISTORIAN TrendR data.
You should always begin your installation by installing the software onto the CDCM node. After
installing the CDCM software, then install the software onto each DCM. Finally, install the
D3Console, D3Manager, D3 Data Collector and D3 Data Historian nodes.
Naming the Nodes
NovaTech recommends configuring each PC used as a DCM or CDCM to have the same computer
name configured in the operating system as the DCM name configured in the D/3’s system
configuration table created by WinCOD. This makes configuration of the system easier because the
user does not need to determine if the PC’s computer name or the dcm_name is required in a
particular setup field. Having the names the same also makes login names easier to remember for
runtime utilities such as D3Manager, D3DataPick and the Operator Console. DCM names are also
used in creating D/3 filenames and folders, so it is easier to organize these when they match the
computer name.
D/3 node names are restricted to a maximum of six characters.
An alias may be provided for a computer name in the C:\Windows\system32\drivers\etc hosts
file to aid in linking to the PC.
Note: This manual uses the term computer name for the name of the
computer as defined in the Microsoft operating system. Node
name and dcm_name refer to the D/3 node names defined in the
D/3 System Configuration Table as defined by WinCOD. This
should aid users having requirements that do not allow them
to follow NovaTech’s recommendation.
UG1.0047.V12.3‐2A 7
Administratorʹs User Guide
Determining the Required Products for a Node
Several options are available when installing D/3 Software. The software to be installed for each
machine should be determined in advance. First the computer’s functions will be determined. Each
computer will be assigned one of these functions:
• CDCM
• DCM
• Console Node
• Data Collector
• Data Historian
• D3Manager
• Other Clients
CDCM software
One computer in the D/3 System will become the CDCM. This computer will require DCM software
with the CDCM option. The DCM Examples, Sample Application and Include files may or may not
be installed, at the user’s discretion. In addition, the CDCM might also require D/3 console software
if console applications (such as PVN TotalVision™, InstAlarm™, or VersaTrend™) will be run on
that computer. D3Manager should probably be installed, if a user wants to start or stop D/3 nodes
or load or unload D/3 databases from the CDCM, and. The CDCM might be used as a Primary or
Secondary Data Historian. If so, the Data Historian Software must be installed. The Help files
should be installed on all D/3 nodes, but may be omitted at the user’s discretion. The OPC Client
and TotalWebVision software are also optional.
Warning: Optional components should not be removed carelessly.
Most optional components don’t require significant amounts
of disk space, and if they are needed later, the D/3 will have
to be uninstalled and reinstalled to add them.
DCM Software
If more than 8 consoles will be required simultaneously, then DCM nodes will be required. DCMs
may also be added to lighten the load on the CDCM, or to provide a place for consoles to connect in
the event of another DCMʹs planned or unplanned unavailability. Up to 31 DCMs may be defined
in each D/3 System.
Each DCM will require DCM Baseline software. THE CDCM OPTION SHOULD NOT BE
SELECTED FOR DCMs. Like the CDCM, DCMs may or may not install such optional components
as:
UG1.0047.V12.3‐2A 8
Administratorʹs User Guide
• DCM Examples
• Sample Application
• Include files
• D/3 console software
• D3Manager
• Data Collector Software
• Data Historian Software
• Help files
• OPC Client
• TotalWebVision
The “Layered Products” are automatically installed when the DCM software is installed, but cannot
be activated without an additional license. These include:
• Database Access
• D/3 Dataserver
• Report Writer
• TrendR
• Tuning Advisor
• OPConnect
Warning: Optional components should not be removed carelessly.
Most optional components don’t require significant amounts
of disk space, and if they are needed later, the D/3 will have
to be uninstalled and reinstalled to add them.
Console Node Software
Each node which will run console applications (such as PVN TotalVision™, InstAlarm™ or
VersaTrend™) must have the D/3 Console Software option selected. NO DCM SOFTWARE IS
REQUIRED ON COMPUTERS ACTING AS REMOTE CONSOLES (sometimes referred to as
Operator Console Modules or OCMs). Most of the optional components CAN be installed on
Console nodes, but typically aren’t. The components that can be installed on Console Nodes are:
• D3Manager
• Data Historian Software
• Data Collector Software
• Help files
UG1.0047.V12.3‐2A 9
Administratorʹs User Guide
• OPC Client
• TotalWebVision
Typically only the Help Files, OPC Client and TotalWebVision are installed on Operator Console
nodes.
Data Collector Software
If the TrendR layered product is being used, 1 or 2 computers can be designated as the Primary and
Secondary Data Collectors. Sometimes, DCMs (or the CDCM) are chosen to perform these tasks,
but occasionally the Data Collectors are installed on computers with no other D/3 software. In these
cases only the Data Collector software is required, but it is highly recommended that the Help files
be installed as well.
Data Historian Software
If the TrendR layered product is being used, 1 or 2 computers can be designated as the Primary and
Secondary Data Historians. Sometimes, DCMs (or the CDCM) are chosen to perform these tasks,
but occasionally the Data Historians are installed on computers with no other D/3 software. In these
cases only the Data Historian software is required, but it is highly recommended that the Help files
be installed as well.
Other Products
D3Manager, the Help files, OPC Client and TotalWebVision can all be installed individually on any
computer.
The D/3 Companion Products require separate installation CDs. These include:
• OPConnect
• Paperless Procedures™
• SimSuite Pro
• FlexBatch™
UG1.0047.V12.3‐2A 10
Administratorʹs User Guide
D/3 Licensing
This chapter discusses the D/3 Licensing requirements and implementation.
In This Chapter
Overview
D/3 License Files
Viewing D/3 License Information
License Types
Frequently Asked Questions
Overview
The D/3 System incorporates a flexible license management scheme that facilitates flexibility in
system configuration and maintenance.
A D/3 License Pak can be provided in a variety of media including floppy disk, e‐mail, zip file, and
so on. The file is text based and contains a number of keywords identifying the license name and
other license attributes. A checksum protects the license from modification after it has been created.
All D/3 licenses reside in the C:\GSELICENSE folder of the various D/3 nodes. To install a license,
the user simply copies the license file(s) to this directory on the appropriate D/3 node and runs the
WinCOD application to distribute the new licenses as required.
Licenses are checked and verified in several different ways depending on the license and itʹs
associated application. Whenever a license error or conflict is detected an informative dialog is
displayed.
There are two basic types of D/3 licenses:
Runtime License A license to run a D/3 software product. The runtime license is
validated when the application starts.
Configuration License A license used during configuration of a D/3 system. WinCOD checks
for Configuration licenses upon exit. This eliminates the chance of a
license failure affecting startup of the D/3 system once a valid
configuration has been built. For example, a PCM license that supports
up to 500 points is named GSE‐D3‐PCM‐500. All configuration licenses
are found on the CDCM.
Runtime licenses are further subdivided into Node based and Concurrent (or Floating) licenses.
Node License A license to run a D/3 software product on a given node. The license is
validated when the application starts. License names contain the
keyword NODE. For example, the full function console license is
UG1.0047.V12.3‐2A 11
Administratorʹs User Guide
named GSE‐D3‐OCMFF‐NODE
Concurrent License A network based license that may be shared between users. The license
contains a fixed number of keys that permit a fewer number of licenses
(Floating License)
to be purchased than the total number of expected users. The licenses
float from user to user as required. D/3 software will attempt to check
out a license from a license server on a first come ‐ first served basis.
Any legal hardware platform may execute the software provided that a
valid key exists that has not been checked out by another user.
Concurrent licenses should not be used for critical applications since
there is no guarantee that a license is available. Concurrent use licenses
contain the keyword FLOAT. For example, a 4 user read only console
license is named GSE‐D3‐OCMRO‐4‐FLOAT.
Each license contains a keyword known as the IDTYPE that determines how the license will be
validated. The three IDTYPES are Ethernet, Sentinel or Demo as described in the following table.
Ethernet A license valid only on the node with the specified Ethernet MAC
address.
Sentinel A license valid only on the node that has the specified sentinel, a
hardware key attached to the parallel or USB port of the userʹs PC.
Demo A license valid on any node, for a specified period of time. This license
type is issued with an expiration date and is used for demo or trial
software.
All licenses contain an EXPIRATION keyword that specifies an expiration date, after which the
licenses will no longer work. Ethernet and Sentinel licenses typically do not expire and contain the
keyword PERMANENT. Demo licenses contain a specific expiration date.
D/3 License Files
Individual D/3 licenses consist of a text file containing a checksum. The filenames for the license
consists of a general prefix followed by an underscore and serial number. The prefix identifies the
license type. All D/3 licenses contain the file extension, .LIC.
License Types
GSE‐D3‐CDCM‐250 The main system configuration license. Capable of defining
250 EPNs in as many PCMs as required for the application.
GSE‐D3‐CDCM‐500 The main system configuration license. Capable of defining
500 EPNs in as many PCMs as required for the application.
GSE‐D3‐CDCM‐1000 The main system configuration license. Capable of defining
1,000 EPNs in as many PCMs as required for the application.
GSE‐D3‐CDCM‐5000 The main system configuration license. Capable of defining
5,000 EPNs in as many PCMs as required for the application.
GSE‐D3‐CDCM‐10000 The main system configuration license. Capable of defining
10,000 EPNs in as many PCMs as required for the
application.
GSE‐D3‐CDCM‐MAX The main system configuration license. Capable of defining
the system maximum number of EPNs in as many PCMs as
required for the application.
UG1.0047.V12.3‐2A 12
Administratorʹs User Guide
GSE‐D3‐DCM‐MAX The primary data and display server. This configuration
license includes the ability to display the maximum number
of consoles that the software supports.
GSE‐D3‐PCM‐250 A Process Control Module configuration license that permits
the definition of up to 250 tags (i.e., EPNs).
GSE‐D3‐PCM‐500 A Process Control Module configuration license that permits
the definition of up to 500 tags (i.e., EPNs).
GSE‐D3‐PCM‐1000 A Process Control Module configuration license that permits
the definition of up to 1000 tags (i.e., EPNs).
GSE‐D3‐PCM‐1500 A Process Control Module configuration license that permits
the definition of up to 1500 tags (i.e., EPNs).
GSE‐D3‐PCM‐MAX A Process Control Module configuration license that permits
the definition of the maximum number of EPNs supported
by the software.
GSE‐D3‐RPCM‐250 A Redundant Process Control Module configuration license
that permits the definition of up to 250 tags (i.e., EPNs).
GSE‐D3‐RPCM‐500 A Redundant Process Control Module configuration license
that permits the definition of up to 500 tags (i.e., EPNs).
GSE‐D3‐RPCM‐1000 A Redundant Process Control Module configuration license
that permits the definition of up to 1000 tags (i.e., EPNs).
GSE‐D3‐RPCM‐1500 A Redundant Process Control Module configuration license
that permits the definition of up to 1500 tags (i.e., EPNs).
GSE‐D3‐RPCM‐MAX A Redundant Process Control Module configuration license
that permits the definition of the maximum number of EPNs
supported by the software.
GSE‐D3‐PCM‐MCC Configuration license to use 16000 series I/O in a particular
PCM.
GSE‐D3‐RPCM‐MCC License to use 16000 series I/O in a redundant PCM.
GSE‐D3‐PCM‐GPXIO Configuration license to use General Purpose External I/O in
a particular PCM.
GSE‐D3‐RPCM‐GPXIO License to use General Purpose External I/O in a redundant
PCM.
GSE‐D3‐PCM‐Simatec Configuration license to use SIMATIC® 505™ I/O in a
particular PCM.
GSE‐D3‐RPCM‐Simatec License to use SIMATIC® 505™ I/O in a redundant PCM.
GSE‐D3‐PCM‐Quantum Configuration license to use Modicon Remote I/O in a
particular PCM.
GSE‐D3‐RPCM‐Quantum License to use Modicon Remote I/O in a redundant PCM.
GSE‐D3‐PCM‐Modbus+ Configuration license to use ModBus Plus I/O in a particular
PCM.
GSE‐D3‐RPCM‐Modbus+ License to use ModBus Plus I/O in a redundant PCM.
GSE‐D3‐PCM‐DataHighway+ Configuration license to use DataHighway I/O in a particular
PCM.
GSE‐D3‐RPCM‐ License to use DataHighway I/O in a redundant PCM.
UG1.0047.V12.3‐2A 13
Administratorʹs User Guide
DataHighway+
GSE‐D3‐PCM‐Profibus Configuration license to use Profibus I/O in a particular
PCM.
GSE‐D3‐RPCM‐Profibus License to use Profibus I/O in a redundant PCM.
GSE‐D3‐PCM‐ControlNet Configuration license to use ControlNet I/O in a particular
PCM.
GSE‐D3‐RPCM‐ControlNet License to use ControlNet I/O in a redundant PCM.
GSE‐D3‐PCM‐EthernetMPC Configuration license to use Ethernet MPC I/O in a particular
PCM
GSE‐D3‐RPCM‐EthernetMPC License to use Ethernet MPC I/O in a redundant PCM
GSE‐D3‐OCMRO‐NODE A runtime license to connect to a DCM server and consume a
process view. This is a read only license that does not permit
the user to make changes to the EPNs.
GSE‐D3‐OCMRO‐1‐FLOAT A runtime license that is resident on the license server
(DCM) that allows a client to consume an available process
view. This license is returned to the license server when the
client exits or does not communicate with the server during a
user definable period. This is a read only license that does
not permit the user to make changes to the EPNs.
GSE‐D3‐OCMRO‐4‐FLOAT A runtime license that is resident on the license server
(DCM) that allows 4 clients to consume an available process
view. This license is returned to the license server when the
client exits or does not communicate with the server during a
user definable period. This is a read only license that does
not permit the user to make changes to the EPNs.
GSE‐D3‐OCMRO‐8‐FLOAT A runtime license that is resident on the license server
(DCM) that allows 8 clients to consume an available process
view. This license is returned to the license server when the
client exits or does not communicate with the server during a
user definable period. This is a read only license that does
not permit the user to make changes to the EPNs.
GSE‐D3‐OCMRO‐16‐FLOAT A license that is resident on the license server (DCM) that
allows 16 clients to consume an available process view. This
license is returned to the license server when the client exits
or does not communicate with the server during a user
definable period. This is a read only license that does not
permit the user to make changes to the EPNs.
GSE‐D3‐OCMRO_NOVRT‐ A runtime license to connect to a DCM server and consume a
process view without using TotalVision. This is a read only
NODE
license that does not permit the user to make changes to the
EPNs.
GSE‐D3‐OCMFF‐NODE A runtime license to connect to a DCM server and consume a
process view. This is a full function license that permits the
user to make changes to the EPNs.
GSE‐D3‐OCMFF‐1‐FLOAT A runtime license that is resident on the license server
(DCM) that allows a client to consume an available process
view. This license is returned to the license server when the
UG1.0047.V12.3‐2A 14
Administratorʹs User Guide
client exits or does not communicate with the server during a
user definable period. This is a full function license that
permits the user to make changes to the EPNs.
GSE‐D3‐OCMFF‐4‐FLOAT A runtime license that is resident on the license server
(DCM) that allows 4 clients to consume an available process
view. This license is returned to the license server when the
client exits or does not communicate with the server during a
user definable period. This is a full function license that
permits the user to make changes to the EPNs.
GSE‐D3‐OCMFF‐8‐FLOAT A runtime license that is resident on the license server
(DCM) that allows 8 clients to consume an available process
view. This license is returned to the license server when the
client exits or does not communicate with the server during a
user definable period. This is a full function license that
permits the user to make changes to the EPNs.
GSE‐D3‐OCMFF‐16‐FLOAT A runtime license that is resident on the license server
(DCM) that allows 16 clients to consume an available process
view. This license is returned to the license server when the
client exits or does not communicate with the server during a
user definable period. This is a full function license that
permits the user to make changes to the EPNs.
GSE‐D3‐OCMFF_NOVRT‐ A runtime license to connect to a DCM server and consume a
process view without using TotalVision. This is a full
NODE
function license that permits the user to make changes to the
EPNs.
GSE‐D3‐TVDEV‐NODE The TotalVision Developer runtime license that enables the
TotalVision editor to execute
GSE‐D3‐TVDEV‐1‐FLOAT The TotalVision Developer runtime license that enables the
TotalVision editor to execute
GSE‐D3‐DATASERVER‐10 The runtime license to run the DataServer software for up to
ten client connections.
GSE‐D3‐DATASERVER‐MAX The runtime license to run the DataServer software for the
maximum number of client connections supported by the
software.
GSE‐D3‐DBA‐MAX Runtime license to create a Windows application that uses
the D/3 Database Access package.
GSE‐D3‐TUNA‐MAX Runtime license to run the Tuning Advisor™ automatic
loop‐tuning package.
GSE‐D3‐TrendR‐MAX Runtime license to run the TrendR package.
GSE‐D3‐RPTWR‐MAX Runtime license to run the Report Writer package.
GSE‐D3‐PI_ONLINE‐MAX Runtime license to run the PI Online Server to support the
PI_ONLINE data server by OSISoft.
GSE‐D3‐ONLINE‐SERVER License to run the DCE based server.
GSE‐D3‐OPConnect‐500 License to run the OPConnect server to support the DCM
continuous database for up to 500 tags (i.e., EPNs).
GSE‐D3‐OPConnect‐MAX License to run the OPConnect server to support the DCM
UG1.0047.V12.3‐2A 15
Administratorʹs User Guide
continuous database for up to of the maximum number of
EPNs supported by the software.
TotalWebVision VPTV License Files
GSE‐D3‐VPTVFF‐NODE This is a full‐function runtime license to run VPTV on a given
node. The license is validated when the application starts.
Node license names always contain the keyword NODE. Install
this license on every node that uses VPTV.
GSE‐D3‐VPTVFF‐1‐FLOAT This is a full‐function network‐based runtime license that may
“float” (be shared) between concurrent users as required. The
license contains a fixed number of keys that permit a fewer
number of licenses to be purchased than the total number of
expected users. The license contains the keyword FLOAT. Install
this license only on the License Server node.
GSE‐D3‐VPTVRO‐NODE This is a read‐only runtime license to run VPTV on a given
node. The license is validated when the application starts. Node
license names always contain the keyword NODE. Install this
license on every node that uses VPTV.
GSE‐D3‐VPTVRO‐1‐FLOAT This is a read‐only network‐based runtime license that may
“float” (be shared) between concurrent users as required. The
license contains a fixed number of keys that permit a fewer
number of licenses to be purchased than the total number of
expected users. The license contains the keyword FLOAT. Install
this license only on the License Server node.
GSE‐D3‐VPDATAFF‐NODE This is a full‐function runtime license to run the VP Data
Control for DDS Servers on any node.
GSE‐D3‐VPDATAFF‐1‐ This is a one‐user full‐function runtime license to run the VP
Data Control for DDS Servers on the Configurator Display
FLOAT
Control Module (CDCM).
GSE‐D3‐VPDATARO‐ This is a read‐only runtime license to run the VP Data Control
for DDS Servers on any node.
NODE
GSE‐D3‐VPDATARO‐1‐ This is a one‐user read‐only runtime license to run the VP Data
Control for DDS Servers on the Configurator Display Control
FLOAT
Module (CDCM).
Viewing D/3 License Information
There are several ways to view D/3 license information. The recommended method is to use the D/3
License Manager Utility. Licenses can also be viewed with any text editor
The GSE License Manager utility is accessed from the Windows Start menu and displays
information about every license installed on a node.
For more Information on the GSE License Manager utility see the ʺGSE License Managerʺ chapter in
ʺThe Configuration and Management Tools User’s Guideʺ.
Individual D/3 license files can be opened and read by the Windows NotePad utility or other text
editor. License information is contained in the file.
UG1.0047.V12.3‐2A 16
Administratorʹs User Guide
LICENSE GSE-D3-CDCM-1000 VERSION=12.3
DESCRIPTION="Configurator license 1000 EPNs"
EXPIRATION=25-apr-2008 COPIES=uncounted SN=26
IDTYPE=DEMO ID=0 SYSTEMID=000
ISSUED=26-apr-2007 ISSUER="GSE Systems"
LICENSEE="NovaTech – Owings Mills"
USE_SERVER=NO
COMMENTS="Demo"
CKSUM=a405-745e-cdfc-bb0c-7d1f-5767-931f-126d
Note: Do not change the contents of the license file. Doing so renders
the file invalid.
License Types
There are two types of licenses: Configuration and Runtime.
Configuration Licenses – These licenses are node licenses used by WinCOD to build a D/3
Configuration. Once a valid configuration has been built, the D/3 will run indefinitely until the
configuration is changed with WinCOD. Configuration licenses are tied to the Ethernet address or a
Sentinel device associated with the CDCM.
Runtime Licenses – These licenses are checked each time a program runs. The Console Manager
(ConMan) uses runtime licenses. A runtime license can either be node‐based or floating.
Node‐Based ‐ Requires each node to have its own license.
Floating – Allows multiple nodes to use the same license without physically installing a license on
each node. Floating licenses require a connection to a license server so the license can be checked
out for use and returned when the application exits.
The floating license is recommended only for casual use since there is no guarantee that the license
or the server is available at any given time. Critical applications should always use a node‐based
license. Console licenses and TotalWebVision™ are available as a floating license.
Note: All licenses reside in the node’s C:\GSELICENSE directory.
License Validation
Licenses are validated three ways:
MAC Address – These licenses contain the MAC address of the PC.
Sentinel – These licenses contain the address on an associated Sentinel key on the PC.
Demo – These licenses are valid on any PC and expire after a fixed time.
Frequently Asked Questions
The following is a list of frequently asked questions about licensing.
UG1.0047.V12.3‐2A 17
Administratorʹs User Guide
A license fails to run due to an Ethernet Error. How do I verify the correct Ethernet Address for
my node?
First run GSE License Manager to determine the Ethernet address that the license expects to see for
your node. Compare this address with the physical address of your box. To determine the physical
addresses for your node, use the “ipconfig /all” command. This command may be executed from
either a DOS prompt or by pressing the “IP Config” button inside GSE License Manager. The
license address should match up with one of the physical addresses reported by ipconfig.
How do I go about adding a new D/3 node (DCM or PCM)?
Obtain a node license and copy it to C:\GSELICENSE on the CDCM.
Run WinCOD and add the node. Call up the new node’s Properties. If the node being added is a
PCM set the “I/O Points” dropdown to the same value as that of the license. After doing so,
WinCOD should have found the new license and assigned it to your new node. If not, the “I/O
Points” field will be displayed in RED. You may press the “License Info…” button to learn why the
node could not obtain a valid license. Save your changes and exit WinCOD.
Restart the D/3 software on all nodes.
How do I enable a Layered Product?
Obtain the appropriate license and copy it to C:\GSELICENSE on the CDCM.
Run WinCOD and call up the Properties for the node that will be running the Layered Product.
Click the appropriate checkbox for the Layered Product that is being added. After doing so,
WinCOD should have found the new license and assigned it to your new node. If not, the text
beside the checkbox you clicked will be displayed in RED. You may press the “License Info…”
button to learn why the node could not obtain a valid license. Save your changes and exit WinCOD.
How do I enable an I/O Type?
Obtain the appropriate I/O license and copy it to C:\GSELICENSE on the CDCM.
Run WinCOD and call up the Properties for the node that will have the new I/O. Check the
appropriate checkbox for the I/O that is being added. After doing so, WinCOD should have found
the new license and assigned it to your new node. If not, the text beside the checkbox you clicked
will be displayed in RED. You may press the “License Info…” button to learn why the node could
not obtain a valid license. Save your changes and exit WinCOD.
Restart the D/3 software on the CDCM and reload the PCM where the new I/O was added.
How do I change the maximum number of points assigned to an existing node?
If necessary, obtain the appropriate node license and copy it to C:\GSELICENSE on the CDCM.
You can also swap a license with another node. License swapping is discussed in a subsequent
question.
In WinCOD, call up the node’s Properties. Set the “I/O Points” dropdown to the same value as that
of the license you obtained. After doing so, WinCOD will attempt to find the new license and
assign it to your new node. If a valid license cannot be found, the “I/O Points” field will be
UG1.0047.V12.3‐2A 18
Administratorʹs User Guide
displayed in RED. You may press the “License Info…” button to learn why the node could not
obtain a valid license. Save your changes and exit WinCOD.
How do I change the maximum number of Clients licensed for DataServer?
If necessary, obtain the appropriate DataServer license and copy it to C:\GSELICENSE on the
CDCM. You can also swap a license with another node. License swapping is discussed in a
following question.
In WinCOD, call up the node’s Properties. Set the “DataServer Clients” dropdown to the same
value as that of the license you obtained. After doing so, WinCOD should have found the new
license and assigned it to your new node. If not, the “DataServer Clients” field will be displayed in
RED. You may press the “License Info…” button to learn why the node could not obtain a valid
license. Save your changes and exit WinCOD.
How do I know when a Configuration license becomes invalid?
If a node has a missing or invalid node license (CDCM, DCM or PCM), WinCOD will display a
RED ‘L’ alongside the node’s name in its main dialog window. If a node has a missing or invalid
layered product or I/O license, WinCOD will display a YELLOW ‘L’ alongside the node’s name.
Any configuration changes that you attempt to save will force WinCOD to FUTURE a node that has
a bad node license, or disable a product (I/O or layered) for a node that has a bad product license. If
no changes are saved when WinCOD exits, the invalid license will continue to work on the D/3.
How do I know when a Runtime license becomes invalid?
The application that requires the license will display an appropriate error message. You can also
run the D/3 License Manager program to evaluate all licenses currently found on your system.
I have an invalid or expired license; will my D/3 continue to run?
Yes. However, if the license is a Configuration license then you will not be able make changes to
your D/3 configuration in WinCOD without the D/3 learning of the license problem. If the license is
a Runtime license, then you will not be able to restart a D/3 application that requires the license or
run new instances of it.
How do I replace an invalid Configuration license?
Delete the invalid license from C:\GSELICENSE on the CDCM. In order to determine which license
must be removed for a given node, run WinCOD and generate a “D/3 Licenses” report. There you
will find which licenses are assigned to your node.
Obtain the new license and copy it to C:\GSELICENSE on the CDCM.
At a minimum, this is all that needs to be done. The next time WinCOD is run it will find the new
license and automatically assign it to the node that needed it. The new license information (i.e. its
serial #) will then be saved the next time changes are saved in WinCOD.
How do I replace an invalid Runtime license?
Delete the invalid license from C:\GSELICENSE on the node where the license resides. To
determine the node where the license resides, refer to the table above. The file can also be deleted
UG1.0047.V12.3‐2A 19
Administratorʹs User Guide
by using the GSE License Manager program and right clicking on the license name. Select the delete
option to permanently remove the license.
Copy the replacement license to the location where the old license resided. After doing so, the
application that required the license should now run correctly.
I changed the Ethernet board in my CDCM/DCM/OCM. What are the consequences of doing
that?
Since D/3 licenses (both Configuration and Runtime) are issued against Ethernet (MAC) addresses,
changing the Ethernet card in a system will invalidate those licenses that were issued for that node.
The D/3 will allow 10 days to pass before marking an affected license invalid. New licenses will
need to be obtained as soon as possible.
What is license swapping?
License swapping is a technique of trading licenses with another node, usually to increase the
number of points one particular node needs from a node that does not need the additional points.
License swapping only makes sense for PCM licenses and DataServer licenses since these are the
only two types of licenses that have attributes (points or clients) associated with them.
How do I swap a license with another node?
Run WinCOD and set the node to FUTURE on one of the two nodes that will have their licenses
swapped. This action will free all the licenses that are assigned to that node.
Depending on which license attributes you are swapping (PCM points or DataServer clients), you
will need to change that attribute for each node to the value that is assigned to the other node.
Set the node that you set to FUTURE back to non‐FUTURE. The licenses have now been swapped.
Save your changes and exit WinCOD.
Depending on what was swapped, you may need to copy CONFIG.D3 from the CDCM to the
affected node.
MODEL complains that my EPN count exceeds my licensed count for my system or my PCM.
What does that mean and what can I do about it?
You will receive this error if either one of these maximums is exceeded:
• The total number of EPNs allocated in the PCM’s MODEL CREATE header exceeds the
number of points WinCOD has assigned to that PCM (i.e. what the PCM is licensed for).
• The total number of EPNs allocated in the PCM’s MODEL CREATE header plus the total
number of EPNs allocated for all other PCM’s exceeds the number of points WinCOD has
assigned to the CDCM (i.e. what the CDCM is licensed for).
If the error states that the EPN count has exceeded the system maximum, then you will either need
to increase the point count assigned to the CDCM in WinCOD, or decrease the number of allocated
MODEL EPNs for one or more PCMs.
UG1.0047.V12.3‐2A 20
Administratorʹs User Guide
Note: If a PCM’s database was altered, you will need to rebuild
those PCMs in MODEL before attempting to rebuild the
database for your PCM.
If the error states that the EPN count has exceeded the PCM’s maximum, then you must increase
the point count assigned to that PCM in WinCOD.
As always, if you change a node’s point count in WinCOD you must have an available license for it
and you must perform a DBL –H –K afterwards to make it seen by the rest of the D/3.
How do I know which license is needed by ConMan?
There are two console licenses for ConMan: A full‐function license allowing complete control of the
process, and a read‐only license that does not allow control. The read‐only license is used whenever
the “No Control” option in ConMan has been selected.
Each console license comes in one of two types: Node‐based or floating. The node‐based license is
normally used unless the “Server Node” option is selected in the License Info section of the
ConMan Settings dialog.
In WinCOD my node shows it cannot get a license for a particular I/O or layered product, but
another node has no problem getting the same license.
Every node needs a unique license for any I/O or layered product that is enabled for it. In other
words, configuration licenses are not shared with other nodes. You will need to obtain additional
licenses for the products that you are attempting to enable.
What type of license do I need for 16000 I/O?
You need a GSE‐D3‐PCM‐MCC license.
How do I determine where a license should be installed?
If the license name contains the keyword NODE, then it should be installed wherever the license
will be used. For example, the console license OCMFF‐NODE must be installed on the OCM, DCM
or CDCM where the console software executes.
If the license name contains the keyword FLOAT, then it should be installed on whichever node
runs the license server. This is usually the CDCM.
If neither keyword is found, the license is a configuration license and it should be installed on the
CDCM.
Where do I install a DCM license?
The DCM license is named GSE‐D3‐DCM‐MAX. Using this name and the information from the
preceding question, we see the name does not contain the keywords NODE or FLOAT.
Therefore, the license is a configuration license and it must be installed on the CDCM and not on
the DCM. The Ethernet ID or Sentinel number must correspond the to CDCM since this is where
the license is loaded.
Which Sentinel or Ethernet ID should I use?
UG1.0047.V12.3‐2A 21
Administratorʹs User Guide
Determine where the license is used and then supply the correct ID.
For configuration licenses, use the Ethernet ID or Sentinel ID associated with the CDCM.
For Floating licenses, use the ID associated with the license server. This is usually the CDCM.
For Node licenses, use the ID associated with each PC running the software.
What are the advantages and disadvantages of using a Sentinel‐based License?
Since the Sentinel may be easily moved from one machine to another, this eliminates the need to
obtain new licenses due to machine failure. However, Sentinels can sometimes interfere with
printers attached to the parallel port. New USB Sentinels are also available for systems that have an
available USB port. Only one Sentinel per PC is required since a single Sentinel may be used for
multiple licenses. In general, a D/3 system needs one Sentinel for the CDCM and additional
Sentinels for each node running console software.
What are the advantages and disadvantages of using an Ethernet‐based License?
Ethernet licenses do not interfere with the parallel port and are more transparent to the user.
However, licenses may need to be regenerated in case of Ethernet board failure.
Do Sentinel and Ethernet licenses have an expiration date?
Any license may have an expiration date. Expiration dates are specified at the time the license is
created based on the intended use of the license. Licenses that do not expire contain the keyword
PERMANENT.
UG1.0047.V12.3‐2A 22
Administratorʹs User Guide
D/3 Directory Structure
This chapter discusses the D/3 Directory Structure.
In This Chapter
D/3 Directories
D/3 Tools
File Versioning
Environment Variables
D/3 Directories
The D/3 software is normally installed in C:\Program Files\GSE Systems\D3 DCS, but can be
installed on another designated drive. The table that follows details the directory structure for the
D/3.
The D/3 environment variables listed in the tables are set by the batch file D3SetEnv.bat.
GSE Systems\D3 DCS in its default location of C:\Program Files
UG1.0047.V12.3‐2A 23
Administratorʹs User Guide
The D3App Directory Tree
The following tables list the directories of D3App, along the environment variables used with the
D3SET command and their usage. The figure which follows shows the directory tree as seen in
Windows.
…\GSE Systems\D3 DCS\D3App or %D3App%
Directories D3SET Usage
Environment Variable
Data D3DAT D/3 Current Data
CDB D3CDB Continuous Databases and Reports
CFG D3CFG Configuration Database and Reports
CGR D3CGR Compiled PVN Graphics and SubPictures
CLB D3CLB TrendR Collection List Builder files
CND D3CND Control Net files
UG1.0047.V12.3‐2A 24
Administratorʹs User Guide
Directories D3SET Usage
Environment Variable
CONSOLE D3CON D/3 Console Data files
DBR D3DBR Database Snapshots and Reports
DDS D3DDS DDS data files (e.g. D3_Online)
FLX D3FLX FlexBatch Production Database
GPL D3GPL Display Group Databases and Reports
GRA D3GRA Uncompiled PVN Graphics and Subpictures
HAC D3HAC Hardware Configuration Databases and
Reports
NOT D3NOT D/3 Notebook files
PDB D3PDB PLC Databases and Reports
Reports D3RPG Report Writer files
SDB D3SDB Sequence Databases
SPC D3SPC SPC X‐bar block files
System D/3 System installation logs
Log
TMP D3TMP Temporary files. Memory Mapped Region
files are stored here
TUN D3TUN Tuning Advisor files
VMR D3VMR Compiled TotalVision Graphics
UG1.0047.V12.3‐2A 25
Administratorʹs User Guide
…\GSE Systems\D3 DCS\D3App\Data or %D3App%\Data
Directories D3SET Usage
Environment
Variable
Gms (GMS_HOME*) D3GMS SL GMS Files for TotalVision
…\GSE Systems\D3 DCS\D3App\GMS or %D3App%\GMS
UG1.0047.V12.3‐2A 26
Administratorʹs User Guide
…\GSE Systems\D3 DCS\D3App\GMS\Demo or %D3App%\GMS\Demo
UG1.0047.V12.3‐2A 27
Administratorʹs User Guide
…\GSE Systems\D3 DCS\D3App\GMS\Work or %D3App%\GMS\Work
Directories D3SET Usage
Environment Variable
History D3HIS D/3 Historical Data
AHF D3AHF Alarm History files
BHF D3BHF Batch History files
FBD D3FBD FlexBatch Archived databases
HTD D3HTD Historical Trend data files
TRD D3TRD TrendR files
UG1.0047.V12.3‐2A 28
Administratorʹs User Guide
…\GSE Systems\D3 DCS\D3App\History or %D3App%\History
Note: To save Alarm History Files to another disk, change the
environment variable D3AHF to point to another disk, then
stop and start the D3AlarmTyper process.
…\GSE Systems\D3 DCS\D3App\MSSQL or %D3App%\MSSQL
Directories D3SET Usage
Environment Variable
Reference D3REF D/3 Reference Files
ControlNet SST Control Net configuration
Examples D/3 Coding Examples
Includes D/3 Include files (installed for customer
DBA only)
Notebook D/3 Notebook files
Profibus Profibus configuration
Resources FlexBatch Customer Display Customization
files
TrendR TrendR Import and Export
UG1.0047.V12.3‐2A 29
Administratorʹs User Guide
…\GSE Systems\D3 DCS\D3App\Reference or %D3App%\Reference
Directories D3SET Usage
Environment Variable
Sample D3SMP D/3 Sample Application
…\GSE Systems\D3 DCS\D3App\Sample or %D3App%\Sample
Directories D3SET Usage
Environment Variable
Setup D3SET D/3 Setup and Configuration files
Common Common Application Input Files
Configuration D3TXT Configuration Text files (created by D/3
Architect)
Imports Database Text Input files (from a previous
version of D/3)
Specific
Ved Vision Editor Files
UG1.0047.V12.3‐2A 30
Administratorʹs User Guide
…\GSE Systems\D3 DCS\D3App\Setup or %D3App%\Setup
Directories Usage
Common Common Application Input Files
CDB Continuous Database Input files
GRP Display Group Input files
Includes SABL Include files (created by customer)
SABL SABL Programs
SDB Sequence Database Input files
…\GSE Systems\D3 DCS\D3App\Setup\Common or %D3App%\Setup\Common
Directories Usage
Specific
DCMxx DCMxx Application Input Files
CDB Continuous Database Input files
GRP Display Group Input files
PCMxx PCMxx Application Input Files
CDB Continuous Database Input files
SABL SABL Programs
SDB Sequence Database Input files
…\GSE Systems\D3 DCS\D3App\Setup\Specific or %D3App%\Setup\Specific
UG1.0047.V12.3‐2A 31
Administratorʹs User Guide
Directories Usage
Ved Vision Editor Files
Model Vision Editor Models
(VED_MODEL*)
…\GSE Systems\D3 DCS\D3App\Ved or %D3App%\Ved
The D3Bin Directory Tree
The following tables list the directories of D3Bin, along the environment variables used with the
D3SET command (where applicable) and their usage. The figure which follows shows the directory
tree as seen in Windows.
…\GSE Systems\D3 DCS\D3Bin or %D3Bin%
UG1.0047.V12.3‐2A 32
Administratorʹs User Guide
The D3SSDB Directory Tree
This is the folder for the D3Source Safe Database for Application Source Code Management. The
figures which follow show the directory tree as seen in Windows.
…\GSE Systems\D3 DCS\D3SSDB or %D3SSDB%
…\GSE Systems\D3 DCS\D3SSDB\Data or %D3SSDB%\Data
UG1.0047.V12.3‐2A 33
Administratorʹs User Guide
…\GSE Systems\D3 DCS\D3SSDB\Users or %D3SSDB%\Users
The D3Uninstall Directory Tree
This directory contains the Uninstall folders created by each D/3 Update kit.
The D3Update Directory Tree
This directory contains the Update Folders for D/3 Update patch kits.
D/3 Tools
Many of the executables found in the D3Bin\Tools folder are not documented or supported. Many
are used for testing and upgrading the system. Undocumented tools are provided for the use of
experienced D/3 field service personnel.
Some of the tools in D3Tools are documented in appropriate manuals:
Documented in the Continuous Control Package User Guide:
MdvGen Imports MDV text files to MDVBuilder
Documented in the Layered Products User Guide:
D3OpcClient Client for OPC
D3OpcPick Browse OPC Data Access Server
DHS_Client Test for DHS_Client
DHSimport Import VMS TrendR files
Documented in the Utilities User Guide:
Beep Test D/3 keyboard Beeper
CST Examine the Circulating Status Table
LED Test Annunciator Lights
LOOK Look at running PCM tasks
Documented in the Upgrade Utilities Reference Manual:
Cnvt_graphic Converts PVN graphics from 9 to 12 character EPNs
Cnvt_sub Converts PVN subpictures from 9 to 12 character EPNs
Cvt81to90 Converts V8.1 MDL text files to V9.0
Cvt101to102 Converts V10.1 MDL text files to V10.2
UG1.0047.V12.3‐2A 34
Administratorʹs User Guide
Cvt102to11 Converts V10.2 MDL text files to V11
Cvt121to122 Converts V12.1 MDL text files to V12.2
CvtPcmDat Converts VMS PCM.Dat file
CvtSiteSetup Converts VMS SiteSetup file
VT10to11Cnvrt Converts VersaTrend Groups from V10 to V11
Documented in the 8000 Series I/O Hardware User Guide
Cvt16kto8kioaddr.exe Converts 16000 Series I/O addresses to 8000 Series I/O addresses
Documented in the PLC I/O User Guide
SetPLCDebug Used to increase the detail of the system messages when debugging a PLC
database.
Other applications include:
ablchk Active Batch List check
abl_debug Debug batch lists
abl_dump.exe Used for debugging batch lists; dump the contents of the ABL and
ABLSTS regions
abl_log.exe
almqdmp Alarm queue dump
almrpt.vbs VB Script to report top 10 alarms
asdump Alarm Summary P1,P2 dump
batsignals Show batch signals
d3fileversion Creates versioned meat dump files
d3units Show D3 nodes
dds_d3_performance Test for D/3 DDS Online server
devchk V9 Device check (Now superceded by Summary Reports)
dump_sap_tables Dump Service Access Point Table
genmsg Generates Simulated Alarms and Events
get_unit_epns Lists EPNs for a sequence unit
HstMon Monitors TrendR process threads
iodump IOSTAT region dump
pcbtest Shows PCBs for SABL programs
pcmqrydmp List PCM query queue
ReadPipe Test Program to read alarms sent to NT pipes
Recover_sap Recovers unused Service Access Points
tip TI programmable calculator simulation
UG1.0047.V12.3‐2A 35
Administratorʹs User Guide
File Versioning
The D/3 software employs a versioning scheme to identify files. This versioning automatically
occurs through the use of D/3 Utilities, which create output files of any kind. This applies to target
outputs (*.UDB and *.REF from MDL or *.LTQ from SIC) as well as auxiliary output files (files
created by the use of the MDL –o switch or the SIC –o or –l switches). The versioning adheres the
following scheme:
When a new file is created, name.ext, the program checks to see if a file with the same name already
exists. If it does, the existing file will be renamed in the following fashion:
name__Vnnn.ext
Where:
name is the file name
V is the versioning identification string used by all D/3 versions
nnn is a three‐digit version number. (007)
Numbers increment as new versions are created. The number of versions of each file saved on each
system is selected through the D/3 Architect. Once the selected number of files to save has been
reached, the oldest version will be deleted whenever a newer version is created. As file versioning
progresses after the maximum number of versions has been reached, the older versions are
renamed (version numbers decremented by one) to keep their version numbers within the selected
maximum range.
If desired, versioning can also be disabled for any D/3 DCM node.
Non D/3 Applications (NOTEPAD, WORDPAD or WORD) do NOT perform D/3 versioning, and
any files created by them are not automatically versioned. The exception to this is when a non‐D/3
application (NOTEPAD) is called within the context of a D/3 utility (D3Edit).
Log files created by D/3 Processes are NOT versioned
The following utilities use D/3 versioning (with the noted exceptions):
D3Edit All source and output files versioned.
D/3 Architect Any file that is output by running D/3 utilities through D/3 Architect
(UDB, UPF etc) will be versioned. System and node settings are also
versioned. Source files editing using notepad within D/3 Architect will
NOT be versioned
WinCOD Config.d3 and reports and EPN category files are versioned
MDL *.UDB, *.REF, ‐o files are versioned*.MDV and *.PRO (prototypes) are not
versioned
POD *.PDB, *.PAT, *.REP (reports) are versioned
UG1.0047.V12.3‐2A 36
Administratorʹs User Guide
XFG *.XIO is versioned
HAC *.HAC and HAC reports are versioned
SIC *.LTQ, *.LST, *.XRF are versioned
UPF/RMS *.RIF, *.RPF, *.VST, *.UPF are versioned
SDB *.SDB, *.STG are versioned, sdbmaster.xrf, sdbshort.xrf are not versioned
GRP All Group files (*.EPN, *.POV etc.) and files created by the –o option are
versioned
CLB *.DAT, *.TXT are versioned
File Versioning setup location in D/3 Architect
UG1.0047.V12.3‐2A 37
Administratorʹs User Guide
Note: File versioning is provided by D/3, not by Windows. Therefore
file versioning is not performed when you run utilities like
UPF and RMS using the Command Prompt window. When
run from the Command Prompt window, files created by
utilities such as UPF and RMS are overwritten by the new
files. It is recommended that utilities such as UPF and RMS be
run via D/3 Architect so that file versioning is performed and
older file versions are retained.
Environment Variables
The D/3 software uses NT environment variables for referencing the various directories.
The following table lists the environment variables used by the D/3 system.
UG1.0047.V12.3‐2A 38
Administratorʹs User Guide
D/3 Environment Variables
D3BIN %D3BIN%
D3APP %D3APP%
D/3 applications also use internal variables to reference D/3 directories and subdirectories. The
variables can be used within some D/3 applications as a filespec.
D/3 Internal Variables
D3TOOLS %D3BIN%\Tools
D3MIC %D3BIN%\Micro
D3CUSTOMER %D3BIN%\Customer
D3DAT %D3APP%\Data
D3CDB %D3APP%\Data\Cdb
D3CFG %D3APP%\Data\CFG
D3CGR %D3APP%\Data\Cgr
D3CLB %D3APP%\Data\Clb
D3CON %D3APP%\Data\Console
D3DBR %D3APP%\Data\Dbr
D3FLX %D3APP%\Data\Flx
D3GPL %D3APP%\Data\Gpl
D3GRA %D3APP%\Data\Gra
D3HAC %D3APP%\Data\Hac
D3NOT %D3APP%\Data\Not
D3PDB %D3APP%\Data\Pdb
D3TMP %D3APP%\Data\Tmp
D3SDB %D3APP%\Data\Sdb
D3XBR %D3APP%\Data\Spc
D3TUN %D3APP%\Data\Tun
D3VMR %D3APP%\Data\Vmr
D3GMS %D3APP%\Gms
D3HIS %D3APP%\History
D3TRD %D3APP%\History\TRD
UG1.0047.V12.3‐2A 39
Administratorʹs User Guide
D3AHF %D3APP%\History\AHF
D3BHF %D3APP%\History\BHF
D3FBD %D3APP%\History\FBD
D3HTD %D3APP%\History\HTD
D3REF %D3APP%\Reference
D3LOG %D3APP%\Log
D3SMP %D3APP%\Sample
D3SET %D3APP%\Setup
D3TXT %D3APP%\Setup\Configuration
D3DDS %D3APP%\Data\Dds
D3RPG %D3APP%\Data\Reports
D3RPD %D3APP%\Data\Reports\RPD
D3CND %D3APP%\Data\CND
Note: To save Alarm History Files to another disk, change the
environment variable D3AHF to point to another disk, then
stop and start the D3AlarmTyper process.
UG1.0047.V12.3‐2A 40
Administratorʹs User Guide
Installation and Setup
This chapter discusses the D/3 Installation and Setup on Microsoft Windows 2003 Server and
Microsoft Windows XP Professional. Post‐Installation procedures, patch installation and license
installation are also described.
Users who are upgrading an existing system should consult the Online Upgrades chapter of this
manual, or if upgrading from the previous release, the Release Notes. If not upgrading from the
previous release, please contact NovaTech Product Support.
System Requirements
The minimum system requirements for the D/3 System are listed below. Additional memory and
faster processors will enhance performance.
System Hardware Requirements
These are minimum hardware requirements to run the D/3 software:
OCM 2.4 GHz Intel® Pentium 4 / 256 MB RAM / 32 MB video RAM / 80 GB hard disk
32 to 64 MB video RAM per monitor is also recommended
DCM 3 GHz Intel® Pentium 4 / 512 MB RAM / 8 MB video RAM / 80 GB hard disk
(32 to 64 MB video RAM per monitor is also recommended if also running Operator Consoles on
the DCM).
CDCM 3 GHz Intel® Pentium 4 / 512 MB RAM / 8 MB video RAM / 80 GB hard disk
– multi processor – server class machine
(32 to 64 MB video RAM per monitor is also recommended if also running Operator Consoles on
the DCM)
Recommended Hardware Platforms
Recommended hardware requirements differ based on the specific application. Please contact
NovaTech for hardware recommendations for your specific configuration. The minimal
recommended hardware platforms are listed below.
CDCM/OCM Raid 1 server with 3.0g dual core CPU, two 650W power
CDCM/OCM RAID1 Dual
supplies for redundancy, 4GB memory, on‐board motherboard
Core 10/100/1000 Enets and additional LAN adapter, six drive hot swap bay,
two 160GB hard drives, one 19ʺ LCD, DVD‐RW, keyboard, optical
mouse, Windows 2003 Server Standard Edition 5 or 10 CALs, and
Microsoft Terminal Server 5 CALs. Supports single monitor only.
D/3 DCM/OCM Raid 1 server with 3.0g dual core CPU, two 650W power
DCM/OCM RAID1 Dual
supplies for redundancy, 4GB memory, on‐board motherboard
Core 10/100/1000 Enets and additional LAN adapter, six drive hot swap bay,
two 160GB hard drives, DVD‐RW, quad video support, one 19ʺ LCD,
keyboard, optical mouse, and Windows 2003 Server Standard Edition
w/5CALs.
UG1.0047.V12.3‐2A 41
Administratorʹs User Guide
D/3 OCM with Intel core 2 duo processor, motherboard plus two 10/100
OCM Duo Processor
Ethernet NICs, 2GB memory, 160GB hard drive, quad video support, one
Console 19ʺ LCD, DVD‐RW, optical mouse, keyboard, and Microsoft Windows
XP Professional.
System Software Requirements
OCM Microsoft Windows XP Professional Edition (Service Pack 2)
This requires disabling of the firewall and other security configurations.
Also (Optional) Office 97 or higher (for Excel use with VersaTrend)
DCM Microsoft Server 2003 (Service Pack 1 and 2) or Windows XP Professional Edition (Service Pack 2)
This requires disabling of the firewall and other security configurations.
CDCM Microsoft Server 2003 (Service Pack 1 and 2)
Also (Optional) Office 97 or higher (for use with @aGlance/DataServer)
D/3 software is compatible with Microsoft .NET V1.1.
Operating system updates were installed form Microsoft, and testing results with D/3 can be found
at NovaTech’s web site.
Hardware ROM Revision Table
Board Description PCM I,II,III,2000, PCM 4100,4200
100 (Multibus) (PICMG)
Status Supervisor Board (SSB) N/A Version 1.2 (9/5/02)
PCM Sboot
Control Data 486 CPU N/A N/A
Embedtec Pentium CPU 2598131‐001 N/A
ROBO CPU N/A 2598329‐0004
Requires xxx141 or xxx822 daughterboard. Version 5/23/07
SIMATIC® 505™ I/O Interface Board
Siemens 505 Remote I/O (MRCC) 2594486‐0007 N/A
(4/18/07)
PCI‐505 N/A Version 0.5 (3/15/07)
Modbus Remote I/O Interface Board
Modicon Remote I/O (MRIOC) 2598160‐0006 N/A
(6/2/08)
Ethernet Multi‐Protocol Controller2 (EMPC2)
N/A
(A40153) Rev C
UG1.0047.V12.3‐2A 42
Administratorʹs User Guide
Board Description PCM I,II,III,2000, PCM 4100,4200
100 (Multibus) (PICMG)
U2 (Not removable; must be flashed to card).
Note: Profibus and ControlNet Interface boards have no ROMs.
New firmware is loaded from the backplane.
Installing D/3 Licenses
All licenses for the D/3 System and layered products are contained in the C:/GSELICENSE folder.
License files must be copied to this folder on the appropriate D/3 nodes.
D/3 licenses are supplied through various media such as floppy disk, e‐mail attachments, and so
on.
The C:/GSELICENSE directory is created during the D/3 software installation process.
The only requirement is that D/3 license files be copied into the C:/GSELICENSE folder before the
D/3 Configuration utility, WinCOD, is run.
Information about the various types of D/3 licenses is contained in the chapter titled D/3 Licenses in
this document.
DCM, CDCM and Data Historian Operating System Settings
The following preinstallation procedures are required in either a workgroup or domain (active
directory) environment for PCs running as CDCMs, DCMs, or Data Historians.
For PCs running Windows 2003 with Service Pack 1, and for PCs running Windows XP with
Service Pack 2 (applies to DCMs only), the PC’s local policy must be changed to relax Local
Policy security settings to the allow the D3File Transfer Service to perform Offline/Online loads
to the DCM. This is done as follows:
1. There are (4) system parameters (registry settings) that need to be changed. The Group
Policy Editor (gpedit.msc) tool will be used to do this. To start gpedit.msc, go to Start Æ
Run Æ gpedit.msc.
UG1.0047.V12.3‐2A 43
Administratorʹs User Guide
Group Policy Object Editor
All (4) of the changes are located under Computer Configuration Æ Windows Settings Æ
Security settings Æ Local Policies Æ Security Options.
a. Choose DCOM: Machine Access Restrictions in Security Descriptor Definition
Language and add ‘anonymous logon’ if it is not there, and then enable full access.
To add ‘anonymous logon’, right click on DCOM: Machine Access Restrictions in
Security Descriptor Definition Language and choose Properties.
Choose Edit Security.
DCOM: Machine Access Restrictions in Security Descriptor Definition Language—Properties
UG1.0047.V12.3‐2A 44
Administratorʹs User Guide
Edit Security—Access Permission
The ‘anonymous logon’ user must have both local and remote access. If
‘anonymous logon’ is not in the list of Group or user names, select the Add button
to open the Select Users or Groups dialog.
Select Users or Groups
From the Select Users or Groups screen, choose Advanced.
UG1.0047.V12.3‐2A 45
Administratorʹs User Guide
Select Users or Groups--Advanced
Then choose ‘anonymous logon’ and set both local and remote access.
b. Choose DCOM: Machine Launch Restrictions in Security. Add ‘anonymous logon’
if it is not there, and then enable full access.
Follow the pattern in section a, and add ‘anonymous logon’ to DCOM: Machine
Launch Restrictions in Security Descriptor Definition Language.
In this case, the ‘anonymous logon’ user must have both local and remote launch
plus local and remote activation access.
UG1.0047.V12.3‐2A 46
Administratorʹs User Guide
Launch Permission
c. Return to the Group Policy main screen (see step 1). Select the policy Network
access: Let Everyone permissions apply to anonymous users and double click on it
to open the dialog below. Select Enabled and click OK.
Network Access: Let Everyone permissions apply to anonymous users
UG1.0047.V12.3‐2A 47
Administratorʹs User Guide
d. In the Group Policy main screen, select the policy Administrative Templates Æ
System Æ Remote Procedure Call.
If the System template is not there, it may be added by right clicking on
Administrative Templates and then choosing Add/Remove Templates
and then choosing the System template to add
To Enable this feature:
Choose Restrictions for Unauthenticated RPC Clients, and enable the feature.
UG1.0047.V12.3‐2A 48
Administratorʹs User Guide
Group Policy Object Editor
In the RPC Runtime Unauthenticated Client Restrictions to Apply: drop‐down list,
select None.
Restrictions for Unauthenticated RPC Clients
Note: This last parameter is particular to operation of TotalVision®,
DCM Alarm Refresh and TrendR™.
UG1.0047.V12.3‐2A 49
Administratorʹs User Guide
Note: A reboot of the system is necessary for these settings to take
effect. Shut down the PC, and then reboot to ensure that the
settings are changed. Using Restart from the Start Menu does
not always effectively change the parameters.
If a DCM is running Windows XP with Service Pack 2, the firewall must first be disabled for the
DCM status to be exchanged with the CDCM:
2. Turn off Firewall: Computer Management Æ Services and Applications Æ Windows
Firewall
Windows: My Computer Æ Manage Æ Computer Management
3. Stop and Disable Windows Firewall/ Internet Connection Sharing (ICS)
If a DCM is running Windows XP with Service Pack 2, the Simple file sharing feature must first
be disabled for the DCM status to be exchanged with the CDCM:
4. Turn off Simple file sharing: Windows Explorer Æ Tools Æ Folder Options Æ View tab.
UG1.0047.V12.3‐2A 50
Administratorʹs User Guide
Windows: Explorer Æ Tools Æ Folder Options (View Tab)
Installing the D/3 System Software on Windows Server 2003 and XP
Professional Editions
D/3 System software is supplied on a single CD. The installation procedure uses the InstallShield
Wizard.
Note: Before installation of a new version of D/3 is attempted, all existing D/3
software must be stopped, uninstalled and the system restarted. See
Uninstalling D/3 Software on page 84.
Several services must be stopped before the uninstall operation is started. These include:
• D3 Node Manager
• D3FileTransferService
• D/3 Data Historian Service
UG1.0047.V12.3‐2A 51
Administratorʹs User Guide
• D/3 OPC Alarm/Event Service
• D/3 Diagnostic Svc
• D/3 nmsDcmPrefMonitor
See the section titled Uninstalling D/3 Software if necessary for more information.
To install D/3 V12.3 system software:
1. Close all active programs running on the PC.
2. Exit any virus protection programs.
3. Shut down any running SQL servers.
Warning: If the D/3 is to be installed on a system using Domain policy
and/or active directory with Microsoft’s default rules in
place, the required D/3 accounts will not get created by the
D/3 installation procedure. It is necessary to create the D/3
accounts of D3Administrator, D3Operator, D3Maint and
D3Internal and assign them appropriate “Complex
Passwords” for your system configuration prior to
proceeding. Be aware that the D3Manager utility requires a
password of no more than 12 characters. Administrative
Accounts with Null passwords should not be used for D/3
installations; this may lead to D/3 component registration
problems.
4. Insert the D/3 System Software CD into the CD‐ROM drive of the PC. The CD should
autostart and allow you to proceed to step 11 (Welcome screen). If not, follow steps 5 to 10.
UG1.0047.V12.3‐2A 52
Administratorʹs User Guide
5. Start the Add/Remove Programs applet in the Windows Control Panel.
Add/Remove Programs
6. Click on the Add New Programs icon in the taskbar on the left.
7. Click the CD or Floppy button when the Add Remove Programs Dialog appears.
UG1.0047.V12.3‐2A 53
Administratorʹs User Guide
8. Be sure that the D/3 System Software CD is in the CD‐ROM drive of the PC.
Click on the Next> button.
Insert CD
9. The system should find the D3InstallSelector.exe program on your CD. However,
depending on your system configuration, you may have to browse to find
D3InstallSelector.exe.
10. Click on the Finish button when the path to the InstallSelector.exe program is displayed in
the Open: field.
Installing the D/3 Installation Selector
UG1.0047.V12.3‐2A 54
Administratorʹs User Guide
11. The Welcome screen appears. Click on the Next> button to choose the D/3 Installation.
D/3 Installation Selector—Welcome
12. In the Installation Options screen, choose D/3® Standard Installation.
Installation Options
Click on the Next button after choosing the D/3 Standard Installation. The D/3 Standard
Installation is documented in this chapter. Refer to the Online Upgrades chapter for running
the online upgrade procedure for a CDCM or DCM.
UG1.0047.V12.3‐2A 55
Administratorʹs User Guide
13. The next screen confirms the installation type that you selected. Select Next> to continue.
Verifying selections
14. Select Begin to continue, or Cancel to start over.
Start installation
UG1.0047.V12.3‐2A 56
Administratorʹs User Guide
15. The D/3 product logo will appear and Install Shield will run to initiate the D/3 System
installation procedure.
Click on the Next> button when the following window appears.
Installer welcome screen
16. Read the D3 DCS Setup License Agreement information as instructed.
Click the I agree... radio button if you accept all the terms of the License Agreement.
License Agreement
UG1.0047.V12.3‐2A 57
Administratorʹs User Guide
17. Type in the User Name, Company Name and Serial Number in the fields provided.
Click the Next> button when ready to proceed.
User Information
18. In the next screen, Select Components depending on unit type, there are several
installation options available as follows:
D3DCM Examples
DCM Baseline
CDCM
D3Sample Application
Include Files
D3Console Program Files
D3Manager D3Manager Client
Data Historian Data Historian Files
Help Files Help program Files
OPC Client OPC Client Files
TotalWebVision VRT Program Files
VRT Examples
TotalVision® Editor TotalVision® Editor
Select the desired D/3 components and click Next>.
UG1.0047.V12.3‐2A 58
Administratorʹs User Guide
Program features
19. Select the desired directory where executable files will be installed. A default location is
suggested, or a different location can be used by clicking the Change… button to browse the
directory structure.
Installation directory for executable files
UG1.0047.V12.3‐2A 59
Administratorʹs User Guide
20. Choose the Destination Folder into which you want D/3 Application Files installed.
Click the Next> button to install in the default location:
C:\Program Files\GSE Systems\D3 DCS
Installation directory for D/3® Data and Application files
21. Specify a location for the installation of shortcuts.
Shortcut folder
UG1.0047.V12.3‐2A 60
Administratorʹs User Guide
22. In the next screen, choose how the D/3® DCS Setup program should handle log files. Up to
five log files will be produced. They can be appended to any existing log files, or new files
can be created, depending upon the selection made.
Log file handling
23. The log file option you have chosen is confirmed in the following screen. Click Next to
continue, or Back to change.
Confirm log options
UG1.0047.V12.3‐2A 61
Administratorʹs User Guide
24. The following information window will appear. Click the Next> button to proceed.
Information—Ready to Install
When the Installation Successful window appears, click on the Reboot button to reboot the
system now. Otherwise, click Finish, and reboot at a later time.
You will also see an alert screen that will ask if you wish to append the current
installation’s log file to the previous log file, or if you want to start a new log file.
Click Yes to append to the previous log file, or No to start a new one.
Note: A system restart is required after setup is complete.
Installation Successful
UG1.0047.V12.3‐2A 62
Administratorʹs User Guide
Post Installation Procedures
The setup procedures that must be performed to complete the installation are listed in the subtopics
that follow.
Note: The D/3 installation process creates three new user groups,
D3ADMINISTRATORS, D3MAINTENANCE and
D3OPERATORS. The installation process also creates four
new users, D3ADMINISTRATOR, D3MAINT, D3OPERATOR
and D3INTERNAL. This is an important distinction because
Windows assigns privileges to Groups, not to Users. Users
acquire privileges by being assigned to (by being members of)
Groups.
System Reboot
When the system is rebooted after installation of D/3 system software, five batch files are run
automatically.
These batch files set the D/3 environment variables, register the D/3 services (such as D/3 Node
Manager, D3FileTransfer Service, and Data Historian Service), and create the Dynamic Alarm
Management SQL database and Alarm Suppression SQL database.
The Accounts batch file, which runs prior to the D/3 install, creates the D3ADMINISTRATORS,
D3MAINTENANCE, and D3OPERATORS groups and the D3ADMINISTRATOR, D3MAINT and
D3OPERATOR user accounts. A D3INTERNAL account is also setup to support the D3Diagnostics
package.
Before an individual User can conduct D/3 administrative functions, their User Name must be
made a member of the D3Administrators Group.
The installation procedure installs a D3ADMINISTRATOR user account that can be used. The first
logon as ʺD3ADMINISTRATORʺ will not require a password, but it will require that the password
be changed for future logons. The same is true for the new D3MAINT and D3OPERATOR user
accounts. However, it is not recommended that the D3ADMINSTRATOR user account be used
generally. Rather, it is recommended that individuals be given their own user accounts on the D/3
CDCM that bear an identical user name and password to that of their enterprise network user name
and password. In fact, this is mandatory if an individual needs to use D/3ʹs OLE for Process Control
(OPC) connectivity from their desktops unless Active Directory accounts are used (see below).
Note: Be aware in creating passwords that the D3Manager utility
requires a password of no more than 12 characters. If the
password for the account is too long D3Manager will not be
able to run.
UG1.0047.V12.3‐2A 63
Administratorʹs User Guide
Warning: If the D/3 was installed on a system using Domain policy
and/or active directory with Microsoft’s default rules in
place, the required D/3 accounts will not get created by the
D/3 installation procedure because the accounts are set up
without passwords and “Complex Passwords” is the
Microsoft default. It is necessary to create the D/3 accounts
of D3Administrator, D3Operator, D3Maint and D3Internal
and assign them appropriate “Complex Passwords” for your
system configuration prior to proceeding.
Note: The D3INTERNAL account is not intended for user logons,
but is used by D/3 processes. Do NOT change the password
for this account.
Set up existing user accounts
Use the Windows ʺUsersʺ management function to modify any existing users/accounts to be part of
the D3ADMINISTRATORS, D3MAINTENANCE or D3OPERATORS groups.
Note: Account names must be 20 characters or fewer and have
passwords of 14 characters or fewer to be able to logon to D/3
utilities such as D3Manager. Be aware that account names
sometimes have their domain name appended prior to logon.
Click: Start | Settings | Control Panel and double click on the Administrative Tools icon and
double click on the Computer Management icon
Or
Right click the My Computer icon on the Windows Desktop and select Manage from the popup
menu
Then select Local Users and Groups | Users from the tree view.
D3ADMINISTRATORS have full privileges within the D/3 system, in order to have full control of
all engineering functions. Each engineer (account) must be a member of the D3ADMINISTRATORS
group. It is recommended that the person doing the initial installation have a pre‐established User
Name and Password on the PC that is the same as their enterprise User Name and Password.
The D3MAINTENANCE group has a limited set of privileges within the D/3 System. Maintenance
personnel should be members of the D3MAINTENANCE group.
D3OPERATORS have minimal privileges within the D/3 System. All Operators’ accounts should be
members of the D3OPERATORS group.
UG1.0047.V12.3‐2A 64
Administratorʹs User Guide
Note: The set of privileges assigned to the D3OPERATORS group is
a subset of the set of privileges assigned to the
D3MAINTENANCE group, and the set of privileges assigned
to the D3MAINTENANCE group is a subset of the set of
privileges assigned to the D3ADMINISTRATORS group,
therefore each user only needs to be made a member of one
group.
Computer Management—d3operator Properties
UG1.0047.V12.3‐2A 65
Administratorʹs User Guide
Using Active Directory Accounts
The D/3 System can be used in either a Workgroup or Active Directory environment, but if Active
Directory accounts are to be used (instead of local accounts and groups), then some additional post
installation procedures must be performed.
1. Add three global groups to the Active Directory that includes the D/3 System. These groups
can have any name, but should be easily recognizable as the global version of the
D3ADMINISTRATORS, D3MAINTENANCE and D3OPERATORS groups. For example the
groups could be called DomainD3Admins, DomainD3Maintenance and
DomainD3Operators, which would make them appear in the list near all of the other
Domain groups. Optionally, they might be called D3DomainAdmins,
D3DomainMaintenance and D3DomainOperators, which would place them in the list near
other D3 accounts if the D/3 were installed on a domain controller.
Note: Account names must be 20 characters or fewer and have
passwords of 12 characters or fewer to be able to logon to D/3
utilities such as D3Manager. Be aware that account names
sometimes have their domain name appended prior to logon.
2. If D/3 software is installed on a domain controller, make the local D/3 accounts
D3ADMINISTRATOR, D3MAINT and D3OPERATOR members of their respective global
groups. This should also be done for any other local accounts that will require D/3 access.
3. On each D/3 node that is an Active Directory member, add the new D/3 global groups as
members of the standard D/3 local groups.
4. If the CDCM is not a domain controller, any domain user that needs access to D3Architect
or WinCOD must have a corresponding local account on the CDCM with the same user
logon name that should be disabled.
5. Whenever a user accesses a D/3 application that requires a logon (D3Manager, D/3
Diagnostics® or Alarm Suppression Manager), the user should use a standard Active
directory logon of the form <domain>\<user logon> in the User Name field.
Configure D3_Servers
Using the D/3 Architect, select System Files / D3 Servers, and add the D3_ONLINE and REGISTRY
@ IWNTservers. Ensure that the Add All option is selected under Protocol Names. Refer to the
“Configuration and Management Tools Userʹs Guide” for additional information about D/3
Architect and DDS_Services.
The menu for adding servers is obtained by clicking on the down caret shown under the mouse
pointer in the image below.
UG1.0047.V12.3‐2A 66
Administratorʹs User Guide
D3Architect—System Files/D3 Server Properties
Configure the Data Historian Server
Using the Control Panel applet, Data Historian Service, configure the DHS. Refer to the sections
titled ʺTrendR Setup and Configurationʺ and ʺData Historian (DHS) Configurationʺ in the “Layered
Products Userʹs Guide” for additional information about the DHS applet.
UG1.0047.V12.3‐2A 67
Administratorʹs User Guide
D/3 Data Historian Server Properties
Configure the Data Historian Serverʹs TCP/IP address
Using the D3 Architect / System Settings window, configure the TCP/IP address(es) of the Data
Historian Server(s). This step also causes the system to create the initial D3SYSTEM_SETTINGS.dat
file.
D3 Architect / System Settings
UG1.0047.V12.3‐2A 68
Administratorʹs User Guide
Configure D/3 Node Manager
Using the Control Panel applet, Node Manager Service, configure the D/3 Node Manager. Refer to
the section titled ʺD3 Node Manager Serviceʺ in the “Configuration and Management Tools Userʹs
Guide” for additional information about D/3 Node Manager.
Check the check box on the Startup tab if you want D/3 to automatically startup when D/3 Node
Manager is started when the DCM is booted.
Control Panel—D/3 Node Manager Service Properties—Startup tab
Typically, the default Use Default Continue on Error flags should be kept.
Control Panel—D/3 Node Manager Service Properties—Error Handling tab
UG1.0047.V12.3‐2A 69
Administratorʹs User Guide
Create Initial CDCM Settings file
1. Click on the CDCM name in the tree view (left side) of D3 Architect to call up the CDCMʹs
settings files.
2. Click on the CDCM name Settings file in the data view (right side) of D3Architect to call up
the CDCMʹs Settings dialog screen.
3. Click on the Other tab.
D3Archtiect—CDCM Settings—Other tab
4. Enter a date into the ‘Date of last VMS based histrend’ field indicated by the mouse pointer
below.
If this is an upgrade, then enter the date that the last VMS based history file was archived.
If this is a new system, or if no old VMS history files are to be brought forward, then simply
enter todayʹs date.
5. Click the OK button to create the initial CDCM name settings file.
D/3 should now be able to start.
Start D/3
1. From the Windows Start menu, click D3 DCS | Online Tools | D3 Manager.
2. Enter the computer name of the DCM in the DCM: field
3. Enter the installers User Name (or Domain\User Logon for Active Directory accounts) in
the User Name: field.
This User Name must already have been added to the D3administrators Group.
4. Enter the appropriate Password in the Password field.
UG1.0047.V12.3‐2A 70
Administratorʹs User Guide
5. Click the OK button.
D3Manager Login
The D3 Manager window for the CDCM will appear.
6. Right Click on the word System in the System Summary (left side) of the window.
7. Left Click on the Start D3 on this DCM menu item as indicated by the mouse pointer in the
image below. The D3 Startup for DCMname will pop up.
D3Manager—System—Start D3 on this DCM
8. Click on the Execute button and wait for the D/3 startup sequence to complete.
UG1.0047.V12.3‐2A 71
Administratorʹs User Guide
9. Expect the first two and the last three check marks to turn green.
Expect the Load DCMname Applications check mark to become a red X because there are
no applications to load at this time.
D3 Startup Command Sequence
Create Initial CDCM Faceplate groups
The D3 Console Manager (ConMan) will not start up if the Faceplate Groups do not exist. D/3 must
be running (step 8 above) to build the initial Faceplate Groups.
1. Click on the CDCM name in the tree view (left side) of D3 Architect to call up the CDCMʹs
settings files.
2. Click on Faceplate Groups in the data view (right side) of D3Architect to call up the
CDCMʹs EPN.cmd dialog window as shown below.
UG1.0047.V12.3‐2A 72
Administratorʹs User Guide
3. Click on the Build button.
CommonEpn.cmd dialog
4. Click on the Build All check box.
The check box will clear and the blank icon to the right of it will turn green.
Build
Copy Required D/3 Notebook Notes
The D3 Notebook will call up certain default notes if no specific note is created for the current EPN or
group. These default notes are provided in the Reference directory, and will not start up if the Faceplate
Groups do not exist. D/3 must be running (step 8 above) to build the initial Faceplate Groups.
Click on the CDCM name in the tree view (left side) of D3 Architect to call up the CDCMʹs settings files.
UG1.0047.V12.3‐2A 73
Administratorʹs User Guide
D/3 DCS Security
The Console Manager can be executed by either of two methods; (1) opening an existing console manager
document (*.Con), or (2) executing the Console Manager program directly (ConMan.exe).
Note: This chapter is provided primarily for information purposes.
Typically, there should be no need to alter D/3 DCS Security at
installation time. Default D/3 DCS Security should be
adequate for the majority of D/3 installations.
When an existing console manager document is opened, the user is not allowed to change critical settings
such as the console slot, DCM name, D/3 keyboard port, autostart options, etc. The user is also not
allowed to save changes to the existing document.
When the Console Manager program is executed directly, the user is prompted for all settings, and is
allowed to save the document. Therefore, the user may connect to any DCM and utilize any console slot.
As a security measure, a user must be authorized to execute the Console Manager program directly. No
special authorization is required to execute existing documents.
The three accounts created by the D/3 Installation (D3OPERATOR, D3MAINT, and
D3ADMINISTRATOR) all allow running the Console Manager program. However, the D3OPERATOR
account does not allow the Console Manager program to be run directly from the start menu. Instead,
D3OPERATOR may only open existing console manager *.CON files located on the desktop or menu. The
D/3 system manager can set these up by copying an existing *.CON file to the D3OPERATORS desktop or
start menu. The option to create a *.CON file is provided upon exiting the Console Manager.
In order to execute the Console Manager program directly (not using a *.CON file) from an account that is
not a member of the D3ADMINISTRATORS or D3MAINTINANCE group, requires providing the
account with the “SeSecurityPrivilege” as part of the user profile. The “SeSecurityPrivilege” is identified
as “Manage auditing and security log” in the Windows Local Security Policy Editor.
Recall that Windows does not assign privileges directly to user accounts, but rather to Groups
(Administrators, Power Users, Backup Operators, etc.) The D/3 installation procedure sets up groups for
D3OPERATOR, D3MAINTENANCE, and D3ADMINISTRATOR. Each Group has a set of privileges
associated with it. Each User may be a member of any or all Groups. The D3OPERATOR user is a
member of the D3OPERATOR group; the D3MAINT user is a member of the D3MAINTENANCE group;
and the D3ADMINISTRATOR user is a member of the D3ADMINISTRATOR group. For a User to have
“SeSecurityPrivilege”, the User must be a member of at least one Group that has this privilege. A standard
Windows installation contains a Group named “Administrators”, which is the only Group that has the
“Manage auditing and security log” (“SecurityPrivilege”) privilege. Therefore, by default, only Users that
are members of the “Administrators” Group can execute the Console Manager program directly.
The Windows Local Security Policy Editor may be used to add the “Manage auditing and security log”
privilege to Groups other than “Administrators”. For example, adding this privilege to the “Power Users”
Group would allow any User who is a member of the “Power Users” Group to execute the Console
Manager program directly. This would be done to eliminate the need for a User to be a member of the
“Administrators” Group, which typically includes other privileges as well.
UG1.0047.V12.3‐2A 74
Administratorʹs User Guide
To assign the “Manage auditing and security log” privilege to a Group:
1. Start the Windows Local Security Policy Editor found under Programs | Administrative
Tools| Local Security Policy.
2. Select Local Policies found under Security Settings.
Local Security Settings—Local Policies
3. Select User Rights Assignment. The list of Groups containing this privilege are shown in
the Local Setting column.
Local Security Settings—User Rights Assignments
User Rights Assignment—Policies and Settings
Note: Changes are not applied to the current user session; the user
must log out and back in before the changes take effect.
To use accounts other than the Administrator, it will be necessary to allow these accounts to modify
the D/3 registry settings. The following steps will modify the registry.
1. Click the Microsoft Start menu.
UG1.0047.V12.3‐2A 75
Administratorʹs User Guide
2. Select Run.
3. Type REGEDT32.
4. Select HKEY_LOCAL_MACHINE.
5. Double‐click SOFTWARE.
6. Double‐click GSE_SYSTEMS.
7. Select Security from the main REGEDT32 menu.
8. Select Permissions.
9. Select Everyone.
10. Modify type of access to Full Control.
11. Check the Replace Permissions on existing Subkeys box.
12. Click OK.
13. Click Yes when asked if you want to save changes.
14. Select Registry from the main REGEDT32 menu.
15. Select Exit.
The TotalVision® Registry Servers
The TotalVision® Registry Servers must be configured before models may be built and displayed.
Setup for Windows is summarized below.
There are two modes that determine registry operation:
• Primary ‐ Main graphics development node, 1 per system required
• Secondary ‐ Display node which maintains local copies of all models
To configure the registry, determine which Windows workstation will serve as the graphics
development node. This is the primary registry. Other nodes in the system are considered as
secondary or local.
Registry servers are configured through D3Architect, using the D3 Servers dialog. Refer to the
“Configuration and Management Tools Userʹs Guide” for additional information.
UG1.0047.V12.3‐2A 76
Administratorʹs User Guide
D3Architect—D3 Servers—Server Properties
A Registry Server is added by clicking the Add button to open the Server Properties dialog.
The appropriate data is entered when the OK button is clicked (in the Server Properties
window) or the Apply button is clicked (in the D3 Servers window).
UG1.0047.V12.3‐2A 77
Administratorʹs User Guide
Server Properties—DCMT2-S node added
The primary node is the first node in the system list and all subsequent nodes are considered
secondary. The Up and Down buttons are used to move a serverʹs position in the list.
After adding the Registry Servers, you must reload the CDCM and DCMs. This is accomplished
with the D3Manager tool. Refer to the “Configuration and Management Tools Userʹs Guide” for
additional information on the use of D3Manager.
UG1.0047.V12.3‐2A 78
Administratorʹs User Guide
DCM Load Test
Host Files
Each DCM must be configured in the C:\Windows\system32\drivers\etc\hosts file.
Entries should appear as follows:
10.51.100.0 CDCM # Primary link to node CDCM
10.52.100.0 CDCM‐S # Secondary communications link to node CDCM
Defining nodes using a Distributed Naming Service is not recommended.
DCM Software Installation Procedure
Each DCM must have DCM software installed and databases copied from the CDCM using
D3Manager. DCM software is installed using the standard D/3 installation kit. On the D3DCS Setup
Select Components page do not choose the CDCM software option.
Follow the steps listed below to install D/3 software on a DCM.
1. Install OCM runtime licenses if OCM software is to run on the DCM.
UG1.0047.V12.3‐2A 79
Administratorʹs User Guide
2. Install D/3 Version 12.3 DCM software and optional software such as OCMs and
TrendR Configuration licenses are required on the CDCM.
3. Reboot.
4. Load the DCM using the D3Manager utility (from the DCM or CDCM).
5. Start the DCM nodes using D3Manager (from the DCM or CDCM).
6. Start OCM consoles that connect to the DCM using the D/3 DCS main menu.
Note: On reboot of an OCM after the installation of OCM software, an error
message pops up indicating that the file d3nmsdcmlimits.bat cannot be found.
Reply OK. This file is not used on an OCM.
Historian Software Installation on non‐D/3 node
A Historian may be configured on a PC, which is not a D/3 node. Each Historian must have
Historian software installed. Historian software is installed using the standard D/3 installation kit.
On the D3DCS Setup Select Components page, choose only the Historian software option.
The pre‐installation procedures given in the topic DCM, CDCM and Data Historian Operating
System Settings on page 43 must be followed if the Historian is running Windows XP with Service
Pack 2 in either a workgroup or domain (active directory) environment. The firewall must first be
disabled for Historian data to be exchanged with the CDCM.
Historian Software Installation Procedure
1. Install D/3 Historian software.
2. Reboot. The D3Historian Service will run on startup.
3. Be sure that D3Architect has the IP Address of the Historian configured in the System
Settings.
Modifying D/3 System Software on Windows Server 2003 and
Windows XP Professional Editions
D/3 System software is supplied on a single CD. The standard Windows Installation Wizard
permits modification of the installation of D/3 components.
1. Exit any virus protection programs.
2. Start Add or Remove Programs from the Windows Settings | Control Panel menu.
3. Select D3 DCS 12.3. The option buttons appear.
4. Click the button.
UG1.0047.V12.3‐2A 80
Administratorʹs User Guide
Add or Remove Programs—Change or Remove
5. After selecting the Change button, the Welcome screen appears. Click Next>.
Welcome
6. Click Yes in the Previous Install Detected screen, and continue.
Previous Install Detected
7. D/3® DCS Setup calls up the same Select Components window that was seen during the
initial D/3 installation process.
Checking an un‐checked check box will cause that component to be installed as a result of
this procedure.
Note: To uninstall a component, D/3 must be uninstalled and re‐
installed with the desired components.
UG1.0047.V12.3‐2A 81
Administratorʹs User Guide
Leaving a check box selected (checked) will cause that component to be left as‐is.
Make the appropriate selections and de‐selections and then click Next> to proceed.
Select Components
There are several installation options available as follows:
D3DCM Examples
DCM Baseline
CDCM
D3Sample Application
Include Files
D3Console Program Files
D3Manager D3Manager Client
Data Historian Data Historian Files
Help Files Help program Files
OPC Client OPC Client Files
TotalWebVision VRT Program Files
VRT Examples
TotalVision™ Editor TotalVision™ Editor
UG1.0047.V12.3‐2A 82
Administratorʹs User Guide
8. The Select Directory for Executable Files screen asks the user to specify a location for those
files.
Select Directory for Executable Files
9. The Select Directory for Application Files screen asks the user to specify a location for
those files.
Select Directory for Application Files
UG1.0047.V12.3‐2A 83
Administratorʹs User Guide
10. The Shortcut Folder screen asks the user to specify a location for shortcuts.
Shortcut Folder
11. When the Installation Successful screen appears, click Finish. Reboot the system in order
for the changes to take effect.
Installation Successful
Uninstalling D/3 Software
The standard Windows Installation Wizard permits uninstallation of D/3 components.
UG1.0047.V12.3‐2A 84
Administratorʹs User Guide
1. Before D/3 uninstallation is performed, all D/3 software patches must be uninstalled. See the
section on uninstalling D/3 Patches for how to perform this action.
2. Before D/3 uninstallation is performed, all D/3 software on the DCM or OCM must be
stopped using D3Manager.
3. Several services also must be stopped before the uninstall operation is performed. These
include:
• D/3 Node Manager
• D/3 File Transfer Service
• D/3 Data Historian Service
• D/3 OPC Alarm/Event Service
• D/3 Diagnostics Service
• D/3nmsDcmPerfMonitor
These services can be stopped by using the Services applet.
Click Start | Settings | Control Panel | Administrative Tools | Services.
Stop each D/3 service by right clicking on the service and selecting the Stop menu item.
Computer Management—Services
4. Once the services are stopped, run the batch file D3BIN\UNREGD3NMS.BAT. This file
removes the stopped services.
UG1.0047.V12.3‐2A 85
Administratorʹs User Guide
Run Batch File
5. It is also necessary to stop the D3MON task. The D3MON icon can be seen at the lower right
corner of the screen.
D3MON
D3MON can be stopped either from the Windows Task Manager, or by right‐clicking on
the task bar icon and then left‐clicking on the Exit menu item. These options are illustrated
in the following two figures.
Stop D3MON using the Windows Task Manager
UG1.0047.V12.3‐2A 86
Administratorʹs User Guide
Stop D3MON using the D3MON task bar icon—Exit menu
6. The D/3 uninstall does not delete the files in D3App or D3Bin\Customer. However, it is
always a good idea to make sure you have a backup copy of these folders. If you do not
have a backup, make one now.
7. D/3 uninstall does not uninstall the SQL Server. If you plan to uninstall the SQL Server, you
should backup the Dynamic Alarm Management and Alarm Suppression SQL Databases.
8. Proceed to uninstall D/3 using the standard Windows Control Panel.
Click Start | Settings | Control Panel | Add|Remove Programs | Change or Remove
Programs | D3 DCS | Change|Remove.
Add/Remove Programs
9. On the Uninstall D3 DCS screen, click on the Next> button.
UG1.0047.V12.3‐2A 87
Administratorʹs User Guide
Uninstall D3 DCS
You will see the Uninstallation In Progress screen.
Uninstallation In Progress
10. The following window will appear upon the completion of the uninstall process. Click on
the Finish button. Rebooting the computer removes the D/3 from the NT registry.
Uninstallation Successful
UG1.0047.V12.3‐2A 88
Administratorʹs User Guide
Installing D/3 Patches
D/3 Patches are installed using a D/3 patch kit using the standard Windows Installation Wizard.
Each Patch Kit consists of a Zip file with a patch number for a file name, such as 12120015_118.ZIP.
A folder in the \D3 DCS\D3Updates folder is created for each patch. The patch is unzipped in this
folder. Upon installation of the patch, a folder is created in the\D3 DCS\D3Uninstall folder for
each patch. This folder stores copies of original files replaced with this patch, in case the patch
needs to be uninstalled. Both the install and uninstall write into the D3 System Log file.
Be sure to read the Readme file included with each patch kit for specific instructions on installation
of each patch.
Before installing a D/3 patch:
• D/3 must be up and running on the system on which the update is being applied.
• When installing patches on a newly installed D/3, D3Architect must be started at least once
in order to write out the proper settings files.
• The patch kit verifies that the patch is being applied against the proper D/3 version. This
information is stored in a D/3 environment variable. When installing patches on a newly
upgraded D/3 the environment variable containing the version must be correct. If the
version is not correct, open the System Settings File in D3Architect to write out the correct
version and then use D3Manager to load the system environment variables.
To Install a D/3 patch:
Modify the patch number in step 1 to match the kit to be installed.
1. Create the folder on the D/3 Data drive EXACTLY as follows: \Program Files\GSE
Systems\D3 DCS\D3Updates\12120015_118
2. Copy the update kit zip file to the folder in step one.
3. Use WinZip to extract the files from the zip file to the same folder location (Step 1 folder).
4. Double click on the .exe file in this folder and make sure of the following:
• the patch executables are copied to the correct folder,
• the old patch executables are copied to the Uninstall folder,
• the installation of the patch is recorded in the D3System log file, which can be accessed
through the start menu\D3DCS\System Log.
If you have any questions or problems with the installation, call NovaTech Product Support.
UG1.0047.V12.3‐2A 89
Administratorʹs User Guide
To Uninstall a D/3 patch:
The patch can be uninstalled through the ADD or REMOVE programs in the Control Panel. All D/3
patches must be uninstalled prior to uninstalling the D/3. The uninstall will
• Copy the previous patch executable to the correct location.
• Record the uninstallation of the patch in the D3 System Log file.
UG1.0047.V12.3‐2A 90
Administratorʹs User Guide
Online Upgrades
This chapter provides information on performing online upgrades to the D/3®.
In This Chapter
Overview Pre‐Installation of Legacy Files
Pre Online Upgrade Checklist Disconnect CDCM
Pre Installation Guidelines Automated D/3® Uninstallation
Suspending an Online Upgrade Activating the D/3® 12.3 Installation Procedure
Activating the Online Upgrade Procedure License Installation
Backing Out of an Online Upgrade Post D/3 Installation Steps
Starting the Online Upgrade Configuring the Replacement CDCM on the Network
Upgrading a CDCM vs. Replacing a CDCM Converting Database Text Files on the CDCM
Installation and Setup Starting the D/3®
Material Prerequisites to an Online Upgrade Rebuilding I/O Configurations on the CDCM
Verifying System Prerequisites Building New Databases on the CDCM
Operational Prerequisites to an Online Upgrade DCM Upgrade
Operating System Upgrade Automated Preparation for PCM Online Upgrade
Archiving Legacy Files Performing a PCM Online Upgrade
Acquiring the Legacy Application Files Concluding an Online Upgrade
Archiving the Legacy Application Files Uninstalling the Online Upgrade Procedure
Archiving Legacy Databases Troubleshooting
Overview
The Online Upgrade (OU) capability provides the ability to upgrade the CDCM, DCMs and PCMs
comprising a legacy D/3 system to the most recent version of the D/3 with little or no disruption to
ongoing plant production. The OU automated procedure is installed on the target CDCM and
DCMs. This procedure assists qualified D/3 personal to copy existing D/3 applications from the
legacy CDCM or DCMs to the upgraded PC and rebuild it under the new version. While many D/3
users may use an upgrade as an opportunity to upgrade their PC hardware, it is possible to
upgrade a CDCM or DCM on the same PC, provided it meets or exceeds the hardware
requirements for the upgraded software.
During the upgrade, an enhanced version of D3Manager allows the user to load the new software
to the backup PCM, freeze the legacy PCM, take a snapshot of the running legacy PCM, transfer the
snapped databases to the backup upgraded PCM converting them to the latest version and then
switch control to the upgraded PCM. When a legacy PCM is failed over to an upgraded PCM, the
UG1.0047.V12.3‐2A 91
Administratorʹs User Guide
OUSNAP task is run in the upgraded PCM. This task creates a snapshot of all the databases in
legacy PCM and moves all the values over to the upgraded PCM in the proper locations.
D/3 legacy software can be upgraded online to the current version from any previous version
beginning with V10.2. Online upgrades are available for redundant PICMG (4100 and 4200) PCMs
and redundant Multibus PCMs that have a Pentium CPU. To perform an online upgrade a system
must have at least one DCM in addition to the CDCM, and the E0 and E1 networks must be isolated
from non‐D/3 nodes on the plant network. The OU utility covers the upgrade of the standard D/3
software but does not apply to any special software that may have been created for a specific
project, FlexBatch, or SimSuite Pro.
OU is an automated procedure that performs the following tasks:
copies the legacy CDCM or DCM databases to the PC to be upgraded (if different from the
source) and create copies to allow backing out of the procedure in the event of problems;
uninstalls the legacy D/3 software, if the same PC is to be used;
installs the latest D/3 Installation kit;
assists the user in upgrading the legacy CDCM text files and databases to the latest version;
loads backup PCMs with upgraded software and databases;
freezes the Scan tasks in the legacy PCM, creates a snapshot of the current state of the legacy
PCM, copies the snapshot to the upgraded backup PCM converting the database to the
latest version and then forces PCM failover to the backup containing upgraded software;
reloads newly non‐selected (backup) PCMs with upgraded software (and re‐enables
failover);
directs the user to upgrade OCMs;
directs the user to upgrade DCMs;
returns all system components (CDCM, DCM and PCM) to Normal operating mode.
The Online upgrade procedure for a DCM is similar to the CDCM. During this procedure, the
upgraded DCM requests a download of the required databases from the upgraded CDCM.
While the online upgrade is in progress, upgraded or modified software maintains operations
between PCMs containing temporarily incompatible software versions.
During the online upgrade, the system will be in a mixed mode state in which some DCMs and
PCMs are running legacy software and other DCMs and PCMs are running upgraded software.
Information displayed on Operator Console displays running on upgraded DCMs is only valid for
upgraded PCMs; and information displayed on Operator Console displays running on legacy
DCMs is only valid for legacy PCMs. Depending on the configuration of the Total Vision graphics
registry and the D/3 Servers, the graphics on a legacy DCM may be upgraded from an upgraded
DCM server upon viewing the graphic. Care must be used in viewing data from D3_Online to
know where that data originates.
UG1.0047.V12.3‐2A 92
Administratorʹs User Guide
With the potential for confusion on data sources on various displays while running in a mixed
mode, NovaTech recommends that the actual failover from legacy to upgraded PCMs proceed
quickly. Running in a mixed mode for any extended time is not recommended.
Note: Due to the process critical nature of performing an Online
Upgrade, it is mandatory that the user work with qualified
NovaTech Field Service personnel to perform any Online
Upgrade.
Warning: Online upgrades should not be done on any system with
PCMs showing as offline unless those PCMs are known to be
turned off. A legacy PCM that is reconnected to the system
after an online upgrade may corrupt the CST.
Warning: The D/3 system has thousands of possible software and
hardware configurations from V10.2 to the present. It is not
possible to test all possible configurations. It is mandatory
that the user check with NovaTech product support before
proceeding with an Online Upgrade to make sure that a
particular configuration is certified.
Warning: Be aware that the OU utility covers the upgrade of the
standard D/3 software only and does not apply to FlexBatch,
SimSuite Pro, or any special software that may have been
created for a specific project. Before beginning an Online
Upgrade, consult with NovaTech product support to
determine how to precede with any project specific specials.
FlexBatch and SimSuite Pro software must be turned off
prior to an Online Upgrade. SNAP shots taken with
SimSuite Pro or the SNAP utility on one version of the D/3
are not supported on another D/3 version.
Warning: In an upgrade, the DCM upgrade may include a hardware
upgrade of the DCMs. Because the DCM ARP tables are not
updated, this could cause the CST to pass incorrect status
information. Care must be taken to follow the upgrade
procedure precisely in order when upgrading a DCM, or a
corrupted CST may make PCMs and DCMs appear to be in
load request when they are not.
UG1.0047.V12.3‐2A 93
Administratorʹs User Guide
The user should become familiar with the OU procedure by running the procedure in Demo mode
before proceeding with an actual online upgrade. The OU procedure can be run in demo mode on a
non‐D/3 system. To run Demo mode, check the Execute in Demo mode only check box on the
Options screen (the third screen of the Online Upgrade Setup Procedure).
Before proceeding with an online upgrade, ensure that all steps in the Pre Online Upgrade
Checklist on page 94 have been followed.
This chapter describes the steps needed to perform an online upgrade from the legacy version of
the D/3 system to version 12.3.
Pre Online Upgrade Checklist
Tasks essential to accomplishing a successful upgrade can be understood and tracked using the
following checklist. It lists the steps to follow, along with explanatory information for each step.
Preliminary Steps
1. Notify NovaTech Product Support
It is mandatory that the user check with NovaTech product support before proceeding
with an Online Upgrade to make sure that a particular configuration is certified.
2. Verify no running PCMs are offline from the network at time of upgrade
Online upgrades should not be done on any system showing one or more offline
PCMs unless those PCMs are known to be turned off. If a running legacy PCM is not
connected to the network and is reconnected after the CDCM is upgraded the CST
could be corrupted and incorrect statuses could appear.
3. Remove non‐D/3 nodes from the network and verify that the network is clear of any
non‐D/3 network messages.
D/3 nodes from other systems can create problems for the network. Abandoned D/3
nodes can contain IP address that attempt to communicate to existing nodes.
4. Create image backup of the CDCM
NovaTech recommends use of Symantec Live State Recovery or Norton Ghost for the
creation of the image backup.
Continuous Database (for each PCM and DCMʹs with a CDB)
5. Reload backup micro, force failover, confirm operations, repeat in the other
direction.
In order to verify the current state of the database and the PCM hardware, load the
backup micro, force a failover, and verify that all PCM operations are OK. Then load
the other micro, force a failover, and again verify that all PCM operations are OK.
6. Disconnect all field equipment from all EPNs that are off scan or faulted for
Modicon, Quantum, ASI, 505, and GPX I/O
Prior to the Online Upgrade Failover, all EPNs that are Off Scan or Faulted must be
disconnected from field equipment. When OUSNAP is loaded and run in the
Upgraded PCM, it synchronizes each of the databases from the legacy PCM (the
Continuous database, Sequence database, and I/O‐specific databases). Once these
UG1.0047.V12.3‐2A 94
Administratorʹs User Guide
databases are synchronized, OUSNAP must then update the hardware outputs for
Modicon, Quantum, ASI, 505, and GPX I/O types explicitly. This is because with these
I/O types, there is an intermediate card (MRIOC, MRCC, or 544) that buffers output
values and it is not kept in‐sync during an Online Upgrade. This update action
prevents a “bump” from occurring for outputs of these types during an Online
Upgrade Failover.
In order to perform this output update, the OUSNAP task loops though the blocks of
each output block type (Analog Out, Digital Out, Digital Group, and Digital Device) in
the Continuous database, and for EPNs in hardware families using an intermediate
card, the last known output value stored in the Continuous database, is sent to the
intermediate card. Analog Outputs and Digital Devices that are in Local/Maintenance
Mode are skipped during this process.
One of the consequences of this output update is that I/O points with EPNs that are
Off Scan, or Faulted (in the case of Digital Devices), may be changed from the value
that existed prior to the Online Upgrade Failover. If the inputs from the field have
changed while the EPN was Off Scan, or the Device was Faulted, the last known
output stored in the Continuous database will not be in‐sync with the values of the
points in the field. Therefore, it is highly recommended that prior to the Online
Upgrade Failover, all EPNs that are Off Scan or Faulted be disconnected from field
equipment.
7. Review MDL text files and correct for bad prompts
MDL text files must be reviewed for bad prompt responses. It is possible for MDL to
output values to an output text file that are not legal values for MDL to use as input
values. Databases that have these inconsistencies must be revised to have proper MDL
syntax.
8. Review MDL text files and correct for deleted cross references
MDL text files must be reviewed for cross references which were deleted and show up
as errors in the ʺlist allʺ, etc... If this is not correct it is undetectable until the old
software is uninstalled of the legacy CDCM has been replaced. It is possible for MDL
to output values to an output text file that are not legal values for MDL to use as input
values. There could be cross references which were deleted. Databases that have these
inconsistencies must be revised to have proper MDL syntax.
9. Use remote MDL to create text files to match PCM CDB in memory (Must have
correct IPN comments)
MDL text files must match PCM CDB memory: Use remote MDL to create text files
that match PCM CDB structure. Do not use another form of this file because the IPN
comments are critical. The MDL text files in D3Architect need to match the databases
in the PCMs. If WinMOD, MOD or other tools have been used to revise the database,
the user should create current MDL text files using the MDL output function. It is
important to use a MDL generated version of this file, because the IPN comments will
be used to preserve the order of the analog processing blocks when the database is
rebuilt on the upgraded CDCM. If building the continuous database on the upgraded
CDCM causes IPN build warnings the database will not be valid for OUSNAP to copy
UG1.0047.V12.3‐2A 95
Administratorʹs User Guide
the database to the upgraded PCM
10. Test MDL text files for proper syntax
Perform a test build of all MDL text files and then delete the UDB and REF files. It is
good procedure to perform a ‘test build’ on your continuous database text files. The
user should build all CDB files on the legacy system, not load them to the PCM to test
that the files are buildable. Problems may be fixed using remote WinMOD and then
new text files created again and retested. Also be aware that some MDL responses
may be legal in a legacy system which are no longer supported in an upgraded
system.
11. Delete unwanted MDL text files
The Online upgrade procedure converts all MDL legacy text files found in the
PCM/CDB folder. If ʹextraʹ MDL text files are stored here the user may to delete them
so that they will not all be converted during the online upgrade.
I/O Configuration (for each PCM)
12. Verify and correct GPXIO text files to match the compiled XIODB loaded to the
PCM
If the modified date on the GPXIO text file on the CDCM is after the time the XIODB
DB was last built or loaded, the contents of the GPXIO text file must be manually
checked for any edits that may have been performed since the last build and loading
to the PCM.
13. Verify and correct HAC table on CDCM to match PCM loaded HAC table
If the modified date on the HAC table file on the CDCM is after the time the HAC
table was last built or loaded, the contents of the HAC table must be manually
checked for any edits that may have been performed since the last build and loading
to the PCM. A report of the HAC table should be created and checked against the
actual hardware layout on the Quantum racks.
14. Verify and correct POD database on CDCM to match PCM loaded PLCdb
If the modified date on the POD file on the CDCM is after the time the PLC database
was last built or loaded, the contents of the POD file must be manually checked for
any edits that may have been performed since the last build and loading to the PCM.
A report of the PLC database should be created and checked against the actual
hardware layout in the PLC.
15. Verify and correct Ethernet database on CDCM to match PCM loaded Ethernet db
If the modified date on the Ethernet database files on the CDCM is after the time the
Ethernet database was last built or loaded, the contents of the EthConfig must be
manually checked for any edits that may have been performed since the last build and
loading to the PCM. A report of the Ethernet I/O database should be created and
checked against the actual hardware layout.
16. Verify and correct the MOST database on CDCM to match the database loaded to
the EBIM
If the modified date on the MOST database files on the CDCM is after the time the
EBIM was last loaded, the contents of the MOST database must be manually checked
or the EBIMs reloaded. The MOST controller database should be checked against the
UG1.0047.V12.3‐2A 96
Administratorʹs User Guide
actual hardware layout.
SABL and Sequence Databases (for each PCM)
17. The user must examine SNR, the modified dates on text files, and other reports to
confirm that the text files to build the UPFs, RPFs, RDFS, and sequence databases all
match the actual SEQDB loaded into the PCM. Any discrepancy of these text files
from the actual SEQDB in the PCM memory could result in a failure to build or failure
to failover in online upgrade mode. SABL source code SEQ files and include files must
match the code actually running in the PCM, because the Program Control Blocks will
be copied over when the legacy PCM is snapped by OUSNAP. Failure to do this could
cause SABL programs to start running on the wrong statement, access the wrong
variables, run on the wrong unit or cause other unpredictable results.
18. Add ʹunlistedʹ UPFs and RPFs which are inserted in UPFs and RPFs to D3Architect
Some users have UPFs and RPFs inserted into other UPFs and RPFs. These must be
listed in D3Architect in order for them to build on the upgraded CDCM. If the user
desired to keep them hidden (so that they are not accidentally edited), add them to the
list of UPFs and RPFs on the legacy CDCM, build them on the upgraded CDCM, and
after the Online Upgrade is complete remove them from D3Architect.
19. Verify and correct the RDF text files to match the RDFs loaded to PCM or on DCMsʹ
disk
Use SNR to verify that each RDF text file on the CDCM matches the RDF loaded to the
PCM, or on disk on the DCM.
20. Verify and correct the RPF text files to match the RPFs used to build the SEQDB
loaded into the PCM
Verify that each RPF text file on the CDCM matches the RPF used to build the actual
SEQDB loaded to the PCM. This must be inspected one item at a time.
21. Verify and correct the UPF text files to match the UPFs used to build the SEQDB
loaded into the PCM
Verify that each UPF text file on the CDCM matches the UPF used to build the actual
SEQDB loaded to the PCM. This must be inspected one item at a time.
22. Verify and correct the RPF include files to match the RPF include files used to build
the SABL code loaded into the PCM
Verify that each RPF include file with longer‐better‐names on the CDCM matches the
RPF include file used to build the actual SABL programs loaded to the PCM. This
must be inspected one item at a time.
23. Verify and correct the UPF include files to match the UPF include files used to
build the SABL code loaded into the PCM
Verify that each UPF include file with longer‐better‐names on the CDCM matches the
UPF include file used to build the actual SABL programs loaded to the PCM. This
must be inspected one item at a time.
24. Verify and correct the custom include files to match the custom include files used to
build the SABL code loaded into the PCM
Verify that the custom include files on the CDCM match the actual custom include
files that were used to compile each SABL program loaded to the PCM. This must be
UG1.0047.V12.3‐2A 97
Administratorʹs User Guide
inspected one item at a time.
25. Verify and correct the Sequence Database text files to match the SEQDB loaded to
the PCM
Verify that sequence database text file on the CDCM matches the SEQUENCE
database loaded to the PCM. If these do not match, return to a versioned copy of the
sequence database text file that does match. If a correct versioned file is not available,
an Online Upgrade should not be attempted. This could cause SABL programs to
start running on the wrong unit or access the wrong variables, or cause other
unpredictable results. This must be inspected one item at a time.
26. Verify and correct each SABL .SEQ file to match the SABL program loaded to the
PCM
Verify that each SABL .SEQ file on the CDCM matches the SABL programs loaded to
the PCM. If SABL programs have been revised, and the source code for the actual
SABL program running in the PCM is no longer available in a versioned file, an
Online Upgrade should not be attempted. This could cause SABL programs to start
running on the wrong statement or access the wrong variables or other unpredictable
results. No tools for this currently exist; must be inspected one item at a time.
27. Verify and correct each SABL .SPP file to match the SABL program loaded to the
PCM
Verify that each SABL .SPP file on the CDCM matches the SABL programs loaded to
the PCM. This must be inspected one item at a time.
28. Verify and correct each PCM settings file to contain all SABL programs and RDFs to
be loaded to the PCM
Verify that the D3Architect PCM settings files to load all possible SABL programs that
that are currently running on the PCM or may be called upon to run on the PCM.
29. Verify and correct that SABL programs that communicate across PCMs have
suitable failover routines
Verify that SABL programs that communicate to EPNs and variables in another PCM
have a suitable failover routine to handle the communications failure that will occur
on failover of the other PCM.
30. Test build all SABL programs to check for errors
Perform a test build of all SABL programs and then delete the LTQ files. The user
should build all SABL files on the legacy system to test that the files are buildable. Do
not load these to the PCM. Problems may be fixed and then new SABL programs
created again and retested.
Other Databases (for each PCM)
31. Verify the Alarm Suppression Database loaded to the PCM is same as on CDCM
Rebuild and reload the Alarm Suppression database to verify that the Alarm
Suppression Database matches the database loaded into the PCM. .
32. Verify Custom load PCMXXcustomload.bat file matches what is loaded to PCM
The OU procedure does not build or load any custom PCM tasks. Be sure to check the
PCM’s PCMXXcustomload.bat file as a check for non‐standard PCM tasks. Also use
D3Managerʹs PCM task list to look for non‐standard PCM tasks.
UG1.0047.V12.3‐2A 98
Administratorʹs User Guide
DCM Display Groups (for each DCM)
33. Verify and correct the following group text files match display groups loaded to
each DCM
There are two ways for the DCM group text files to not match the DCM groups loaded
into each DCMʹs memory: 1. The DCM Display groups (Plant Overview, EPN
faceplate, Current Trend Historical Trend, and Unit Variable Status) may have been
revised using Display Edit at any DCM and the SKID panel may have been revised
with General Function 3. To preserve these display groups, the user should move
these databases to the CDCM and create current GRP text files using the GRP output
function or the Input button on D3Architect. 2. The user could have edited the text
files but not built or loaded them. In this case, it would be best to rebuild all the group
databases, copy and load them to each DCM.
34. Plant Overview
Verify the Plant Overview text files match the display groups loaded into each DCM.
35. Current Trend
Verify the Current Trend text files match the display groups loaded into each DCM.
36. Historical Trend
Verify the Historical Trend text files match the display groups loaded into each DCM.
37. Faceplate
Verify the Faceplate Group (EPN) text files match the display groups loaded into each
DCM.
38. Unit Variable Status
Verify the Unit Variable Display files match the display groups loaded into each
DCM.
39. SKD Definitions
Verify the SKID text files match the annunicator panel buttons loaded into each DCM.
Annunicator Panel buttons for each console at a DCM may be revised using General
Function 3 at any DCM. To preserve these Annunicator Panel buttons for each
console, the user should move these databases to the CDCM and create current SKD
text files using the SKD output function or the Input button on D3Architect.
TotalVision® Graphics (for each DCM)
40. Verify and correct the VMC argfile to match the TV graphics on all DCMs
Verify the VMC argfile text files match the TV graphics loaded into each DCM.
TotalVision® Graphics will be built based on the parameters in the file
vmc_argfile.dat. It is the user’s responsibility to make sure that this file is up to date
with all TotalVision® graphic models and submodels. Perform a “ddscp show reg
dir” to a text file and compare this to the vmc_argfile.
41. Check for custom SGOs, GISMOs and submodels that reside in the SUBMODs
directory or custom directory
Check for custom SGOs, GISMOs and Submods. Only items that reside in the
SUBMODs directory are ensured of being included in the Online Upgrade
42. Rebuild the TV graphics using the VMC argfile
Check each TV graphic for correct information
UG1.0047.V12.3‐2A 99
Administratorʹs User Guide
43. Display each TV graphic on the DCM
This makes each .M2 file updated prior to disabling VMR Sync
44. Disable VMR Sync on all secondary TV registries to stop the primary registry from
loading all graphics to the secondary registries
TotalVision® Graphics on a DCM may be synced with the TotalVision® Registry on a
CDCM or other DCM. Shut down the VMRSYNC processes on the legacy DCMs.
Failure to do this could cause a legacy DCM to sync up with an Upgraded CDCM or
DCM and download new Total Vision Graphic components at an undesirable time.
Return these to the original configuration after the upgrade.
45. Modify DCM DDS server configurations
Revise each DCMʹs DDS server configuration to prevent a DCMʹs Total Vision
Graphics from accessing a mismatched D3_Online. Hardcode legacy OCMs to point
only to legacy DCMS for D3_ONLINE service. Return both of these to the original
configuration after the upgrade.
Legacy Graphics (for each DCM)
46. Build all legacy graphics and reload to all DCMs
This will correct for any legacy graphics that have been edited after the compiled
graphic was loaded to the DCM. This will also correct for any edits made to the string
table or symbol table that have been made after the compiled graphic was loaded to
the DCM.
Other DCM files (for each DCM)
47. Verify and correct DCMʹs custom start and stop programs are identical to
previously used.
The OU procedure does not build or load any custom DCM tasks. Be sure to check the
DCM’s custom task list in D3Architect and the custom start before D3 and start after
D3 files on each DCM for custom DCM tasks. Check D3Managerʹs DCM task list page
for some of the possible DCM tasks.
48. Perform a DCM load and a D/3 Restart
This will make the DCM load the D/3 environment variables to match the settings file.
This will also ensure that the console passwords are correct on post V10 systems.
Miscellaneous
49. Bring all batches to completion in preparation for shutting down FlexBatch
Because FlexBatch will be turned off during an online upgrade, all current batches
should be completed before starting an Online Upgrade.
50. Rebuild the collection list and reload it to the data historians/collectors
Rebuild the collection list and reload it to the data historians/collectors to ensure the
CLB.txt file in D3Architect has the same data as loaded to the TrendR data
historians/collectors.
51. Verify the offline Dynamic Alarm Database is the same as loaded to CDCM and
Backup DCM
Recompile and reload the DAM database to the CDCM and backup DCM.
52. Optional ‐ Copy D3App, D3Bin\Customer and HOST files to new CDCM hardware if
so desired
UG1.0047.V12.3‐2A 100
Administratorʹs User Guide
The OU procedure supports a manual copy of the D3App folder and the HOST files to
a folder on a hardware upgrade of a CDCM as an option. This saves time copying this
information across the network.
53. Optional ‐ Create backup of D3App and purge file versions if so desired
If the D3App folder is going to be copied to a new PC across the network, it may be
desirable to delete any unwanted backup versions of files before proceeding with the
Online Upgrade in order to reduce copy time. It is recommended to make a backup
copy first. All of D3App will be copied to the target CDCM and archived. The user
may want to make copies of TrendR and Historical Trend data and D/3 log files to
another location instead of reproducing them on the target CDCM.
54. Rebuild Report Writer Reports
To ensure that Report Writer reports are up to date rebuild all Report Writer Reports.
The Online Upgrade copies Report Writer Reports. The reports can be rebuilt and
restarted after the Online Upgrade is complete.
55. Prepare a list of scheduled summary reports. These can be rescheduled after the
Online Upgrade is complete.
The Online Upgrade copies the summary reports. Summary reports can be
rescheduled after the Online Upgrade is complete.
56. Choose up to 200 CPWM User IDs and passwords if upgrading from V10.2
Pre V11 Passwords will be disabled. These passwords are now password classes.
Without accounts in CPWM, operators will have no means to unlock protected
console fields.
57. Use System Status to check each D/3 node
All nodes need to have both links running. All PCMs need to have the Rlink running
and all tasks in sync. All PCM I/O subsystems need to be running correctly in both the
selected and nonselected micro. Correct all hardware problems.
58. Restart the CDCM
This will load all the DCM settings and system settings to ensure that they match the
environment variables. It also reloads all Console passwords. Inspect the settings and
passwords to verify that they are correct.
Preparing the Legacy System
Basic Concepts
Before beginning an Online Upgrade, it is critical that the legacy system be prepared for the
procedure. The OU procedure copies all of the D/3 application text files from the legacy CDCM to
the CDCM to be upgraded. These text files are then converted to the most recent version using the
various D/3 upgrade utilities. D3Architect is then used to build the new databases under the new
version. This means that all of the present D/3 text files displayed in D3Architect must match the
actual databases and programs running in each PCM and DCM. If this is not the current condition
UG1.0047.V12.3‐2A 101
Administratorʹs User Guide
of the legacy CDCM, preparing the legacy system may be the most time consuming step of the OU
process.
When a legacy PCM is failed over to an upgraded PCM, the OUSNAP task is run in the upgraded
PCM. This task creates a snapshot of all the databases in the legacy PCM and moves all the values
over to the upgraded PCM in the proper locations. The upgraded PCM is loaded with databases
and programs configured the way it is designed in D3Architect, so these must match the actual
structure in the legacy PCM. If the upgraded PCMʹs databases or programs differ in any way from
those in the legacy PCM, unintended results can be expected.
Generally, the user should be able to perform a Build All from D3Architect on the legacy CDCM
and know that the databases produced are the same as those currently loaded to each PCM and
DCM. This may not be the case if analog processing blocks have ever been deleted from the
continuous database. When an analog processing block (such as a PID) is deleted from the
database, it creates a ʹholeʹ or unused block. When a MODEL text file is used as an input to the
database, all available ʹholesʹ are filled in as the processing blocks default to the lowest available
IPN. While the continuous database created from the text file is functionally the same as the
original database, the blocks are not in the same order, thus preventing the OUSNAP task in the
PCM from being able to capture values from the legacy PCM and copy them to this new
reorganized structure. Also, references to these blocks from SABL programs, PVN graphics, and
other layered products may be incorrect. To correct this mismatch, the Online Upgrade procedure
takes advantage of a new feature of MDL, introduced in V12.2, which allows the user to rebuild
from the legacy text files retaining the original block order. The MDL ‐C switch allows MDL to read
the comments containing the IPNs of the analog processing blocks from the MDL input text file.
MDL then places these processing blocks in the same location in the upgraded PCM. This allows
OUSNAP to copy the values from the legacy PCM to the upgraded PCM correctly and for SABL
programs to continue to make the correct reference.
Warning: Making any revisions to the system configuration or
process applications during an online upgrade
invalidates the online upgrade. This means that the
user should not run MDL, WinMOD or otherwise
change the continuous or sequence database once the
database text files have been created.
Some guidelines on making the D3Architect text files compatible are given in the following topics.
Continuous Database
The MDL text files in D3Architect need to match the databases in the PCMs. If WinMOD, MOD or
other tools have been used to revise the database, the user should create current MDL text files
using the MDL output function. It is important to use a MDL generated version of this file, because
the IPN comments will be used to preserve the order of the analog processing blocks when the
database is rebuilt on the upgraded CDCM. If building the continuous database on the upgraded
UG1.0047.V12.3‐2A 102
Administratorʹs User Guide
CDCM causes IPN build warnings, the database will not be valid for OUSNAP to copy the database
to the upgraded PCM.
The user should verify that I/O configuration files such as the HAC table, PLC databases and
Ethernet I/O databases match the I/O defined in the continuous database.
Warning: It is possible for MDL to output values to an output text file
that are not legal values for MDL to use as input values. (For
example, digital devices may have constants in their input
fields that were not legal MDL inputs in prior versions of
MDL.) There could also be cross references which were
deleted. Databases that have these inconsistencies must be
revised to have proper MDL syntax. It is good procedure to
perform a ‘test build’ on your continuous database text files.
It is also possible for MDL to output values on a legacy
system to an output text file that are not legal values for
MDL to use as input values on an upgraded system. A test
of the MDL output file on an upgraded system is
recommended and part of the NovaTech system specific
testing for an OU.
Additional Modicon, Quantum, ASi, 505 and GPX I/O Issues
When OUSNAP is loaded and run in the Upgraded PCM, it synchronizes each of the databases
from the legacy PCM (the Continuous database, Sequence database, and I/O‐specific databases).
Once these databases are synchronized, OUSNAP must then update the hardware outputs for
Modicon, Quantum, ASI, 505, and GPX I/O types explicitly. This is because with these I/O types,
there is an intermediate card (MRIOC, MRCC, or 544) that buffers output values and it is not kept
in‐sync during an Online Upgrade. This update action prevents a “bump” from occurring for
outputs of these types during an Online Upgrade Failover.
In order to perform this output update, the OUSNAP task loops though the blocks of each output
block type (Analog Out, Digital Out, Digital Group, and Digital Device) in the Continuous
database, and for EPNs in hardware families using an intermediate card, the last known output
value stored in the Continuous database, is sent to the intermediate card. Analog Outputs and
Digital Devices that are in Local/Maintenance Mode are skipped during this process.
Warning: One of the consequences of this output update is that I/O
points with EPNs that are Off Scan, or Faulted (in the case of
Digital Devices), may be changed from the value that existed
prior to the Online Upgrade Failover. If the inputs from the
field have changed while the EPN was Off Scan, or the
Device was Faulted, the last known output stored in the
Continuous database will not be in‐sync with the values of
the points in the field. Therefore, prior to the Online
UG1.0047.V12.3‐2A 103
Administratorʹs User Guide
Upgrade Failover, all EPNs that are Off Scan or Faulted must
be disconnected from field equipment.
SABL Programs
SABL programs may be loaded to the PCM and run without using D3Architect. Update the
D3Architect PCM settings files to load all possible SABL programs that may be run.
RDFs may be loaded to the PCM without using D3Architect. Update the D3Architect PCM settings
files to load all possible RDFs.
Warning: SABL programs that communicate to EPNs and variables in
another PCM will experience a communications failure
when that PCM is frozen, snapped and failed over. These
SABL programs must have a suitable failover routine to
recover from this communications failure. If the programs
do not have a suitable failover routine, this should be
corrected prior to performing an online upgrade. If SABL
programs have been revised, and the source code for the
actual SABL program running in the PCM is no longer
available, an Online Upgrade should not be attempted.
Warning: It is essential that the Application Engineer examine SNR
and other reports to confirm that the text files to build the
UPFs, RPFs, RDFS, UPF include files, RPF include files and
sequence databases all match the actual SEQDB loaded into
the PCM. Any discrepancy of these text files from the actual
SEQDB in the PCM memory could result in a failure to build
or failure to failover in upgrade mode. SABL source code
SEQ files and include files must match the code actually
running in the PCM, because the Program Control Blocks
will be copied over when the legacy PCM is snapped.
Failure to do this could cause SABL programs to start
running on the wrong statement or run on the wrong
process unit.
Other PCM Databases
Other databases, for example, the Alarm Suppression Database—may be loaded with ASL. Update
the D3Architect PCM settings files to load all possible PCM databases that may be used.
UG1.0047.V12.3‐2A 104
Administratorʹs User Guide
Custom PCM Tasks
The OU procedure does not build or load any custom PCM tasks. Be sure to check the PCM’s
PCMXXcustomload.bat file.
DCM Display Groups
DCM Display groups (Plant Overview, EPN faceplate, Current Trend Historical Trend, and Unit
Variable Status) may be revised using Display Edit at any DCM. To preserve these display groups,
the user should move these databases to the CDCM and create current GRP text files using the GRP
output function or the Input button on D3Architect.
Annunciator Panel Buttons
Annunciator Panel buttons for each console at a DCM may be revised using General Function 3 at
any DCM. To preserve these Annunciator Panel buttons for each console, the user should move
these databases to the CDCM and create current SKD text files using the SKD output function or
the Input button on D3Architect.
TotalVision® Graphics
TotalVision® Graphics will be built based on the parameters in the file vmc_argfile.dat. It is the
user’s responsibility to make sure that this file is up to date with TotalVision graphic models and
submodels. The user may want to perform a “ddscp show reg dir” to a text file and compare this to
the vmc_argfile.
TotalVision® Graphics on a DCM may be synced with the TotalVision® Registry on a CDCM or
other DCM. The user may want to consider shutting down the VMRSYNC processes on the legacy
DCMs. Failure to do this could cause a legacy DCM to sync up with an Upgraded CDCM or DCM
and download new Total Vision Graphic components at an undesirable time. Furthermore, the
user may want to hardcode legacy OCMs to point only to legacy DCMS for D3_ONLINE service.
FlexBatch™
FlexBatch™ should be turned off during an online upgrade.
SimSuite Pro
SimSuite Pro should be turned off during an online upgrade.
Custom DCM Tasks
The OU procedure does not build or load any custom DCM tasks. Be sure to check the DCM’s
custom task list in D3Architect and the custom start before D3 and start after D3 files on each DCM.
UG1.0047.V12.3‐2A 105
Administratorʹs User Guide
Deleting Unwanted Files
All of D3App will be copied to the target CDCM and archived. It may be desirable to make a copy
of D3App with the versioned files and then delete any unwanted backup versions of files before
proceeding with the Online Upgrade. The user may want to move copies of TrendR and Historical
Trend data and D/3 log files to another location instead of reproducing them on the target CDCM.
The Online Upgrade procedure provides the user with an option of moving the D3App and settings
files to a folder on the target CDCM prior to running the procedure and then providing the
procedure with a path to this folder. This can reduce the amount of time that the legacy CDCM is
offline.
All of D3App will be copied and archived to the target DCM on a DCM upgrade. The same process
of deleting unwanted files must be done on each DCM.
Warning: The D/3 system has over a thousand software and hardware
configurations from V10.2 to the present. It is not possible to
test all possible configurations. It is mandatory that the user
check with NovaTech product support before proceeding
with an Online Upgrade to make sure that a particular
configuration is certified.
Pre Installation Guidelines
The following topics cover important information necessary for a successful online upgrade.
Administrator Privileges
The user running the Online Upgrade procedure on an existing D/3 CDCM or DCM must be a D/3
administrator, and must also have administrator privileges.
The user running the Online Upgrade procedure on a new PC without the D/3 installed must have
administrator privileges.
Disk Image of CDCM
NovaTech recommends using backup and recovery software to create a disk image of the CDCM
before proceeding with the Online Upgrade. This disk image should be stored on external media of
sufficient capacity, such as a network drive or external disk drive, for easier recovery in the event of
a system failure. DCMs with critical alarm or trend data should also be backed up.
UG1.0047.V12.3‐2A 106
Administratorʹs User Guide
System Requirements
Operating System:
The CDCM running the OU software must run Windows 2000 or greater, unless running in demo
mode.
For CDCMs running a version of Windows older than Windows 2003, an option is provided during
setup to upgrade the operating system as well as D/3 software. This option requires the installer to
have the correct Microsoft Windows media and licenses.
Hardware Requirements:
The Hardware Requirements are the same as listed in the Installation and Setup chapter of this
manual.
Upgrading PCM Sboot PROMs
If upgrading from D/3 version 10.2, the Sboot PROMs on the PCMs need to be replaced.
If upgrading from D/3 version 11, Sboot PROM replacement may or may not be necessary,
depending upon the I/O used.
A listing of Sboot PROMs, and the D/3 versions and PCMs they apply to can be found in the
Hardware ROM Revision Table in the Installation and Setup chapter of this manual..
Upgrading PCM I/O PROMs
If upgrading from D/3 version 10.2, the MRIOC and MRCC PROMs on the PCMs I/O cards need to
be replaced.
If upgrading from D/3 version 11 or 12, the MRIOC, MRCC, FPGA, PLX and SSB PROMs on the
PCMs I/O cards need to be replaced.
In addition, if upgrading from V12.1, the OS chip on the EthernetMPC card must be flashed to have
the current version of the Operating System. This procedure needs to be done by NovaTech and
requires having replacement EthernetMPC cards available before beginning the upgrade.
Licenses
During the Online Upgrade procedure, version 12.3 licenses will be copied from a specified drive or
file location. Know the drive or network location of Version 12.3 licenses before starting the
upgrade.
Demo Mode
NovaTech highly recommends that you first run the upgrade in Demo mode to become familiar
with the Online Upgrade procedure.
UG1.0047.V12.3‐2A 107
Administratorʹs User Guide
Demo mode can be run on a non‐D/3 system. When Demo mode is exited by clicking Finish, all
software installed to execute the demo is removed.
Networking Issues
When replacing a CDCM, the Online Upgrade Procedure directs the user to set the new machine’s
network properties, such as its TCP/IP address, machine name, and host file from the previous
system.
It is important that the two machines do not exist on the network with the same address. TCP/IP
address and subnet masks on target PCs must be carefully chosen so that proper communications
with the legacy PC and other DCMs and PCMs can be established.
If it is necessary to back out of the online upgrade, disconnect the upgraded CDCM before
reconnecting the legacy machine.
Use the DCM upgrade procedure to make sure upgraded DCMs are marked as Upgraded in
D3Manager prior to being connected to the system.
System Functionality During an Online Upgrade
During the Online Upgrade, the legacy DCM has full control of legacy PCMs.
The following limitations will be noted:
• the PVN Single Loop display on the CDCM during the Online Upgrade will display data
from the legacy PCMs, however, other PVN displays to the legacy PCMs may have incorrect
data;
• the PVN displays on the legacy DCMs during the Online Upgrade will display data from
the legacy PCMs; however, PVN displays from legacy DCMs to upgraded PCMs may have
incorrect data;
• TotalVision® is not fully functional while running in mixed mode.
• D3_Online calls from an upgraded DCM to a legacy PCM may yield incorrect data.
FlexBatch™
If NovaTech’s FlexBatch™ application is used, it must be shut down before running an online
upgrade.
SimSuite Pro®
If GSE’s SimSuite Pro® application is used, it must be shut down before running an online upgrade.
UG1.0047.V12.3‐2A 108
Administratorʹs User Guide
Suspending an Online Upgrade
The Online Upgrade can be suspended by clicking Cancel at any time before the PCMs are
upgraded. In most cases this brings up a dialog that offers the following choices to the user:
Cancel Options—Before PCM Upgrades
When the Online Upgrade procedure is again executed, either explicitly by the user or
automatically following a system reboot, the procedure begins execution again at the point at which
it was previously suspended.
This above set of choices is expanded if the user has started but not yet completed PCM upgrades.
In that case, the following expanded selection of choices is offered to the user:
Cancel Options—After PCM Upgrades Started
Note: If both sides of a PCM upgrade have been completed, it is not
possible to back out of the Online Upgrade.
UG1.0047.V12.3‐2A 109
Administratorʹs User Guide
Activating the Online Upgrade Procedure
Use the D/3 Installation Selector (see the chapter on D/3 installation) to choose Online Upgrades.
The following is then displayed:
®
Begin D/3 Installation
If executing on a DCM, the message displays as executing on a DCM. The procedure for a DCM is
similar for a CDCM. On a DCM instead of converting applications databases, the user is instructed
to download the databases using D3Manager from the CDCM.
Choose Activate to activate the Online Upgrade Procedure. This procedure both installs “helper”
software specific to the upgrade process, and places values in the NT registry to keep track of the
state and location of the Online Upgrade Procedure. This software and set of registry values are
deleted from the system when the upgrade is completed.
Once the Online Upgrade Procedure has advanced to the point that its software has been installed,
a desktop shortcut and Start menu items are created. If it is necessary to restart the Online Upgrade
Procedure, either the shortcut or Start menu item may be used.
OLU Install Procedure States Diagram
The following chart shows the basic flow of the OU procedure.
UG1.0047.V12.3‐2A 110
Administratorʹs User Guide
OU Install Procedure States
UG1.0047.V12.3‐2A 111
Administratorʹs User Guide
Backing Out of an Online Upgrade
Opportunities to back out of the upgrade are provided at several points during the Online
Upgrade. The back out will return the system to the legacy applications.
In the OU Install Procedure States Diagram, the arrows pointing to the Backout block indicate the
points in the OU procedure where backout can be initiated.
In addition, the user can use the button on most screens of the procedure, or use the
button on the upper right corner of the OU window at any time to back out of an Online
Upgrade.
If a backout has been initiated, click Next in the Starting Online Upgrade Procedure Backout
screen, and follow the screen instructions.
It is not possible to back out of an upgrade once both sides of a PCM pair have been converted
over to upgraded software.
Backing Out of an Online Upgrade
UG1.0047.V12.3‐2A 112
Administratorʹs User Guide
Backout Progress
Starting the Online Upgrade
Note: Before proceeding, ensure that all steps in the Pre Online
Upgrade Checklist on page 94 have been followed.
UG1.0047.V12.3‐2A 113
Administratorʹs User Guide
Welcome Screen
Care should be taken to read all screens of the Online Upgrade procedure. Follow the instructions
closely. The procedure will often tell the user to perform a task using a D/3 or Windows utility. Do
not go on until the task is completed, because it is not possible to back up a screen. However, there
are a few places where the user can back out of the online upgrade prior to actual PCM failover.
Welcome
Setup Instructions
This screen reminds you to read all screens carefully to ensure that you understand what is
requested before proceeding. Remember, it is not possible to back up a screen.
Use the Help button for additional details on the purpose of the screen, and any requested actions.
UG1.0047.V12.3‐2A 114
Administratorʹs User Guide
Online Upgrade Setup
Setup Actions
This screen introduces the OLU setup process. You will need to know:
1. The location on your system or network where you want to store the Online Upgrade
software component.
2. That all necessary conditions are in place for a successful Online Upgrade.
Setup Actions
UG1.0047.V12.3‐2A 115
Administratorʹs User Guide
Selecting OLU Options
The user can choose any or all of the options shown in this screen. NovaTech recommends running
the OU procedure once in Demo Mode prior to performing an actual Online Upgrade. Expert
Mode allows qualified NovaTech personnel to navigate through a partial upgrade or skip steps.
The Generate Log File option is recommended in case the progress of the procedure needs to be
reviewed at any point.
The Generate Verbose (debug) messages generate detailed messages concerning the internal
workings of the Online Upgrade Procedure in a debug message window. This slows down the
procedure. If turned on, the debug window can be closed at any time but not reopened.
Require confirmation before advancing to the next step can help ensure that the appropriate
actions have been done at each screen before proceeding.
Online Upgrade Options
In the next screen, you must confirm that you have reviewed and followed the steps in the checklist
portion of the D/3® Online Upgrade Site Preparation Guide. View the checklist by clicking the
button.
UG1.0047.V12.3‐2A 116
Administratorʹs User Guide
Confirm review of checklist
Upgrading a CDCM vs. Replacing a CDCM
At this stage in the Online Upgrade procedure, in addition to upgrading the CDCM’s D/3®
software, you can choose to upgrade its operating system. You can also choose to replace the
CDCM with upgraded hardware and software.
You will also be asked if the applications and settings to be used by the CDCM are to be copied
from the legacy CDCM by the Online Upgrade procedure, or if they have already been copied to a
local folder.
CDCM Upgrade Options
At this step of the Online Upgrade procedure, the user can choose among the following:
upgrade the CDCM’s D/3 software on this PC, leaving the D/3 Applications in place;
upgrade the CDCM’s D/3 software plus its operating system (such as upgrading from
Windows 2000) on this PC and leaving the D/3 Applications in place;
replace the CDCM with upgraded hardware and D/3 software. If you choose this option,
the Online Upgrade procedure must be executing on the new hardware platform.
UG1.0047.V12.3‐2A 117
Administratorʹs User Guide
CDCM Upgrade Options
Copy Options for Legacy Applications and Settings
This screen appears only if you are replacing the CDCM or DCM with a new PC.
The Online Upgrade procedure needs to obtain the legacy PC’s applications and settings files from
D3App, D3Bin\Customer, and \system32\drivers\etc\hosts.
The procedure will copy them from their existing locations on the legacy PC if the first radio button
is selected.
If the second radio button is used, you will be asked for the location of those files in a later screen.
The files must be in a locally accessible folder.
UG1.0047.V12.3‐2A 118
Administratorʹs User Guide
Selecting a Copy Option
Installation Overview
Pre‐installation procedures to establish operating system settings for CDCMs, DCMs, and Data
Historians must be followed before running an online upgrade. These procedures are found in the
topic DCM, CDCM and Data Historian Operating System Settings, found in the Installation and
Setup chapter of this Administrator’s User Guide.
CDCM Installation
A series of screens guides the user through the installation of the upgrade on the CDCM. Screens
for the sample upgrade continue in the next section.
DCM and OCM Installation
The Online Upgrade procedure provides opportunities at several different points, including early
in the procedure and towards the end, to install the upgrade on the DCMs. At any point after the
first opportunity is offered to upgrade a DCM, the installation CD can be removed and used to
upgrade the target DCM.
As long as legacy PCMs remain on the system, legacy DCMs and OCMs should remain available to
view their data.
Material Prerequisites to an Online Upgrade
In order to determine the prerequisites to performing an upgrade, the user first needs to provide
the Online Upgrade procedure with the current location of the D/3 system and operating system.
UG1.0047.V12.3‐2A 119
Administratorʹs User Guide
Locating the D/3 DCS Application Folder
In order to navigate to the CDCM or DCM’s D3 DCS folder on the legacy system, the target system
must be configured on both D/3 networks with compatible TCP/IP addresses and subnet masks.
Access Network Settings File
Locating the CDCM Windows Folder
In order to navigate to the CDCM’s or DCM‘s Windows folder on the legacy system, the target
system must be configured on both D/3 networks with compatible TCP/IP addresses and subnet
masks.
These folders are then checked for the prerequisites for performing an upgrade.
UG1.0047.V12.3‐2A 120
Administratorʹs User Guide
Verifying System Prerequisites
The following is a list material of prerequisites for an online upgrade.
Account Privileges
The Online Upgrade procedure verifies that the user has the correct privileges to run the procedure.
Supported D/3 Versions
The Online Upgrade procedure supports D/3 versions 10.2 through the previous release.
Disk Space Requirements
Ensure at least 600 MB of disk space is available on the CDCM for installation, upgrading, and
archiving legacy components.
Verifying System Prerequisites—Before Start
UG1.0047.V12.3‐2A 121
Administratorʹs User Guide
Verifying System Prerequisites—After Start
D/3 Licensing
Know the drive or network location of Version 12.3 licenses before starting the upgrade.
Installation Media
This is the CD used to install the upgrade.
Recovery Media
In order to recover from an unsuccessful upgrade or a system failure, ensure that recovery media of
sufficient capacity is available to hold an image of the CDCM or DCM before the upgrade.
UG1.0047.V12.3‐2A 122
Administratorʹs User Guide
The procedure will not allow the user to proceed without checking the required items.
Operational Prerequisites to an Online Upgrade
A set of operational conditions must be met in order to run an online upgrade:
• there is at least one operational DCM;
• RLINK communications are healthy on all PCMs;
• all subsystems on all PCMs are currently in sync;
• virus protection programs have been disabled (recommended);
• file‐based (local) MODEL and SABL databases match the loaded (remote) PCM.
CDCM—Additional Prerequisites
This screen lists additional prerequisites that must be met to continue with the online upgrade.
Check the boxes the confirm that they have been met, and press Next to continue.
Upgrading a CDCM—Additional Prerequisites
UG1.0047.V12.3‐2A 123
Administratorʹs User Guide
Verify Operational Prerequisites
Verify Operational Pre‐Requisites
Checking each box means that you agree that you have verified this item.
All of the conditions in the section on Preparing the Legacy System must be met before checking
the last box. If this is not correct, correct these conditions now or choose cancel and back out of the
Online Upgrade procedure.
When upgrading a CDCM, the following screen will appear, showing additional prerequisites that
must be met.
DCM Verification
The CDCM does not have full control during an online upgrade; it will not be able to perform all of
its functions. Verify that all control functions are available on the legacy DCMs.
PCM Verification
Use the System Status display to verify that RLINK communications are healthy and that PCM
subsystem tasks are synchronized.
On the left side of the screen, select each PCM, and check its status on the right side of the screen.
CARD R ONLINE indicates that the redundant PCM is online. Under SYNC STATUS, IN SYNC for the
listed statuses indicates that the PCMʹs tasks are synchronized with the redundant microprocessor.
UG1.0047.V12.3‐2A 124
Administratorʹs User Guide
Verify that all of the PCMʹs I/O subsystems are healthy on the redundant microprocessor.
Operating System Upgrade
If you chose Upgrading CDCM D/3 software and operating system in the CDCM Upgrade
Options screen, you will see the following confirmation dialog:
Confirm operating system has been upgraded
If the response is Yes, the Archive Folder Location screen shown in the topic Archiving Legacy
Files on page 126 will appear.
If the response is No, The Upgrade Operating System screen appears, and you will have to exit this
procedure.
After the operating system has been upgraded, be sure to run the Online Upgrade procedure
choosing Upgrading CDCM D/3 software and operating system in the CDCM Upgrade Options
screen.
Upgrade Operating System
UG1.0047.V12.3‐2A 125
Administratorʹs User Guide
Archiving Legacy Files
Legacy database files are copied from the legacy CDCM to a user specified location.
In the screen that follows, a directory must be specified for legacy application files to be used by the
D/3 installation procedure to ensure that all of these files are updated for all upgrades.
The destination folder can be anywhere, but the same location must be specified whenever this
question is asked by the D/3 installation procedure.
Archiving Legacy Files
Additional utilities and applications are installed in the location specified in Archiving Legacy
Files—Location of additional files and utilities.
Archiving Legacy Files—Location of additional files and utilities
This screen requests specification of a folder to be used for the installation of applications and
utilities used by the Online Upgrades procedure.
A default location is supplied, or a new path can be browsed for or typed in.
UG1.0047.V12.3‐2A 126
Administratorʹs User Guide
Shortcut Folder Location
The following screen requests that the user specify a path for the location of the shortcuts.
Shortcut folder location
The shortcut can be used to restart the Online Upgrade in the event of an unexpected system
shutdown during an Online Upgrade.
UG1.0047.V12.3‐2A 127
Administratorʹs User Guide
Location of OU Components
This screen informs the user of the installation location.
Path to Online Upgrade components
Acquiring the Legacy Application Files
These files are acquired when their storage location is specified in the following screen.
If the folder containing the legacy files is on another PC it must be shared before the files can be
copied.
Be sure to delete any unwanted D3App files before copying them. Copying many files across a
network may require an extended time. See the section on deleting unwanted files in the system
preparation section.
UG1.0047.V12.3‐2A 128
Administratorʹs User Guide
Locating the Legacy D/3 DCS folder
Next provide a path to the Windows OS on the legacy system. Be sure to share the folder.
Locating the Windows folder
Locating the Windows folder
Archiving the Legacy Application Files
A checklist review is provided for archiving legacy files.
UG1.0047.V12.3‐2A 129
Administratorʹs User Guide
Legacy Application files found in D3APP are copied to the upgraded CDCM using the path
provided.
These files are also copied to the new location for D3App. (This is not done for upgrades done on
the same CDCM or DCM.) This location for D3App must correspond to the path that is later
provided to D3Install for the same question.
Archiving Legacy Databases
Before application files can be transferred from the legacy CDCM to the new platform, the user
must perform the actions listed in this verification screen.
The verification screen will vary depending upon the type of upgrade:
• Upgrading a CDCM (software only)
• Upgrading a CDCM with new D/3 software and hardware
• Upgrading a DCM.
The links above will take you to the portion of this topic containing the screens for each type of
upgrade. The steps listed below apply to upgrading a CDCM with new D/3 software.
1. Check that D3VmrSync is stopped on all legacy DCMs. This prevents the legacy DCMs
from getting upgraded SGOs from an upgraded TotalVision registry.
2. Ensure that D/3® has been shut down on the CDCM or DCM.
3. No FlexBatch™ or SimSuite Pro servers are active.
4. Ensure that no SQLServer‐based application with D/3® database access is active.
5. No user or third‐party applications with D/3 database access are active.
UG1.0047.V12.3‐2A 130
Administratorʹs User Guide
Verification Steps
If replacing CDCM with upgraded hardware and D/3 software:
®
Verification Steps—When Replacing CDCM with Upgraded Hardware and D/3 Software
UG1.0047.V12.3‐2A 131
Administratorʹs User Guide
When upgrading a legacy DCM:
Verification Steps—Upgrading a Legacy DCM
Additional Verification Actions
Check for the following:
1. No D3 services can be active on the legacy CDCM or DCM.
2. The D3Mon system tray application must not be running.
3. FlexBatch™ or SimSuite Pro™ servers cannot be active.
4. No applications with database access can be active on the legacy CDCM or DCM.
File archiving activity is summarized in the Archive Activity Summary screen.
UG1.0047.V12.3‐2A 132
Administratorʹs User Guide
Additional Verification Steps
Archive Activity Summary—Before Start
UG1.0047.V12.3‐2A 133
Administratorʹs User Guide
Archive Activity Summary—After Start
Pre‐Installation of Legacy Files
Legacy application files must be pre‐installed into their final locations as part of the Online
Upgrade Procedure. In the field provided, indicate the location for these files. This same location
must be specified later when requested by the D/3 Installation Procedure.
Install Legacy Application Files
UG1.0047.V12.3‐2A 134
Administratorʹs User Guide
Legacy Application Installation Summary—Before Start
Legacy Application Installation Summary—After Start
Disconnect This CDCM
Before automated uninstallation of the previous version can take place, the legacy CDCM must be
disconnected from the D/3 network. To do this, unplug the Ethernet cables from the CDCM’s
Ethernet ports. Similar action would be taken at this stage on upgrading a DCM.
UG1.0047.V12.3‐2A 135
Administratorʹs User Guide
Disconnect Upgraded CDCM
Automated D/3® Uninstallation
Automated uninstallation of the previous D/3 version will take place on a PC that already has the
D/3 installed.
®
D/3 Uninstallation Preparation
UG1.0047.V12.3‐2A 136
Administratorʹs User Guide
®
Activating the D/3 Uninstallation Procedure
On upgrades where the hardware platform is not being replaced, InstallShield is then used to
uninstall the legacy software, including software updates.
Uninstallation Preparation
Click OK to Uninstall D/3 Software
After the uninstall, the PC is rebooted to clear the NT registry. Then installation of the latest
version begins.
UG1.0047.V12.3‐2A 137
Administratorʹs User Guide
Uninstallation begins
Uninstallation progress can be monitored in the D/3 Uninstallation Activity Progress screen.
Uninstallation progress
UG1.0047.V12.3‐2A 138
Administratorʹs User Guide
Resuming the Online Upgrade Procedure
The Resuming Online Upgrade Procedure screen displays after the previous D/3 version was
uninstalled.
Click Next to continue with the upgrade, or click Cancel if it is necessary to back out of the
upgrade. More information can be found in the topic Backing Out of an Online Upgrade on page
112..
Resuming Online Upgrade Procedure (after successful uninstall of previous version)
The following screen may appear if D/3 items are still found in the registry. NovaTech recommends
clearing registry keys after a successful uninstallation.
Clearing Registry information
UG1.0047.V12.3‐2A 139
Administratorʹs User Guide
Activating the D/3® 12.3 Installation Procedure
The first screen in this part of the procedure requests the location of D3Install.exe. This is normally
found in the D3 folder of the D/3 CD, but may reside in a network location or a file location on the
PC.
Locate D/3 Installation Setup File
UG1.0047.V12.3‐2A 140
Administratorʹs User Guide
The second screen initiates installation of D/3 Version 12.3. The Online Upgrade procedure
continues to run in the background. Follow the installation instructions in the chapter of D/3
Installation of this manual. Be sure to choose the Finish button at the end of the D/3 Installation
instead of Reboot to allow the OU procedure to perform the reboot.
D/3® Installation Preparation Instructions
The Instructions screen informs the user that a separate installation procedure will be executed.
After reading the instructions, click Next to proceed.
UG1.0047.V12.3‐2A 141
Administratorʹs User Guide
D/3 Installation Preparation in Progress—Before Start
D/3 Installation Preparation in Progress—After Start
Click the Finish button to allow the OU procedure to reboot the machine.
UG1.0047.V12.3‐2A 142
Administratorʹs User Guide
Information: Installation Complete
After rebooting the system following the conclusion of the D/3 Version 12.3 installation, the Online
Upgrade procedure resumes. If it does not resume on its own, use the shortcut icon to restart it.
Resuming Online Upgrade Procedure
The Resuming Online Upgrade Procedure screen appears under the following circumstances:
• after uninstallation of legacy D/3 software;
• after installation of upgraded D/3 software;
• when the procedure is resumed after a reboot for any reason.
Two screens are shown below.
The Show Log… button can be used to view the software installation log.
Wait until any command windows are done executing before clicking Next.
Resuming Online Upgrade (after uninstalling legacy D/3 software)
UG1.0047.V12.3‐2A 143
Administratorʹs User Guide
Resuming Online Upgrade (after installation of upgraded D/3 software)
Apply D/3® Software Updates
Apply any D/3 Software Updates now using the update procedure in this manual and the
instructions on the ReadMe file for the kit.
®
Apply D/3 Software Updates
UG1.0047.V12.3‐2A 144
Administratorʹs User Guide
License Installation
D/3® Version 12.3 licenses are copied from the drive and/or folder listed in the following screen.
To choose a different location, type in a new path, or click Change… to browse for an existing
folder.
License Installation
Install License Dongle
This screen will appear if license dongles are used with this CDCM platform. Install the license
dongle now and click Next when done.
UG1.0047.V12.3‐2A 145
Administratorʹs User Guide
Install License Dongle
Post D/3 Installation Steps
You will be prompted to perform the post D/3 Installation steps. These may include:
• making the account you are using for the installation have D3Administrator privileges;
• setting up passwords for the D3Administrator, D3Maint, and D3Operator accounts
(performed when installing on a new hardware platform);
• setting up the Data Historian using the DHS Applet;
• setting up Active Directory.
These steps are detailed in the Installation chapter of this manual.
UG1.0047.V12.3‐2A 146
Administratorʹs User Guide
Verify Account Privileges
Note: To continue to use the System Administrator account for the
installation or another account with Administrator privileges,
be sure to make Administrator or the account a member of the
D3Administrators group, if this has not already been done.
UG1.0047.V12.3‐2A 147
Administratorʹs User Guide
CDCM Post‐Installation Steps
CDCM Post‐Installation Steps are listed in this screen. Similar steps will need to be performed on a
DCM.
CDCM Post-Installation Steps
DCM Post Installation Steps
DCMs should have had all of the operating system changes performed in the DCM software
installation chapter of this manual prior to starting the DCM upgrade procedure. If these have not
been performed, go to the topic DCM, CDCM and Data Historian Operating System Settings, found
in the Installation and Setup chapter of this Administrator’s User Guide and perform these steps
now.
Files will not be able to be downloaded to the DCM without these steps being performed.
UG1.0047.V12.3‐2A 148
Administratorʹs User Guide
DCM Post Installation Steps
Configuring the Replacement CDCM on the Network
After the post‐installation steps have been completed, if the CDCM is being replaced, the next steps
in the procedure will require configuring the replacement CDCM with the previous CDCMʹs
network settings. Similar steps will be done if configuring a replacement DCM.
After the databases are converted, you will be prompted to open WinCod to obtain connection
address information.
Database Preparation
UG1.0047.V12.3‐2A 149
Administratorʹs User Guide
Begin Database/Application Conversion
Converting the Configuration Table to V12.3
As WinCod converts the Configuration table, displays similar to the following will appear:
Confirm WinCod auto start
Converting WinCod
UG1.0047.V12.3‐2A 150
Administratorʹs User Guide
Converting WinCod
Converting WinCod
Configuring the IP Address
Configure the IP address on the replacement CDCM.
Configuring the IP address using data from WinCod
Be sure the subnet mask for this node is correct for your configuration.
Change the CDCMs IP address
UG1.0047.V12.3‐2A 151
Administratorʹs User Guide
1. In WinCod, open the CDCM Settings (or DCM settings if this is a DCM) screen and view
the Network Addresses information (right side of the screen in the illustration).
CDCM Settings
2. Address information for one or two Ethernet cards will be shown. Make note of Ethernet
and TCP/IP address information for use in the configuring the replacement CDCM.
3. On the upgraded PC, go to C:\Documents and Settings\All Users\Start
Menu\Programs\Accessories\Communications and open Network Connections. You
should see the following:
UG1.0047.V12.3‐2A 152
Administratorʹs User Guide
Network Connections
4. Right‐click on the Local Area Connection and access Properties.
UG1.0047.V12.3‐2A 153
Administratorʹs User Guide
Local Area Connection Properties
UG1.0047.V12.3‐2A 154
Administratorʹs User Guide
Local Area Connection Properties
5. In the Local Area Connection Properties screen, select Internet Protocol/ (TCP/IP) and
select the Properties button.
UG1.0047.V12.3‐2A 155
Administratorʹs User Guide
Internet Protocol (TCP/IP) Properties
6. The radio buttons Use the following IP address: and Use the following DNS server
addresses: should be active. Change the information in the IP Address, Subnet mask:,
Default gateway:, Preferred DNS server:, and Alternate DNS server: fields to match that of
the legacy CDCM.
Setting the MAC address in WinCod
Running IPCONFIG
Use WinCod to replace the MAC address with the MAC address of this CDCM.
IPCONFIG runs in a command window:
UG1.0047.V12.3‐2A 156
Administratorʹs User Guide
IPCONFIG Report
Renaming the PC to the Previous CDCM name
Rename the PC to match the name of the previous CDCM (or DCM) as defined in WinCod. If the
CDCM (or DCM) computer name is not the same as the D/3 name, care must be taken to set up host
files to use aliases in the same way as on the legacy CDCM (or DCM).
Windows will prompt the user to reboot after a name change. Answer No to this prompt and
answer Yes to the reboot prompt from the Online Upgrade procedure instead. (Answering Yes to
the Windows prompt will cause the PC to reboot twice.)
Renaming the CDCM
UG1.0047.V12.3‐2A 157
Administratorʹs User Guide
Change the computer name:
Changing the Computer Name
Do not reboot using the dialog box from System Properties, but instead use the reboot from the OU
procedure. This prevents having to reboot twice.
Continue Upgrade
Answer Yes to this prompt if satisfied with your settings. Click No to revise settings. Click Cancel
to cancel the upgrade.
UG1.0047.V12.3‐2A 158
Administratorʹs User Guide
Reboot Prompt
Answer OK to this reboot prompt. After reboot, OU should restart. If not, click on the OU icon.
Resuming the Previous In‐Progress Online Upgrade
Returning to Online Upgrade
The step of the Online Upgrade was stored in the NT registry. This context is now restored. Click
OK to proceed, and view the following configuration activity screens.
Context Restored
UG1.0047.V12.3‐2A 159
Administratorʹs User Guide
Network Activity Configuration—Before Start
UG1.0047.V12.3‐2A 160
Administratorʹs User Guide
Network Activity Configuration—After Start
Converting Database Text Files on the CDCM
D/3 Conversion Utilities are now run to convert the legacy text files to their upgraded counterparts.
WinCod auto-started
UG1.0047.V12.3‐2A 161
Administratorʹs User Guide
Add EPN category
A summary of the conversions is displayed (see screen on page 163).
Success of some MDL conversions cannot be verified and will display the following message:
Conversion Log file created
This message just means that the procedure cannot verify the conversion is correct. This often is the
case when upgrading from V10.2. It does not mean that the conversion has a problem. You will
know if the conversion has had a problem when you build the MDL text file a little later in the
procedure.
UG1.0047.V12.3‐2A 162
Administratorʹs User Guide
Application Conversion Activity—After Start
Starting the D/3®
Preliminary D/3® Startup Progress—Before Start
UG1.0047.V12.3‐2A 163
Administratorʹs User Guide
Respond to the following alert and make the required changes in WinCod.
Note: Even if the MAC address appears to be correct, re‐enter a field
on each MAC address and then transmit the correct address.
This ensures that the PCMs and other DCMs get the new MAC
address for this node.
Preliminary D/3® Startup Progress—After Start
Rebuilding I/O Configurations on the CDCM
The HAC table, PLC databases, and Ethernet I/O databases are now converted by selecting each
utility and rebuilding their databases. This is done by entering the utility, selecting each PCM to
trigger the conversion, and then exiting the utility.
UG1.0047.V12.3‐2A 164
Administratorʹs User Guide
Rebuild the I/O Configurations
Select each PCM with a HAC table in HCU and verify that you get the conversion message. Recent
versions of the HAC table may not require conversion.
Select each PCM with a PLC database in POD. Recent versions of the PLC database may not require
conversion.
Select each PCM with an Ethernet I/O database and verify that the Ethernet I/O database is
converted.
Building New Databases on the CDCM
The OU procedure now directs the user to rebuild all of the D/3 databases using D3Architect.
Depending on the system configuration, a simple Build All may be all that is required. However,
all previous conventions for building a complete D/3 still apply. For example, multiple passes of
MDL to build the continuous databases with reloads of the display databases to the CDCM may be
required when PCMs have intra‐network EPN fetches.
Rebuild D/3® Applications—Instructions
At this stage, D/3 Manager and D/3 Architect are auto‐started in order to rebuild D/3 applications
for use on the upgraded system.
D/3 Manager should only be used at this point to stop and start the D/3. After reading the screen,
click Next to continue.
UG1.0047.V12.3‐2A 165
Administratorʹs User Guide
Rebuild D/3 Applications
Rebuild D/3® Applications—D/3 Architect™ Actions
Rebuild Databases using D3Architect
Use D3Architect to build all of the databases. A Build All may work here, but if the system has
intranetwork EPN fetches, it may be necessary to rebuild the continuous database and reload the
display databases several times. D3Manager may be used to restart the D/3 and load the display
databases.
D3Architect automatically uses the MDL –C switch to build the continuous databases which
running in Online Upgrade mode. This preserves the original IPN order of the analog processing
UG1.0047.V12.3‐2A 166
Administratorʹs User Guide
blocks in their tables. A warning message is produced if the –C switch is specified and MDL finds
that the preferred IPN is already in use.
A warning message similar to the following is produced:
%MDL-E-WARNING epn: TT221X0, block type: PID could not be assigned preferred ipn 3
This is a warning only and will not prevent the CDB database from being built. MDL instead uses
the next available ipn for that processing block type.
Note that if this error message appears for a database rebuild during an online upgrade, then an
online upgrade for that PCM (if part of a redundant pair) will NOT be successful. This error should
not happen; however, if the user follows the steps in the Online Upgrade procedure and produces
new MDL command files from loaded PCMs at an early step in the upgrade.
When the Online Upgrade is complete, D3Architect returns to building without the –C switch.
If it becomes necessary to edit the continuous database text file with D3Edit during the Online
Upgrade, be sure to always rebuild the database with the preferred IPN checkbox on. This runs
MDL with the ‐C switch. Alternately, the text file can be rebuilt from D3Architect because
D3Architect always uses the –C switch during an Online Upgrade.
D3Manager will now show the state of the CDCM as running upgraded software. The status of a
Legacy node may not be its true status.
D3Manager with Online Upgrade Status
The user needs to use D3Architect to enter the System Settings file. The modified date is revised
upon exit. This is required to continue.
Upgraded D/3® Startup Preparation
After applications have been rebuilt, the D/3 will be automatically stopped and restarted.
UG1.0047.V12.3‐2A 167
Administratorʹs User Guide
Click Next in this screen to begin the automatic stop and restart. Look for any indication of
problems in the D/3 Restart Progress screen.
®
D/3 automatic stop and restart
D/3 Restart Progress—Before Start
UG1.0047.V12.3‐2A 168
Administratorʹs User Guide
D/3 Restart Progress —After Start
Establish Console Passwords
When upgrading from V10.2, operator console passwords must be added. Without this, if any
console functions are protected, they will not be able to be accessed without a console account.
Establish Console Passwords
Rename Console Password File
When upgrading from a system with a legacy password file, the name and location of the file may
need to be changed
UG1.0047.V12.3‐2A 169
Administratorʹs User Guide
Rename Console Password File
Configure Node Manager Service
Click on the minimized D3 Node Manager Service Properties control panel icon
to set the properties for the Node Manager Service.
Configure Node Manager Service
UG1.0047.V12.3‐2A 170
Administratorʹs User Guide
Disconnect Legacy CDCM
The Legacy CDCM must now be disconnected and replaced with the upgraded CDCM, The new
CDCM’s ip addresses must be transmitted to all the nodes.
Disconnect Legacy CDCM
Connect Upgraded CDCM
Use WinCOD to Transmit New ip Addresses
UG1.0047.V12.3‐2A 171
Administratorʹs User Guide
Transmitting CDCM ip address to network
DCM Upgrade
After the new databases are built on the CDCM and the CDCM is running, some of the DCMs can
be upgraded. (Always be sure to keep a legacy DCM running as long as you have any legacy
PCMs).
When the OU Procedure is run on the DCM, the user is told to mark the DCM as upgraded on the
CDCM.
UG1.0047.V12.3‐2A 172
Administratorʹs User Guide
Mark DCM Upgraded
The DCM Online Upgrade procedure will display the following message to instruct the user to load
the DCM databases from the CDCM to the DCM.
Note: The DCM must be rebooted prior to performing the offline
load.
Manual Action Required—perform offline load of DCM databases
Automated Preparation for PCM Online Upgrade
After the new databases are built on the CDCM, OU_Track is loaded to all the PCMs. D3Manager
will now show the state of the PCMs as running legacy software.
UG1.0047.V12.3‐2A 173
Administratorʹs User Guide
DCM and PCM Preparation
Prepare Other Nodes for Upgrade—Before Start
UG1.0047.V12.3‐2A 174
Administratorʹs User Guide
Prepare Other Nodes for Upgrade—After Start
D3Manager showing legacy PCMs
The user is given an opportunity to upgrade any other DCMs and OCMs at this time. Be sure to
leave at least one legacy DCM running to control the legacy PCMs.
UG1.0047.V12.3‐2A 175
Administratorʹs User Guide
Performing a PCM Online Upgrade
OU now allows the user to upgrade their PCMs.
Node Upgrade
Monitoring OU progress
D3Manager is used to load the upgraded software to the backup PCM.
UG1.0047.V12.3‐2A 176
Administratorʹs User Guide
Loading the backup PCM with upgraded software
Note: Before loading this upgraded software, replace the Sboots on
the PCMʹs CPU, replace any required I/O PROMs and replace
the EthernetMPC cards with new EthernetMPC cards with the
correct Operating System.
UG1.0047.V12.3‐2A 177
Administratorʹs User Guide
Loading the backup PCM with upgraded software
UG1.0047.V12.3‐2A 178
Administratorʹs User Guide
D3Manager showing Backup PCM running with Upgraded Software
D3Manager is then used to failover to the upgraded PCM. This freezes the Scan tasks on the
selected micro, takes a snapshot of the database, loads this snapshot to the backup and then fails
over.
Warning: After the upgraded PCM shows as running, the failover to
the upgraded PCM show be performed as quickly as
possible, Any delay subjects the legacy PCM to unnecessary
communications over the R‐link with the upgraded PCM
and can lead to the legacy PCM crashing.
UG1.0047.V12.3‐2A 179
Administratorʹs User Guide
D3Manager Failing PCM over to upgraded PCM
After verification of failover and plant stability, D3Manager is used to load the upgraded software
to the other PCM.
Note: Before loading this upgraded software, replace the Sboots on
the PCMʹs CPU, replace any required I/O PROMs and replace
the EthernetMPC cards with new EthernetMPC cards with the
correct Operating System.
Warning: When the PCM is running in the mode with one legacy
node and one upgraded node, no changes of any kind
should be made to the PCM from the console or using
any D/3 database management tools such as MDL or
WinMOD.
UG1.0047.V12.3‐2A 180
Administratorʹs User Guide
D3Manager Failing PCM over to upgraded PCM
UG1.0047.V12.3‐2A 181
Administratorʹs User Guide
Concluding an Online Upgrade
After upgrading all PCMs a final opportunity to upgrade the remaining DCMs and OCMs is
provided.
Node Upgrade Activity Monitor
Upgrade DCM and OCM Reminder
UG1.0047.V12.3‐2A 182
Administratorʹs User Guide
Distribute Changes to Network Configuration
Distribute Changes to Network Configuration
Logs of the upgrade procedure may be delete as well as the legacy databases.
Close Out Online Upgrade
When this screen is reached, D/3 Manager can be closed. The Online Upgrade procedure will close
for both the CDCM and all nodes on the system.
In order to keep the log file and legacy database archive, check the boxes in this screen. Otherwise,
the files will be deleted.
Closeout Options
UG1.0047.V12.3‐2A 183
Administratorʹs User Guide
Recreate User Accounts and Settings
Recreate User Accounts and Settings
Begin Closeout Activities
UG1.0047.V12.3‐2A 184
Administratorʹs User Guide
Re-enable virus detection software
Log file creation
The Online Upgrade procedure may then be uninstalled.
Uninstalling the Online Upgrade Procedure
If a backout is required, the Online Upgrade procedure will automatically uninstall itself. The
following screen will be displayed:
®
Uninstall D/3 Online Upgrade
An additional screen will be displayed indicating the uninstall has been successfully completed:
UG1.0047.V12.3‐2A 185
Administratorʹs User Guide
Uninstallation Successful
Click Finish. The Upgrade may now be closed out. Close out progress is shown in the following
screen.
Upgrade Closeout Activity
The Online Upgrade procedure also can be uninstalled manually through the Windows Start menu,
or by using Add/Remove Programs in the Windows Control Panel.
A message may appear reminding you that you had disabled virus detection software earlier in the
OU procedure. Click OK to confirm the reminder, and if necessary re‐enable the virus detection
software.
UG1.0047.V12.3‐2A 186
Administratorʹs User Guide
Successfully Completed
Troubleshooting
Canceling the OU Procedure
The user can cancel out of the OU procedure. The following choices are then offered.
Cancel Options
UG1.0047.V12.3‐2A 187
Administratorʹs User Guide
Location of Setup and OUInstallProc Logs
Log files can be found in the location shown in the following screen.
Log file creation
System Messages
Most D/3 problems or messages during an upgrade are sent to the task log files for CSTSRV and
OUMON and are viewable from the D3Manager process log viewer.
Errors that are elevated to system level messages are listed below. If marked [error], the upgrade
will be unable to proceed.
If [error] appears, restart the D/3 and/or reload the problem PCM. If these steps do not clear the
error, abandon or back out of the upgrade.
CSTSRV in the CDCM can generate the following system message:
[error] CSTSRV unable to link to OU_TRACK (err %i)
MCSTSRV in the PCM can generate the following messages:
[normal] MSRV386 STARTED IN NORMAL MODE
[normal] MSRV386 RECOGNIZES ONLINE UPGRADE IN PROGRESS
[anomaly]MSRV386 OU_TRACK PRESENT BUT NOT YET INITIALIZED
[normal] MSRV386 OU_TRACK PRESENT. LEGACY VERSION: %i.%i UPGRADE
VERSION: %i.%i
[normal] MSRV386 ASSUMES LEGACY ROLE FOR THIS ONLINE UPGRADE
[normal] MSRV386 ASSUMES UPGRADED ROLE FOR THIS ONLINE UPGRADE
[normal] MSRV386 RECOGNIZES END OF ONLINE UPGRADE
[anomaly]MSRV386 NOT YET ABLE TO ACCESS OU_TRACK
[error] MSRV386 CANNOT READ OU_TRACK REGION (ERR: %i)
OUCRE in the PCM can generate the following messages:
[error] OUCRE: EXITING - ERR %i GETTING UNIT INFO
[normal] OUCRE: PREPARING TO CREATE REGION %p
[error] OUCRE: EXITING - ERR %i DELETING PRE-EXISTING OU_TRACK REGION
[error] OUCRE: EXITING - ERR %i CREATING REGION %p
UG1.0047.V12.3‐2A 188
Administratorʹs User Guide
[error] OUCRE: EXITING - ERR %i LINKING TO REGION %p
[error] OUCRE: EXITING - ERR %i INITIALIZING REGION %p
[error] OUCRE: EXITING - ERR %i INITIALIZING REGION %p TABLE
[normal] OUCRE: REGION %p (%p) SUCCESSFULLY CREATED (%i BYTES)
OUDEL in the PCM can generate the following messages:
[normal] OUDel: PREPARING TO DELETE REGION %p
[error] OUDel: ERR %i LINKING TO OU_TRACK REGION
[error] OUDel: REGION %p NON-EXISTANT
[error] OUDel: ERR %i DELETING PRE-EXISTING OU_TRACK REGION
[normal] OUDel: REGION %p SUCCESSFULLY DELETED
OUSNAP in the PCM can generate the following messages:
[normal] OUSNAP: BEGIN FREEZE AND BACKUP OF S-PCM TO NS-PCM
[normal] OUSNAP: FREEZING PDB/SDB
[error] OUSNAP: ERROR %i ATTEMPTING TO FREEZE SELECTED PCM PROCESSING
[error] OUSNAP: ERROR %i TRANSFERRING SDB
[normal] OUSNAP: TRANSFERRING PDB22
[error] OUSNAP: ERROR %i TRANSFERRING PDB
[normal] OUSNAP: ORDERING S-PCM FAILOVER
[error] OUSNAP: ERROR %i ATTEMPTING TO REMOTELY FAILOVER SELECTED PCM
[error] OUSNAP: ERROR %i ATTEMPTING TO RESTORE FORMER SELECTED PCM
PROCESSING
[normal] OUSNAP: COMPLETED FREEZE, BACKUP, AND FAILOVER OF S-PCM
[error] OUSNAP: EXITING - THIS TASK MUST RUN ONLY IN THE NON-SELECTED
PCM
[error] OUSNAP: EXITING - NO BACKUP PCM AVAILABLE
[error] OUSNAP: EXITING - ERR %i ACCESSING REGION %p
[error] OUSNAP: TIMEOUT WAITING FOR OU TRACKER INITIALIZATION
[normal] OUSNAP: OU_TRACK REGION LINKED AND READY. LEGACY VER: %i
[error] OUSNAP: ABORTING UPGRADE
[error] OUSNAP: BACKING OUT OF UPGRADE
[normal] OUSNAP: RELEASING THE SCAN TASKS
[error] OUSNAP: ERROR %i ATTEMPTING TO RESTORE SELECTED PCM PROCESSING
[error] OUSNAP: WARNING: ERR %i - UNABLE TO LINK TO %p REGION
[normal] OUSNAP: TRANSFERRING SDB
[error] OUSNAP: ERR %i - CANNOT FETCH SEQDB HEADER
[error] OUSNAP: ERR %i - CANNOT FETCH TABLE 2 UDB ENTRY
UG1.0047.V12.3‐2A 189
Administratorʹs User Guide
[error] OUSNAP: ERR %i - CANNOT FETCH TABLE 3 PCB ENTRY
[error] OUSNAP: ERR %i LINKING TO SEQ PROG %p
[error] OUSNAP: WARNING: ERR %i - UNABLE TO LINK TO %p REGION
[error] OUSNAP: ERR %i READING HEADER TO %p
[error] OUSNAP: WARNING: UNABLE TO RUN FAILOVER TASK (ERR %i).
ATTEMPTING COMM CALL.
[error] OUSNAP: ERR %i FETCHING INFO FROM REGION %p
[error] OUSNAP: ERR %i FETCHING INFO FROM REGION %p
[error] OUSNAP: ERR: PROCESS DB BLOCK TYPE %i DIFFERS IN NUMBER (%i,
%i)
[normal] OUSNAP: PDB TRANSFER COMPLETED
[anomaly]OUSNAP: REGION %p IS EMPTY
[error] OUSNAP: ERR %i LINKING TO REGION %p
[normal] OUSNAP: SRC REGION: %p DEST REGION: %p, SRC OFFSET %i
[normal] OUSNAP: TRANSFERRING %i BLOCKS FROM REGION %p
[normal] OUSNAP: TRANSFERRING TO REGION %p IN %i PACKETS
[error] OUSNAP: ERR %i FETCHING INFO FOR PDB BLOCK TYPE %i
[error] OUSNAP: ERR %i PUTTING INFO FOR PDB BLOCK TYPE %i
[normal] OUSNAP: SOURCE OFFSET FOR NEXT TYPE (%i) = %li
[normal] OUSNAP: TRANSFERRED %i PACKETS FOR TYPE %i
[normal] OUSNAP: MODICON/QUANTUM I/O CONFIGURED FOR THIS PCM.
[normal] OUSNAP: SIEMENS 505 I/O CONFIGURED FOR THIS PCM.
[normal] OUSNAP: PLC I/O CONFIGURED FOR THIS PCM.
[normal] OUSNAP: COMPLETED TRANSFER OF PLC I/O REGION(S).
[normal] OUSNAP: GPX I/O CONFIGURED FOR THIS PCM.
[normal] OUSNAP: PROFIBUS I/O CONFIGURED FOR THIS PCM.
[normal] OUSNAP: TRANSFERRING PROFIBUS I/O REGION(S).
[normal] OUSNAP: COMPLETED TRANSFER OF PROFIBUS I/O REGION(S).
[normal] OUSNAP: CONTROLNET I/O CONFIGURED FOR THIS PCM.
[normal] OUSNAP: CONTROLNET TRANSFER HANDLED BY PLC I/O HANDLER.
[normal] OUSNAP: NO UNSCHEDULED CONTROLNET DEFINED.
[normal] OUSNAP: COMPLETED TRANSFER OF CONTROLNET I/O REGION(S).
[normal] OUSNAP: ETHERNET I/O CONFIGURED FOR THIS PCM.
[normal] OUSNAP: TRANSFERRING PLC DB REGION(S).
[error] OUSNAP: ERROR %i ATTEMPTING TO LOCALLY UNBLOCK %p
[error] OUSNAP: ERROR %i ATTEMPTING TO REMOTELY UNBLOCK %p
UG1.0047.V12.3‐2A 190
Administratorʹs User Guide
[error] OUSNAP: ERROR CODE %i - UNABLE TO LINK TO %p REGION
[error] OUSNAP: ERROR CODE %i - UNABLE TO BLOCK %p TASK
[error] OUSNAP: ERROR CODE %i - UNABLE TO READ PROFIBUS HDR FROM S-PCM
[error] OUSNAP: ERROR CODE %i - UNABLE TO READ PROFIBUS HDR FROM NS-
PCM
[error] OUSNAP: ERROR - MISMATCHED PROFIBUS CONFIGURATIONS
[error] OUSNAP: ERROR CODE %i - UNABLE TO READ PROFIBUS STATUS FROM S-
PCM
[error] OUSNAP: ERROR CODE %i - UNABLE TO WRITE PROFIBUS STATUS TO NS-
PCM
[error] OUSNAP: ERROR CODE %i - UNABLE TO READ PROFIBUS INPUT DATA
FROM S-PCM
[error] OUSNAP: ERROR CODE %i - UNABLE TO WRITE PROFIBUS INPUT DATA TO
NS-PCM
[error] OUSNAP: ERROR CODE %i - UNABLE TO LINK TO %p REGION
[error] OUSNAP: ERROR CODE %i - UNABLE TO BLOCK %p TASK
[error] OUSNAP: ERROR CODE %i - UNABLE TO READ PLC DB HDR FROM S-PCM
[error] OUSNAP: ERROR CODE %i - UNABLE TO READ PLC DB HDR FROM NS-PCM
[error] OUSNAP: ERROR - MISMATCHED PLC DB CONFIGURATIONS
[error] OUSNAP: ERROR CODE %i - UNABLE TO READ STATUS DATA FROM S-PCM
[error] OUSNAP: ERROR CODE %i - UNABLE TO WRITE STATUS DATA TO NS-PCM
[error] OUSNAP: ERROR %i ATTEMPTING TO LOCALLY UNBLOCK %p
UG1.0047.V12.3‐2A 191
Administratorʹs User Guide
Error Message Reference
Error Messages
D/3 error messages are listed here. Much of this same information is also available using the err
command followed by the error number in a command window as shown below:
err -nnn
Where: -nnn is an integer from ‐1 to ‐32767.
D/3 errors referenced by a positive number (0‐256) cannot be retrieved using the err command;
instead, use this list as a reference.
There are some instances where the error number is used for several different messages. The first
entry given is the one that most commonly applies.
Note: Error messages displayed during online upgrades are not
listed here. See the Online Upgrades chapter for a list of
applicable error messages.
Error
Number Error Symbol Brief Description
0 ER_SUC Completed Successfully.
0 IND_SUCC success
1 ER_COMMERR Remote I/O comm has HIERR
NA BA Timeout, Board on‐line. The board could
1 EE_TAOO not give a buffer for transmit or comm().
1 EE_NAWR NA Write cannot happen
1 EE_SAM1 Rcvd Source not Match Destination
MIB.PREI Set but U.OUT = 0. No replies
1 EE_IIN1 expected.
1 ABL_SUC successful execution of ABL request
1 IND_NOSMP success ‐ no new sample ‐ use last val
2 ER_PSBAD Remote I/O Power Supply Bad
NA BA 1st Timeout, Board Offline. Board set
2 EE_TAOF1 suspicious.
2 EE_NBLK NB/LKC/LKD cannot happen
2 EE_SAM2 Rcvd Byte Count Bad
UG1.0047.V12.3‐2A 193
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
2 EE_IIN2 not expectable
FATAL ‐ NA BA 2nd timeout board off‐line. The
board could not give a buffer for transmit for
3 EE_TAOF2 comm().
3 ER_PSCOMM Remote I/O Power Supply & Comm Bad
3 EE_SAM3 HOST ‐ Online, But not expected
NA Reply 1st Timeout, Board Offline. Boards set
4 EE_TAIF1 suspicious
4 EE_SAM4 HOST Old Board Buffer
5 EE_TAIF2 FATAL ‐ NA reply 2nd timeout board off‐line.
6 EE_TAINF NA Reply 2nd Timeout, All Units Offline
7 EE_XLKDN NA PTE 1st Link Down. Link set suspicious.
8 EE_XF1 NA PTE 1st Board Offline. Board set suspicious.
9 EE_XF2 FATAL ‐ NA PTE 2nd board off‐line.
10 EE_XNRNF NA PTE No Response, No Units Online
11 EE_XMNANF NA PTE Msg Not Accepted,No Units OnLine
12 EE_XBRQ FATAL ‐ NA PTE bad request.
13 EE_LKCT NA LKC CCSR Timeout, Board Online
20 EE_DOIO NA DOIO Request Rejected ***MICRO ONLY***
21 EE_STAT NA DOIO Status Rejected ***MICRO ONLY***
22 EE_NBRD NB Read Request Rejected ***MICRO ONLY***
23 EE_NBWR NB Write Request Rejected ***MICRO ONLY***
NB No Message Received Timeout Board On‐
30 EE_TBIO Line
NB 1st No Msg Received Timeout board off‐line
31 EE_TBIF1 board set suspicious.
FATAL ‐ NB 2nd no message received timeout
32 EE_TBIF2 board off‐line.
33 EE_TBOO NB BA Timeout, Board Online
NB BA 1st Timeout, Board Offline board set
34 EE_TBOF1 suspicious.
35 EE_TBOF2 FATAL ‐ NB BA 2nd reply timeout board off‐line.
40 EE_PWF HOST ‐ Power Fail Recovery
41 EE_COFF HOST ‐ CON OFF LKA/B/C/D
42 EE_CON HOST ‐ CON ONL LKA/B/C/D
UG1.0047.V12.3‐2A 194
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
50 EE_AUOT HOST ‐ AWRITE ‐ U.OUT < 0
51 EE_RUOT HOST ‐ NARPLY ‐ U.OUT < 0
52 EE_BUOT HOST ‐ NABERR ‐ U.OUT < 0
100 EE_XXXX General Purpose Suberror
256 ER_MRIOSYNC MRIOC Board Out of Sync
‐1 ER_GEN General Purpose Error.
‐1 EE_DBBT Both Boards Dead
‐1 IND_NOVAL no value collected
Invalid trap number ‐ returned by EXEC trap
service routine. The trap code used is currently
‐2 ER_TRP not implemented.
‐2 EE_DB0 Bd 0 Dead
‐2 IND_NOFLT point is not a float
Invalid semaphore number (>max sem) ‐ the
semaphore number passed to the REQSEM or
‐3 ER_ILS RELSEM call is too large.
‐3 EE_TAOF2 NA BA 2nd Timeout, Board Offline
‐3 EE_DB1 Bd 1 Dead
‐3 IND_NOPNT point does not exist
Invalid semaphore number (<min sem) ‐ the
semaphore number passed to the REQSEM or
‐4 ER_INS RELSEM call is too small.
‐4 IND_NODB no database available
Task Not Found ‐ the task name specified is not
‐5 ER_TNF found in the TCB list.
‐5 EE_TAIF2 NA Reply 2nd Timeout, Board Offline
‐6 ER_TNB Task Not Blocked.
‐7 ER_DNF Device (DCB) Not Found.
‐8 ER_UNF Unit (UCB) Not Found.
Cannot Abort Task (exec‐resident) ‐ exec‐resident
task cannot be aborted. They may, however, be
‐9 ER_CAB blocked.
‐9 EE_XF2 NA PTE 2nd Board Offline
‐10 ER_SNF Mem : Segment Not Found.
Mem : No space available ‐ Not enough memory
‐11 ER_NSA is available. Whatever you are trying to load is
UG1.0047.V12.3‐2A 195
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
too big.
Mem : No segment available ‐ No segment
descriptor blocks are available for a newly created
‐12 ER_SDB segment.
‐12 EE_XBRQ NA PTE Bad Request
‐13 ER_CSS Mem : Cannot split shared segment.
‐14 ER_SNA Mem : Segment Not Allocated.
‐15 ER_ISN Mem : Invalid Segment Number.
‐16 ER_ISB Mem : Invalid Segment Base.
‐17 ER_CES Mem : Cannot Extend Shared Segment.
Mem : Reference Count Non‐Zero ‐ One or more
tasks are linked to the segment. All tasks must
‐18 ER_RNZ unlink before the segment can be unloaded.
‐19 ER_NSS Mem : Non Shareable Segment.
Mem : Too Many References ‐ Too many
‐20 ER_TMR references or time RSI not defined.
‐21 ER_TNU TCB Not Used.
‐22 ER_IST Trap : Invalid Segment Type.
‐23 ER_NAE Task/Text Name Already Exists.
‐24 ER_NTC No TCB Available.
‐25 ER_SNL Shared Text Segment Not Loaded.
Load Already In Progress ‐ Another load is
currently in progress, or a load terminated
abnormally. Use ʺMTL‐RESETʺ to reset the load
‐26 ER_INP in progress.
‐27 ER_IAD Illegal Load Address.
Illegal Sequence Number ‐ The sequence number
used in the communications message is not the
same as the one allocated for use by the load
‐28 ER_ISQ request message.
‐29 ER_TAB Task Already Blocked.
Memory Segment In Use ‐ One or more tasks are
linked to the segment. All tasks must unlink
‐30 ER_USE before the segment can be unloaded.
No Outstanding Load ‐ There is no load in
‐31 ER_NRE progress to be reset.
UG1.0047.V12.3‐2A 196
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
Undefined Communications Packet Type ‐ the
currently active program (SBOOT or EXEC) does
‐32 ER_UPT not know how to respond to the message.
‐32 EE_TBIF2 NB 2nd No Msg Received Timeout
‐33 ER_ISD Invalid SDB Index.
No Master Header ‐ No databases can be loaded
‐34 ER_NMH until a master header is created via ʺDBL ‐I#ʺ.
No Room For a Unitdb Header ‐ Not enough
space for unitdb headers was allocated by ʺDBL ‐
‐35 ER_NRM I#ʺ.
‐35 EE_TBOF2 NB BA 2nd Reply Timeout
‐36 ER_DAL Dispdb Already Loaded.
‐37 ER_PAL Pcmdb Already Loaded.
‐38 ER_DBL Database is Loaded.
‐39 ER_NPD Not Expecting PCM Db load.
‐40 ER_NDD Not Expecting Disp Db Load.
‐41 ER_PHN PCM Db Header Not Loaded.
‐42 ER_DHN Disp Db Header Not Loaded.
‐43 ER_BSQ Bad Db Sequence Number.
‐44 ER_BDT Bad Data.
Message Too Big ‐ The message would not fit in
‐45 ER_BIG 249 bytes.
‐46 ER_BDF Bad Field Number.
‐47 ER_IPN Ipn Out of Range.
‐48 ER_UNL Unit Db Not Loaded.
‐49 ER_DNL Sub Database Not Loaded.
‐50 ER_EPN Epn Not Found.
‐51 ER_IDT Invalid Data.
‐52 ER_BPN Bad Page Number.
‐53 ER_CKS Checksum Error.
‐54 ER_RED Read Error From Micro.
‐55 ER_BYT Byte Count Error.
‐56 ER_MAP Error Mapping to Host db.
‐57 ER_DBT Bad Db Type.
‐58 ER_NFD No File Descriptor.
UG1.0047.V12.3‐2A 197
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
‐59 ER_BFD Bad File Descriptor.
‐60 ER_FNO File Not Open.
‐61 ER_ILF Illegal I/O Function.
‐62 ER_TMO Timeout.
‐63 ER_OVR Overrun.
‐64 ER_FRM Framing Error.
‐65 ER_BDY Bad Display Type ‐ Get Display Fields.
‐66 ER_DBS No Response.
‐67 ER_BFO Bad Packet Format.
‐68 ER_BDG Bad Group Number.
‐69 ER_NDF Ipn Not Defined.
‐70 ER_SND Station Not Defined.
‐71 ER_RZE Reference Count Zero.
‐72 ER_DCM Illegal Function in DCM.
Bad Queue Number ‐ The queue number given is
greater than the number of queues in the queue
‐73 ER_BDQ group region.
Bad Queue Entry Size ‐ The entry size given is
larger than the maximum size allowed for the
‐74 ER_BES specified queue.
Queue Empty ‐ Returned by CPYQUE and
‐75 ER_QEM GETQUE.
‐76 ER_BQE Bad Queue Entry Number
‐77 ER_BAI Bad Adi Index.
‐78 ER_PCM Illegal Function in PCM.
Device Offline ‐ An attempt was made to access
an I/O device that is not physically attached to the
‐79 ER_OFL system.
‐80 ER_INI Brd Requires Init.
‐81 ER_PIO PIO Broken.
‐82 ER_MNP Mux Not Present.
‐83 ER_BNP Board Not Present.
‐84 ER_LOK Already Locked.
‐85 ER_AVE Avail List Empty.
‐86 ER_RTL Region Size Too Large.
UG1.0047.V12.3‐2A 198
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
‐87 ER_NNF Node Not Found.
‐88 ER_BRP Bad Reply.
‐89 ER_ASS Device Not Assigned.
‐90 ER_PNF Pseudo Dev Not Found.
‐91 ER_ENA Epoch Not Available.
‐92 ER_CLM Value Beyond Clamp Range.
‐93 ER_BNL Backup Database Not Loaded.
‐94 ER_MDL Unable to Open Db File ‐ MDL Running.
‐95 ER_LNK Linkrg Error.
Device Write Protected ‐ An attempt was made to
write to a device that is physically write‐
protected, or a disk that has been mounted as
write‐protected. If the error occurred while
mounting the disk and write‐protect is desired,
mount with the write protected flag (MOU ‐w).
Otherwise, physically write enable the device or
‐96 ER_WPR disk and remount it without write protection.
I/O Data Error (Bad Block, etc.) ‐ A soft data error
occurred on an I/O device. The exact error
‐97 ER_IOD condition has been printed on the console.
I/O Hardware Error ‐ A fatal hardware error
occurred on an I/O device. Check out the
hardware, making sure that itʹs plugged in, on‐
‐98 ER_IOH line, etc.
Cannot Remove Directory ‐ An attempt was
made to remove a directory through the remove
‐99 ER_CRD call or DEL utility. Use rmdir or UFG ‐r instead.
Directory Not Empty ‐ An attempt was made to
remove a directory that still contained a few
entries. Remove the entries before trying again.
‐100 ER_DNE The root directory may never be removed.
Iot : Cross Device Link ‐ An attempt was made to
create a link to a file on a different device than the
one containing the file. This is unconditionally
forbidden; all links to file must reside on the same
‐101 ER_CDL device as the file.
fcs — file already exists — an attempt was made
to create a link with the same name and version
number as an entry already appearing in the
‐102 ER_FAE directory. Either remove the existing entry, or
UG1.0047.V12.3‐2A 199
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
find a new name or version number for the link.
fcs — directory full — an attempt was made to
create a file, link, or directory in a directory that
already contained the maximum number of
entries allowed. Remove a few entries from the
‐103 ER_DFL directory and try again.
fcs — cannot link to directory — an attempt was
made to create a link to a directory file. This is
‐104 ER_CLD unconditionally forbidden.
‐111 ER_NOSLOT No Console Slots Available
‐112 ER_D3DOWN D/3 Not Running
‐113 ER_NOREM Error Starting Remote Task
‐114 ER_NOLCSE Remote License Not Loaded
‐115 ER_LIMEXC Remote License Limit Exceeded
‐116 ER_INUSE Requested Console Slot in Use
‐117 ER_INSAP Insufficient SAPs
‐124 ER_TAR Task Already Running
‐125 ER_FID Fortran Lev 1 ‐ Illegal Db Type
‐126 ER_NOC Fortran Lev 1 ‐ No Controller Blk Fnd
‐127 ER_NOP Fortran Lev 1 ‐ Put Not Allowed
‐128 ER_NOG Fortran Lev 1 ‐ Get Not Allowed
‐129 ER_WRM Device Already Open in Different Mode.
Iot : No Pool Space Available ‐ The EXEC has run
out of dynamic pool memory temporarily. Try
‐130 ER_NPL again when things quiet down.
‐131 ER_QTB Creque : Queue Bigger Than 64K.
‐132 ER_NOR Iot : Not Open For Reading.
Iot : Not Open For Writing ‐ An attempt was
made to write to a file that was only open for
‐133 ER_NOW writing.
‐134 ER_MMM Iot : Mode Mismatch.
Iot : Bad File Name ‐ The file name given was not
legal. Either the syntax was wrong, or illegal
‐135 ER_BFN characters were in the name.
‐136 ER_ASI Iot : Device Not Assigned.
UG1.0047.V12.3‐2A 200
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
disk — illegal block number — an attempt was
made to access a block not the disk. Something on
‐137 ER_IBN the disk is corrupted run VFY.
Fcs : File or Directory Not Found ‐ An attempt
was made to open a non‐existent file. A file must
‐138 ER_FNF be created before it may be opened.
fcs — directory not found — an attempt was
made to access a non‐existent directory. Use UFD
‐139 ER_DIR or mkdir to create a directory.
fcs — file protected — an attempt was made to
access a file in a way forbidden by the file
‐140 ER_PRO protection bits.
‐141 ER_FAO Fcs : File or Network Already Opened.
fcs — illegal n bytes to read/write — the number
of bytes passed to read or write was a negative
‐142 ER_ILN number.
‐143 ER_BAM fcs — bad mode
fcs — cannot seek past eof — an attempt was
made to seek a location beyond the current size of
‐144 ER_SPE the file.
fcs — disk full — an attempt was made to extend
a file on a disk which had no free space left.
‐145 ER_FUL Remove a few files and try again.
fcs — fatal i/o previously occurred — an attempt
was made to perform I/O to a file or device upon
which a fatal I/O error has occurred. Give up an
deither close the file and dismount the device,
‐146 ER_ERR thus clearing the error condition.
Fcs : File Too Large ‐ An attempt was made to
‐147 ER_FTL write past the maximum allowable file size.
‐148 ER_BIB fcd ‐ bad indirect block
fcs — volume is mounted — an attempt was
made to mount a volume that was already
mounted. No problem; just go on as if you
‐149 ER_MOU mounted the disk.
fcs — disk marked for (dis)mount — an attempt
was made to open, create, or remove a file on a
disk that has been marked for dismount. Either
wait for the disk to become dismounted (when all
‐150 ER_MRK files currently open on the disk are closed) and
UG1.0047.V12.3‐2A 201
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
mount another disk, or re‐mount the disk to reset
the marked‐for‐dismount flag.
fcs — seek to before beginning of file — an
attempt was made to seek to a location less than
‐151 ER_SBB zero, i.e., before the first byte in the file.
fcs — disk not mounted — an attempt was made
to perform I/O to an unmounted disk. Mount the
‐152 ER_UMO disk and try again.
fcs — bad superblock — the superblock of the
disk being mounted was not valid; either the
checksum or the identification code was not
‐153 ER_BSB correct. Run VFY on the disk.
fcs — bad FHB — the FHB of the file being
accessed is corrupted; either the checksum or
identification code was incorrect. Run VFY on the
‐154 ER_FHB disk.
fcs — disk is open in RAW mode — an attempt
was made read or write to a disk open in the raw
‐155 ER_RAQ mode. Use rdblks or wrblks instead.
‐156 ER_BAL Backdb Already Loaded.
‐157 ER_SAL Seq Db Already Loaded.
‐158 ER_NBD Not Expecting Backup Db Load
‐159 ER_SBD Not Expecting Sequence Database.
‐160 ER_BHN Backup Db Header Not Loaded.
‐161 ER_NSD No Seq Db Loaded.
‐162 ER_NNF name not found
‐163 ER_NPA No Pcbs Available.
‐164 ER_NSU No Such Unit.
‐165 ER_SPA Seq Program Already Running.
‐166 ER_AAL Seq Abort In Progress.
‐167 ER_BSP Bad Program Number.
‐168 ER_SSN Seq State Not Found.
‐169 ER_SSO Seq State Overrun.
‐170 ER_SNP SDB or UPF Serial Number Mismatch.
‐171 ER_VRT Sequence Variable Reference Too large.
UG1.0047.V12.3‐2A 202
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
‐172 ER_SDE Sequence DDC Variable Lookup Error.
‐173 ER_QFL Putque : Queue Full
‐174 ER_RSP Request Still Pending ‐ External I/O.
‐175 ER_NSC No Such Console Defined.
‐176 ER_QDN Query Entry could not be found.
‐177 ER_QES Query has already been answered or timed out.
‐178 ER_DVF Device Entry Queue Error.
‐179 ER_NST Gosub Stack Nesting Error.
‐180 ER_AER Program Already in Error RSR.
‐181 ER_SER Program Attempting Illegal State.
‐182 ER_UKN Unknown Exec Dispatch Error.
‐183 ER_BFE Bad Function Used in Expression
‐184 ER_IVT illegal sequence variable type in SVD
‐185 ER_PDL Pointer Depth too Large
‐186 ER_RRA Attempt to do Remote Relative Access
‐187 ER_RME Could Not do Remote Access
‐188 ER_DDC Error on DDC Access Attempt
‐189 ER_BPT Breakpoint Trap Hit.
‐190 ER_AFU ***TEMPORARY ILLEGAL SERIAL # ***
‐191 ER_NAP Not a Pointer ‐ Cannot be Resolved
‐192 ER_NAT Timer Required
‐193 ER_NSP No Such Program on This Unit
‐194 ER_SELINIT Newly Selected PCM SABL PCB init in progress
‐195 ER_ALC Sequence Database Allocation Error.
‐196 ER_IVT Invalid Sequence Variable Type
‐197 ER_GBE Error Getting Block Information
‐198 ER_ILR Illegal Subroutine Return
‐199 ER_RDF Illegal Recipe Date File Name
‐200 ER_RNL Recipe Datafile Not Loaded in Memory
‐201 ER_LNE Recipe Load Not Enabled
‐202 ER_BAS Bit Already Set in Dvrsr Request
‐203 ER_NDR No Recipe Directory
‐204 ER_RNT Recipe Name Exists in Directory
UG1.0047.V12.3‐2A 203
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
‐205 ER_NFE No Recipe Directory Slots Open
‐206 ER_ENF Recipe Name Does Not Exist
‐207 ER_CTL Cannot Translate Logical Name
‐208 ER_DCL No Permission to Run DCL Program
‐209 ER_NRL Sequence Unit Not in RUNIT List
‐210 E_UPT Undefined Communications Packet Type
‐218 E_UMCS RCOMM : Undefined Code/Scode
‐219 E_NONO Cannot Put Boards On‐Line
‐220 E_SWSB Board Switch to Self (Same Board)
‐220 E_DORT Retries Start Here
‐221 E_SWOB Board Switch to Other Board
‐222 E_DEAD Boards Dead
‐223 E_SWIP Switch in Progress ‐ MICRO ONLY
‐224 E_RTO1 1st Reply Timeout, Dest Online
‐225 E_MNA1 Board Error ‐ 1st Msg Not Accepted
‐226 E_NR1 Board Error 1st No Response
‐227 EE_NABA NADRV xmit buffer not available
‐227 E_NOER NO RETRY PAST HERE
‐228 E_CANC HOST : Canceled IO Request
‐231 E_NLL Could Not Pass Msg Ahead on Reroute
‐232 E_NORT No Retry Past Here
DOIO Request : Invalid Header Size ***MICRO
‐240 E_NAHZ ONLY***
‐241 E_NATY DOIO/QIO Request : Invalid Write Condition
‐242 E_NACN DOIO/QIO Request : Invalid Byte Count
‐243 E_NADS DOIO/QIO Request : Dest Not in UXREF
‐244 E_NASU DOIO Request : Send to Self
‐245 E_RWBF Sent Redundant, Both Units Offline
‐246 E_PWPF Sent to Primary, Primary Offline
‐247 E_SWSF Sent to Secondary, Secondary Offline
‐248 E_RPOX Redun Write, Primary Offline
‐249 E_RPOF Redun Write, Primary Offline
‐250 E_RSOF Redun Write, Secondary Offline
‐251 E_RTOF Reply Timeout, Destination Offline
UG1.0047.V12.3‐2A 204
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
‐252 E_RTO2 2nd Reply Timeout, Dest Online
‐253 E_LKDW Board Error : Link Down After Switch
‐254 E_MNA2 Board Error : 2nd Msg Not Accepted
‐256 E_NR2 Board Error : 2nd No Response
‐257 E_NANP HOST : Illegal Comm Pointers
‐258 E_NAFD HOST : Bad File Descriptor
‐259 E_NADB HOST : NA Comm Board Dead
‐260 E_NACK HOST : LKINI ‐ $CKBFB Failure
‐261 E_KCIL LKC Command : Illegal Function.
‐262 E_KDIL LKD Command : Illegal Function.
‐263 E_KCXR LKC C.XREF : XREF Table Already Lded.
‐264 E_ILRQ HOST : Illegal QIO Function code.
‐265 E_RGST READ Request : Fun Out of Range
‐266 E_ILST READ Request : Fun Not Implemented.
‐267 E_SVST READ Request : Board Not Present.
‐268 E_CERR READ Request : Command Err From bb.
‐270 ER_BUSY MRIOC Board is Busy
‐271 E_ACAT HOST : ACCEPT routine ‐ NA Cannot Happen.
‐272 E_AOBF HOST : NASEND ‐ No OUTBUFʹs Available.
‐273 E_BACK HOST : No Backup Board.
‐274 E_DCON HOST : Board Not Connected Online.
‐275 E_BONL HOST : Cannot Connect Board to Link.
‐280 E_RDIP NB READ : Read Already In Progress.
HOST NB READ : Read Buffer Count Greater
‐281 E_NBRC Than 256.
‐282 E_WRIP NB WRITE : Write Already In Progress.
‐283 E_NBCN NB WRITE : Invalid Byte Count.
‐284 E_NBDS NB WRITE : Dest Not in UXREF.
‐285 E_NBSU NB WRITE : Send to Self.
‐286 E_NBCK HOST : NB WRITE ‐ $CKBFB Failure.
‐287 E_NBWC HOST : NB Write Condition Not Absolute.
‐288 E_BCAT HOST : ACCEPT Routine. NB cannot happen.
‐290 E_RWPF Redundant Write, Primary Offline.
‐291 E_RWSF Redundant Write, Secondary Offline.
UG1.0047.V12.3‐2A 205
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
NA BA : Unexpected Interrupt ‐ *** Micro Only
‐292 E_IABA *** Wrong Board.
NA BA : Unexpected Interrupt ‐ Nobody is
‐293 E_SABA Waiting.
‐294 E_IAMI NA MIB : Unexpected Interrupt ‐ Wrong Board.
NA MIB : Unexpected Interrupt ‐ Nobody is
‐295 E_SAMI Waiting or match errors.
‐296 E_NARZ NA MIB : Interrupt & inv Reply Size.
‐297 E_IPTE NA PTE : Unexpected Interrupt ‐ Wrong Board.
NA PTE : Unexpected Interrupt ‐ Nobody is
‐298 E_SPTE Waiting.
‐299 E_NXRF HOST : NA/NB Received Message Source Unit.
NA Rcvd Reply : Source Not Match ‐ destination
‐300 E_NASM sent
‐301 E_IINP HOST : NA Unexpected Input (PRCS).
‐302 E_BOUT HOST : Received Msg Number Illegal.
‐303 E_DPNA HOST : NA Reply ‐ I/O Packet Already Disposed.
‐304 E_IASV NA SV : Unexpected Interrupt ‐ Wrong Board.
NA SV : Unexpected Interrupt ‐ Nobody is
‐305 E_SASV Waiting.
‐306 E_LKTCO HOST : LKC CCSR Timeout, Board Offline.
‐307 E_LKTCN HOST : LKC CCSR Timeout, Nobody Waiting.
HOST : PTE Error, Pkt Disposed ‐ I/O Packet
‐308 E_EPTE Already Disposed.
‐310 E_IBBA NB BA : Unexpected Interrupt ‐ Wrong Board.
NB BA : Unexpected Interrupt ‐ Nobody is
‐311 E_SBBA Waiting.
‐312 E_IBMI NB MIB : Unexpected Interrupt ‐ Wrong Board.
NB MIB : Unexpected Interrupt ‐ Nobody is
‐313 E_SBMI Waiting.
‐314 E_NBMS NB MIB Interrupt & Source unit Not in UXREF.
‐315 E_NBMZ NB MIB Interrupt & Invalid Msg Size.
‐316 E_ICSR HOST : Unexpected CCSR Interrupt.
‐317 E_IOUT HOST : Unexpected Output Interrupt.
‐318 E_SDOWN Comm System Shutdown.
‐319 E_SELECT Illegal Select Bit.
UG1.0047.V12.3‐2A 206
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
NA Input Timeout ‐ Unexpected ‐ Nobody is
‐320 E_TOAI Waiting.
NABDRV ‐ Illegal Output of Timeout to
‐321 E_TOAO (NOBODY WAITING)
NB No Message Received Timeout ‐ Unexpected ‐
‐322 E_TOBI Nobody is Waiting.
NBDRV ‐ Illegal Output or Timeout to (NOBODY
‐323 E_TOBO WAITING).
‐324 E_BDAD HOST : Cannot Read Board Address.
‐325 E_B0ON HOST : Cannot Put Bd 0 Online.
‐326 E_B1ON HOST : Cannot Put Bd 1 Online.
‐327 E_ICCI HOST : Illegal CCSR Interrupt.
‐328 E_LKDR HOST : LKDERR Partition Not in System.
‐329 E_RXYZ RLINK is Dead.
‐330 E_DNAR HOST : NARTIME DISP.
Message Write Condition (Selected) Does not
‐340 E_REJECT match unit select status.
Message rejected ‐ wrong select bits in message.
‐340 ER_SELECT Message not intended for this unit.
‐341 ER_SFT Arithmetic error from 8087
‐350 ER_NOBUF Scan Buffer Not Available.
‐361 ER_EAL soe db already loaded
‐362 ER_NED soe not expecting db
‐363 ER_EHN soe header not loaded
‐364 ER_GOR soe group out of range
‐365 ER_GAL soe group already loaded
‐366 ER_GNL group not locked
‐367 ER_IPI illegal point ipn
‐368 ER_IGN illegal group number
‐369 ER_C01 Error Code 1
‐370 ER_C02 Error Code 2
‐371 ER_C03 Error Code 3
‐372 ER_C04 Error Code 4
‐373 ER_C05 Error Code 5
‐374 ER_C06 Error Code 6
UG1.0047.V12.3‐2A 207
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
‐375 ER_C07 Error Code 7
‐376 ER_C08 Error Code 8
‐377 ER_C09 Error Code 9
‐378 ER_C10 Error Code 10
‐379 ER_PRT *UNUSED* Invalid 544 port number
‐380 ER_CMD *UNUSED* Invalid 544 command
‐381 ER_ALL *UNUSED* 544 allocation failure
‐382 ER_DEA *UNUSED* 544 deallocation failure
‐383 ER_TX *UNUSED* 544 transmit data error
‐384 ER_RX *UNUSED* 544 receive data error.
‐385 ER_STGL String Editor : String to Large.
‐385 ER_PCB *UNUSED* 544 port allocated
‐386 ER_MIH MIO Databus High Error.
‐386 ER_DSP *UNUSED* 544 dispatch count exceeded
‐387 ER_MIL MIO Databus Low Error.
‐387 ER_QIF *UNUSED* 544 queue is full
‐388 ER_GBP Crerg, Increase Sysgen GBLPAGES
‐388 ER_VAL *UNUSED* invalid 544 data value
‐389 ER_STB Crerg, Increase Sysgen GBLSECTIONS
‐389 ER_FSQ *UNUSED* 544 data value
‐390 ER_GPF Crerg, Increase Sysgen GBLPAGFIL
‐391 ER_NCI No Controller Defined
‐392 ER_GOL Garbage On Link
‐400 ER_NLP PCM Db Not Loaded.
‐401 ER_NLD DISPLAY Db Not Loaded.
‐402 ER_NLI INTERLOCK Db Not Loaded.
‐403 ER_NLS SEQUENCE Db Not Loaded.
‐404 ER_NLX EXTERNAL Db Not Loaded.
‐405 ER_NLB BACKUP Db Not Loaded.
‐406 ER_NCS STRING Region Not Created
‐416 ER_DEO Denormalized Operand on the 8087 Stack
‐417 ER_HLD Program Already in Hold
‐418 ER_CON Program Already in Console RSR
UG1.0047.V12.3‐2A 208
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
‐419 ER_KIK Program Already in Kick RSR
‐420 ER_CNT Program Already Countdown RSR
‐421 ER_DEV Program Already in Device RSR
‐422 ER_SHF Shift Too Big on Bit Shift Function
‐423 ER_STT Error on Get Status Function
‐424 ER_RNA Remote Access Not Allowed Here
‐425 ER_NAS Not a String
‐426 ER_NAN Not a Number
‐427 ER_STL String Too Large to Store
‐428 ER_SSA No Scratch String Area
‐429 ER_CNC Cannot Convert
‐500 ER_IVS Invalid Memory Segment.
‐501 ER_SNR Segment Not Readable.
‐502 ER_SNW Segment Not Writable.
‐503 ER_WIP Memory Write in Progress.
‐504 ER_NGB No GDBs.
‐600 ER_FULL AMPCOL Region is Full.
‐601 ER_ERLD AMPCYC Did Not Load the .def File.
‐602 ER_NTRN AMPCYC is Not Running.
‐611 ABL_FAIL Failed Execution of ABL Request
‐612 ABL_NFD Batch ID Not Found in ABL
‐613 ABL_EXS Batch ID Already Exists
‐614 ABL_FUL ABL Full, Max # of Active Batches
‐615 ABL_AOB Unit/EPN Allocated to Other Batch ID
‐616 ABL_AID Unit/EPN Already Allocated to Batch ID
‐617 ABL_NID Unit/EPN NOT Allocated to Batch ID
‐618 ABL_NAL Unit/EPN Not Allocated
‐619 ABL_ALF Unit Allocation List Full
‐620 ABL_INV Invalid Data Request From GETBATINFO
‐621 ABL_COM Net Comm Error Sending ABL Request
‐622 ABL_IID Illegal Character in Batch ID String
‐623 ABL_TMO ABL Request Timeout
‐633 ABL_OFR Data Received is Out of Range (EXEC)
UG1.0047.V12.3‐2A 209
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
‐634 ABL_DUP Dupl ABL Request pkt Received (EXEC)
‐635 ABL_REJ Validate ABL Request Rejected (EXEC)
‐636 ABL_FPS Floating Point Stack Error
‐637 ABL_OPR Could Not Open ABL(QUE) Region
‐638 ABL_ILT Illegal Type
‐639 ABL_QFL ABLQUE Full
‐640 ABL_MNR ABLMGR Not Running or No ABLQUE
‐641 E_PTTO Board Primary Transmit Timeout
‐642 E_PRTO Board Primary Receive Timeout
‐643 E_SRTO Board Secondary Receive Timeout
‐644 E_STTO Board Secondary Transmit Timeout
‐650 ABL_RESNA ABLMGR Return Error Slot Not Available
‐651 ABL_QERR ABL Queue unavailable
‐653 ABL_DUPM Duplicate ABL Master
‐655 ABL_REGNA ABL region not available
‐656 ABL_BADR Bad ABL region reconciliation
‐657 ABL_BUSY ABL region locked / busy
‐658 ABL_NMST Not the ABL master (canʹt handle this request)
‐659 ABL_BLCK Batch in ABL is locked / changes not permitted
‐660 ABL_BMOD Bad/inappropriate mode for ABL Node
‐661 ABL_BIDX Bad/inappropriate index
‐662 ABL_BSLT Batch slot discrepancy (already in use or should
be in use)
‐663 ABL_BSYNC Batch out of sync
‐664 ABL_AEPN EPN still allocated to batch
‐665 ABL_ASUNIT Seq unit still allocated to batch
‐666 ABL_RPTERR Report submit error not returned to originating
DCM
‐700 ER_SPCM Illegal Function in Selected PCM
‐701 ER_NSPCM Illegal Func in Non‐Selected PCM
‐702 ER_CER Comm Error to Redundant PCM
‐703 ER_INF SABL : Invalid Function
‐704 ER_STN SABL : Step Not Found
‐800 ER_PDBMM Process Database Serial # Mismatch
UG1.0047.V12.3‐2A 210
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
‐801 ER_SDBMM SABL Database Serial # Mismatch
‐802 ER_BADCGD Unknown Collector Grp Descrp (CGD)
‐803 ER_BADEGD Unknown Exception Grp Descrp (EGD)
‐804 ER_CGDREG No CGD Region Present
‐805 ER_EGDREG No EGD Region Present
‐806 ER_EMPCGD Empty CGD Region
‐807 ER_EMPEGD Empty EGD Region
‐808 ER_FULCGD Full CGD Region
‐809 ER_FULEGD Full EGD Region
‐810 ER_CGDSMM CGD Serial Number Mismatch
‐811 ER_NOTEGD Group is Not an Exception Group
‐812 ER_DELCGD Could Not Delete CGD (Region)
‐813 ER_DELEGD Could Not Delete EGD (Region)
‐814 ER_CGDNYI CGD Region Not Yet Initialized
‐900 E_XIONDB No XIO DB on PCM (From XIOACC).
‐901 E_XIOPAG Page Status Error (From XIOACC).
‐902 E_XIOBLK I/O Block Error (From XIOACC).
‐903 E_XIOFNC Function Error (From XIOACC).
‐904 E_XIODPR Dual Port Memory Read Error (From XIOACC).
‐905 E_XIORSP Response Code is Bad (XIOSTA).
‐906 E_XIOCPU CPU on I/O Board is Bad (XIOSTA).
‐907 E_XIOMEM Memory on I/O Board is Bad (XIOSTA).
‐908 ER_XAL XIO : Database Already Loaded.
‐909 ER_NXD XIO : Not Expecting XIO Database.
‐910 ER_XHN XIO : Database Header Not Loaded.
‐920 ER_QRP Query in Progress Error for RCOMM
‐1000 ER_LMFERR General LMF Error
‐1001 ER_INVALIDLIC Invalid License
‐1002 ER_NOLIC No License Exists
‐1003 ER_LICEXCEEDED License Limit Exceeded
‐1004 ER_LMFVERMIS Version Mismatch
‐1020 ER_PWINF PWI Entry Not Found
‐1021 ER_ILADR Illegal PLC Address
UG1.0047.V12.3‐2A 211
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
‐1022 ER_ADRNF PLC Address Not Found
‐1023 ER_REGOR PLC Address Out of Range
‐1024 ER_ILNOD Illegal PLC Node Number
‐1025 ER_ILBIT Illegal PLC Bit Number
‐1026 ER_ILROT Illegal PLC Routing Path
‐1027 ER_ILGRG Illegal Register
‐1028 ER_NEWPCM Use New method to Access PCM
‐1201 ER_RQSEM Request Device Semaphore error
‐1202 ER_RLSEM Release Device Semaphore error
‐1203 ER_RQCSM Request Complete Semaphore error
‐1204 ER_RLCSM Release Complete Semaphore error
‐1205 ER_STREG Status Register Error
‐1206 ER_PBFR1 Put a buffer to free list: AX before the first buffer
‐1207 ER_PBFR2 Put a buffer to free list: AX past the last buffer
‐1208 ER_PBFR3 Put a buffer to free list: all Enet UCBs busy
‐1209 ER_CRBOL Buffer already on the Free list: CHKCHK crash
‐1210 ER_RQBEU Request Ethernet buffer error
‐1211 ER_NOTMI Timeout and no input timeout routine to call
‐1212 ER_NOTMO Timeout and no output timeout routine to call
‐1213 ER_ETOPN Could not Open Ethernet for Communications
CCRASH Respond to crash request: MTL ‐M xxx
‐1214 ER_SNDMS ‐CRASH
Database Record still locked after retries: No
‐1215 ER_RECUN crash
No Global Descriptor Table Available: GDT
‐1216 ER_NOGBL crashes
‐1217 ER_UNSGD Unload Segment Descriptor Error ‐ crashes
Enter Segment in Allocated List Errors [6] ‐
‐1218 ER_ALLST1 crashes
Enter Segment in Allocated List Errors [6] ‐
‐1219 ER_ALLST2 crashes
Enter Segment in Allocated List Errors [6] ‐
‐1220 ER_ALLST3 crashes
Enter Segment in Allocated List Errors [6] ‐
‐1221 ER_ALLST4 crashes
UG1.0047.V12.3‐2A 212
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
Enter Segment in Allocated List Errors [6] ‐
‐1222 ER_ALLST5 crashes
Enter Segment in Allocated List Errors [6] ‐
‐1223 ER_ALLST6 crashes
‐1224 ER_ALLOC1 Allocation Error [2] ‐ crashes
‐1225 ER_ALLOC2 Allocation Error [2] ‐ crashes
‐1226 ER_SMRQR1 Semaphore Request/Release error[2] ‐ crashes
‐1227 ER_SMRQR2 Semaphore Request/Release error[2] ‐ crashes
‐1228 ER_PTRCS Pointer errors ‐ crashes
‐1229 ER_FRELS Free list pointer error ‐ crashes
Uncorrectable General Protection Fault Condition
‐1230 ER_GPFLT ‐ Crash
‐1231 ER_BDSWR Illegal return from Switch ‐ crashes
Interrupt Exit Routine Fork Level Negative ‐
‐1232 ER_INTEX crashes
Task Control Block Dequeue, cannot find TCB on
‐1233 ER_TCBDQ queue ‐ crashes
‐1234 ER_TSKSP Called Task Suspend from Fork Level ‐ crashes
‐1235 ER_TSKOD Test for Task Stack Guard word failed ‐ crashes
‐1236 ER_TSKOV Test for Task Stack Overflow failed ‐ crashes
‐1237 ER_TSKOU Test for Task Stack Underflow ‐ crashes
‐1238 ER_ALLDN Allocate Device Semaphore and all used ‐ crashes
Allocate Complete Semaphore and all used ‐
‐1239 ER_ALLCS crashes
‐1240 ER_EXEXT Exec Resident task called Exit ‐ ‐ crashes
‐1241 ER_DIVZR Divide by zero trap and no active task ‐ crashes
‐1242 ER_SNGST Executed single Step ‐ crashes
‐1243 ER_BTRAP Breakpoint Trap Encountered ‐ crash
Release Semaphore error: no TCB assigned ‐
‐1244 ER_RELSM crashes
Call to removed XCPYQUE routine Trap 47 ‐
‐1245 ER_XCPYQ crash
‐1246 ER_NOTCB EXIT point, no active TCB ‐ crashes
‐1247 ER_EXSWT EXIT point ‐ illegal return from Switch ‐ crashes
‐1248 ER_NIUCB Invalid link ‐ No UCB found ‐ crashes
UG1.0047.V12.3‐2A 213
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
‐1249 ER_TFRCS TSKFRE ‐ Free Task CS memory error ‐ crashes
‐1250 ER_TFRDS TSKFRE ‐ Free Task DS memory error ‐ crashes
Command Queue Entry Point for Pentiums ‐
‐1251 ER_CMDQ crashes
‐1252 ER_BDUCB Illegal UCB on Ethernet Timeout ‐ crashes
‐1253 ER_BDTCP Illegal Ethernet Message Header Format ‐ crashes.
‐1254 ER_MSGSZ Illegal Ethernet Message data size ‐ crashes
‐1255 ER_SETUP1 Setup of Ethenet Chip Out of Range ‐ crashes
‐1256 ER_SETUP2 Setup of Ethenet Receiver Out of Range ‐ crashes
‐1257 ER_GETBUF Get Buffer Request out of range ‐ crashes
‐1258 ER_MFEBF MFDC Ethernet Buffer out of range ‐ crashes
‐1259 ER_PKTSZ MFDC Ethernet Packet size out of range ‐ crashes
‐1261 ER_TCPCK TCPIP message cross check failure ‐ crashes
‐1262 ER_NOTK1 No Token Ring ‐ non Ethernet message ‐ crashes
No Token Ring ‐ Message In Buffer Interrupt ‐
‐1263 ER_NOTK2 crashes
No Token Ring ‐ Message In Buffer Interrupt ‐
‐1264 ER_NOTK3 crashes
No Token Ring ‐ Transmit Buffer Available
‐1265 ER_NOTK4 Interrupt ‐ crashes
PCM4 Ethernet Message illegal Buffer address ‐
‐1266 ER_BDMSG crashes
PCM4 Ethernet message outsdie legal size ‐
‐1267 ER_P4EBIG crashes
‐1268 ER_SMOT Smart Ethernet Download timeout
‐1269 ER_SDN No Smart Ethernet Block Table found ‐ crashes
‐1270 ER_ILIP Illegal IP address specified
‐1271 ER_ILETH Illegal Ethernet Address
‐1272 ER_NETHDAT Unable to link to ethdat Region
‐1273 ER_SMDB Ethernet Block table not linked
‐1274 ER_ILIID Illegal Ethernet Interface Specified
‐1275 ER_ILGRN Illegal Register Number Specified
‐1276 ER_ILRGB Illegal Register Bit Specified
‐1277 ER_ILRGO Illegal Register Offset Specified
‐1278 ER_MSCOMERR Microsoft COM error
UG1.0047.V12.3‐2A 214
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
‐1279 ER_NOENT No Available Entry Found in String Table
‐1495 D3MSG_D3LIBERR error calling %1!s!, error: %2!d!
‐1496 D3MSG_D3FTLEXIT Exiting with Fatal Error Condition.
‐1497 D3MSG_SYSRVERR error calling: %1!s!
‐1498 D3MSG_ERRCLOSEFILE error closing file: %1!s!
‐1499 D3MSG_D3ERREXIT Exiting with Error Condition.
‐1500 D3MSG_ASSNERR error assigning to device : %1!s!
‐1501 D3MSG_ERRLNKRG error linking to region %1!s!, error: %2!d!
‐1502 D3MSG_TIMEOUT %1!s! timer expired ...
‐1503 D3MSG_ILLRECTYP illegal record type: %1!d!
‐1504 D3MSG_FILEPROC file has already been processed:
‐1505 D3MSG_ILLXFRSEG illegal transfer segment : %1!x!
‐1506 D3MSG_ILLSEG illegal segment %1!x!
‐1507 D3MSG_NEEDPRIV program needs %1!s! privilege:
‐1508 D3MSG_INVLOGNAM invalid logical name: %1!s!
‐1509 D3MSG_INVARGLST invalid argument list:
‐1510 D3MSG_MISSINGPARM required parameter not found for argument: %1!s!
‐1511 D3MSG_MISSINGARG required argument not found :%1!s!
‐1512 D3MSG_INCOMPARG incompatible arguments: %1!s! and %2!s!
‐1513 D3MSG_INVNUMARG invalid number of arguments:
‐1514 D3MSG_INVARG invalid argument: %1!s!
‐1515 D3MSG_ERRWRITEFILE error writing file: %1!s!
‐1516 D3MSG_ERRREADFILE error reading file: %1!s!
‐1517 D3MSG_ERROPENFILE error reading file: %1!s!
‐1518 D3MSG_ERRCREATEFILE error creating file: %1!s!
‐1519 D3MSG_D3UNKERR error: %1!d! (code out of range)
‐1520 D3MSG_D3ERRNUM error: %1!d!
‐1521 D3MSG_D3ERRMSG error:%1!d! %2!s! %3!s!
‐1522 D3MSG_D3WRNEXIT Exiting with Warning Condition.
‐1523 D3MSG_DEBUG %1!s!
‐1524 D3MSG_D3INFEXIT Exiting with Informational Condition.
‐1525 D3MSG_D3SUCEXIT Exiting with Successful Completion.
‐1526 D3MSG_TRACE file:%1!s!, line:%2!d!, tag:%3!s!
UG1.0047.V12.3‐2A 215
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
‐1527 D3MSG_PROCACTIVE %1!s! is running, please wait...
‐1528 D3MSG_USAGE error creating file: %1!s!
‐1529 D3MSG_INIT initializing:
‐1530 D3MSG_SUCCESS normal successful completion:
‐1531 D3MT_S D3Success:
‐1532 D3MT_I D3Informative:
‐1533 D3MT_W D3Warning:
‐1534 D3MT_E D3Error:
‐1535 D3MT_F D3Fatal:
‐1536 D3MT_D D3Debug:
‐2000 ER_ETHBAD General Purpose Ethernet Error
‐2001 ER_ETH_TIMEOUT Timeout on Ethernet
‐2002 ER_COMM_SYS System Problem
‐2004 ER_ILL_SPEC Illegal Medium Was Specified
‐2005 ER_NO_WAY Path Does Not Exist
‐2006 ER_NO_MEDIA Medium Unrecognized by Driver
‐2007 ER_ALL_LINKS_DOWN No Link For Dest Node
‐2008 ER_NO_SUCH_PATH Unknown Media Was Specified
‐2009 ER_NOUCB Time out Waiting for Ethernet UCB
‐2010 ER_ADDR Enet Address Not Found in Table
‐2011 ER_LDRQ Neither Enet Addr Found in Table
‐2012 ER_NLL No Link Existed, No Reroute Possible
‐2013 ER_RCVERR Receive Status Error
‐2014 ER_STNDBY Monitor Not Running in the Target
‐2015 ER_NO_BOARD Non Existent Ethernet Board
‐2016 ER_NO_SAP No SAPs Available
‐2017 ER_ETHR_EXMIT TRANSMIT FAILURE BY BOARD
‐3000 ER_GPDE General Purpose Database Error
‐3001 ER_SCHM Database Schema Not Found
‐3002 ER_TRNS Start Transaction Error
‐3003 ER_IPNT Invalid Point Name
‐3004 ER_RBCK Rollback Error
‐3005 ER_CMMT Commit Error
UG1.0047.V12.3‐2A 216
Administratorʹs User Guide
Error
Number Error Symbol Brief Description
‐3006 ER_PNNF Point Name Not Found
‐3007 ER_IINT Invalid Interval
‐3008 ER_ISMP Invalid Number of Samples
‐3009 ER_ITIM Invalid Time
‐3010 ER_IELE Invalid Element Size
‐3011 ER_NCHE No Cache
‐3012 ER_PNNC Point Name not Cached
UG1.0047.V12.3‐2A 217
Administratorʹs User Guide
C
Canceling the OU Procedure 187
Index CDCM Post‐Installation Steps 148
CDCM software 8
A CDCM Upgrade Options 117
CDCM‐Additional Prerequisites 123
Access Network Settings File 120
Close Out Online Upgrade 183
Acquiring the Legacy Application Files 128
Concluding an Online Upgrade 182
Activating the D/3® 12.3 Installation
Procedure 140 Configure D/3 Node Manager 69
Activating the D/3® Uninstallation Procedure Configure D3_Servers 66
137 Configure Node Manager Service 170
Activating the Online Upgrade Procedure 110 Configure the Data Historian Server 67
Additional Modicon, Quantum, ASi, 505 and Configure the Data Historian Serverʹs TCP/IP
GPX I/O Issues 103 address 68
Additional Verification Actions 132 Configuring the IP Address 151
Administrator Privileges 106 Configuring the Replacement CDCM on the
Annunciator Panel Buttons 105 Network 149
Apply D/3® Software Updates 144 Console Node Software 9
Archiving Legacy Databases 130 Continuous Database 102
Archiving Legacy Files 126 Converting Database Text Files on the CDCM
161
Archiving Legacy Files‐Location of additional
files and utilities 126 Converting the Configuration Table to V12.3
150
Archiving the Legacy Application Files 129
Copy Options for Legacy Applications and
Automated D/3® Uninstallation 136 Settings 118
Automated Preparation for PCM Online Copy Required D/3 Notebook Notes 73
Upgrade 173
Create Initial CDCM Faceplate groups 72
B Create Initial CDCM Settings file 70
Custom DCM Tasks 105
Backing Out of an Online Upgrade 112
Custom PCM Tasks 105
Before installing a D/3 patch: 89
Building New Databases on the CDCM 165 D
D/3 DCS Security 74
UG1.0047.V12.3‐2A 218
Administratorʹs User Guide
D/3 Directories 23 Establish Console Passwords 169
D/3 Directory Structure 23
F
D/3 License Files 12
D/3 Licensing 11 File Versioning 36
D/3 Tools 34 FlexBatch™ 105, 108
D/3® Installation Preparation Instructions 141 Frequently Asked Questions 17
Data Collector Software 10 H
Data Historian Software 10
Hardware ROM Revision Table 42
DCM Display Groups 105
Historian Software Installation on non‐D/3
DCM Post Installation Steps 148 node 80
DCM Software 8 Historian Software Installation Procedure 80
DCM Software Installation Procedure 79 Host Files 79
DCM Upgrade 172
I
DCM Verification 124
DCM, CDCM and Data Historian Operating ICS 3‐304.81 Safety Recommendations 2
System Settings 43 Install License Dongle 145
Deleting Unwanted Files 106 Installation and Setup 41
Demo Mode 107 Installation Overview 119
Determining the Required Products for a Installing D/3 Licenses 43
Node 8
Installing D/3 Patches 89
Determining Which Nodes Require an
Installation 6 Installing the D/3 System Software on
Windows Server 2003 and XP
Directives de Sécurité 2 Professional Editions 51
Disconnect Legacy CDCM 171 Intended Audience 1
Disconnect This CDCM 135
L
Disk Image of CDCM 106
Distribute Changes to Network Configuration License Installation 145
183
License Types 17
E Licenses 107
Locating the Windows folder 129
Environment Variables 38
Location of OU Components 128
Error Message Reference 193
Location of Setup and OUInstallProc Logs 188
Error Messages 193
UG1.0047.V12.3‐2A 219
Administratorʹs User Guide
M Upgrading PCM I/O PROMs 107
Upgrading PCM Sboot PROMs 107
Material Prerequisites to an Online Upgrade
119 Operating System Upgrade 125
Modifying D/3 System Software on Windows Operational Prerequisites to an Online
Server 2003 and Windows XP Upgrade 123
Professional Editions 80 Other PCM Databases 104
N Other Products 10
Overview 6, 11, 91
Naming the Nodes 7
Networking Issues 108 P
Notification de Sécurité 2 PCM Verification 124
O Performing a PCM Online Upgrade 176
Post D/3 Installation Steps 146
OLU Install Procedure States Diagram 110
Post Installation Procedures 63
Online Upgrade
Pre Installation Guidelines 106
Suspending an Online Upgrade 109
Pre Online Upgrade Checklist 94
Online Upgrades 91
Preface 1
Automated Preparation for PCM Online
Upgrade 172, 173 Pre‐Installation Guidelines 5
Backing Out 91, 112 Pre‐Installation of Legacy Files 134
Building New Databases on the CDCM 165 Preparing the Legacy System 101
Concluding 91, 182 Purpose of this Manual 1
Configuring the Replacement CDCM on the R
Network 149
Demo Mode 107 Rebuild D/3® Applications‐D/3 Architect™
Actions 166
Material Prerequisites 91, 119
Rebuild D/3® Applications‐Instructions 165
Operational Prerequisites 91, 123
Rebuilding I/O Configurations on the CDCM
PCM Online Upgrade 176 164
Pre Installation Guidelines 106 Recommandations de Sécurité ICS 3‐304.81 3
Starting 91, 113 Recreate User Accounts and Settings 184
System Requirements 107 Related Documentation 2
Troubleshooting 187 Rename Console Password File 169
Uninstalling 91, 185
UG1.0047.V12.3‐2A 220
Administratorʹs User Guide
Renaming the PC to the Previous CDCM The D3SSDB Directory Tree 33
name 157
The D3Uninstall Directory Tree 34
Resuming Online Upgrade Procedure 143
The D3Update Directory Tree 34
Resuming the Online Upgrade Procedure 139
The TotalVision® Registry Servers 76
Resuming the Previous In‐Progress Online
To assign the ʺManage auditing and security
Upgrade 159
logʺ privilege to a Group: 75
S To Install a D/3 patch: 89
To install D/3 V12.3 system software: 52
SABL Programs 104
To Uninstall a D/3 patch: 90
Safety Guidelines 2
TotalVision® Graphics 105
Safety Notice 2
Troubleshooting 187
Selecting OLU Options 116
Set up existing user accounts 64 U
Setting the MAC address in WinCod 156
Uninstalling D/3 Software 84
Setup Actions 115
Uninstalling the Online Upgrade Procedure
Setup Instructions 114 185
Shortcut Folder Location 127 Upgraded D/3® Startup Preparation 167
SimSuite Pro 105 Upgrading a CDCM vs. Replacing a CDCM
117
SimSuite Pro® 108
Upgrading PCM I/O PROMs 107
Start D/3 70
Upgrading PCM Sboot PROMs 107
Starting the D/3® 163
Using Active Directory Accounts 66
Starting the Online Upgrade 113
Structure of this Document 1 V
Suspending an Online Upgrade 109
Verify Operational Prerequisites 124
System Functionality During an Online
Upgrade 108 Verifying System Prerequisites 121
System Messages 188 Viewing D/3 License Information 16
System Reboot 63
System Requirements 41, 107
The D3App Directory Tree 24
The D3Bin Directory Tree 32
UG1.0047.V12.3‐2A 221