Documente Academic
Documente Profesional
Documente Cultură
Symphony Plus
NOTICE
This document contains information about one or more ABB products and may include a
description of or a reference to one or more standards that may be generally relevant to
the ABB products. The presence of any such description of a standard or reference to a
standard is not a representation that all of the ABB products referenced in this document
support all of the features of the described or referenced standard. In order to determine
the specific features supported by a particular ABB product, the reader should consult the
product specifications for the particular ABB product.
ABB may have one or more patents or pending patent applications protecting the intellectual
property in the ABB products described in this document.
The information in this document is subject to change without notice and should not be
construed as a commitment by ABB. ABB assumes no responsibility for any errors that
may appear in this document.
In no event shall ABB be liable for direct, indirect, special, incidental or consequential
damages of any nature or kind arising from the use of this document, nor shall ABB be
liable for incidental or consequential damages arising from use of any software or hardware
described in this document.
This document and parts thereof must not be reproduced or copied without written permission
from ABB, and the contents thereof must not be imparted to a third party nor used
for any unauthorized purpose.
The software or hardware described in this document is furnished under a license and
may be used, copied, or disclosed only in accordance with the terms of such license. This
product meets the requirements specified in EMC Directive 2004/108/EEC and in Low
Voltage Directive 2006/95/EEC.
TRADEMARKS
All rights to copyrights, registered trademarks, and trademarks reside with their respective
owners.
Copyright 2011 ABB.
All rights reserved.
Release:
Document number:
April 2011
2VAA000812R0001
TABLE OF CONTENTS - i
TABLE OF CONTENTS
About This Book ......................................................................................................1
General ..................................................................................................................1
Document Conventions .......................................................................................1
Information and Tip Icons....................................................................................1
1. Introduction.................................................................................................... 1-1
1.1
1.2
TABLE OF CONTENTS - ii
TABLE OF CONTENTS - iv
3.12.4 Export.............................................................................................................3-48
3.12.5 Import.............................................................................................................3-48
3.12.6 Tag List Import Compatibility Issues ..............................................................3-53
3.12.7 Print................................................................................................................3-54
3.12.8 Properties.......................................................................................................3-54
3.13 Configuration Server.........................................................................................3-54
3.13.1 Create ............................................................................................................3-55
3.13.2 Properties.......................................................................................................3-55
3.14 Common Editing Functions .............................................................................3-55
3.14.1 Change Address ............................................................................................3-55
3.14.2 Create an Entity .............................................................................................3-55
3.14.3 Copy...............................................................................................................3-56
3.14.4 Delete.............................................................................................................3-56
3.14.5 Double-Click...................................................................................................3-56
3.14.6 Import a Document ........................................................................................3-56
3.14.7 Move ..............................................................................................................3-57
3.14.8 Rename .........................................................................................................3-57
3.14.9 Tag Synchronize ............................................................................................3-57
3.14.10Transfer Tags and Specifications..................................................................3-57
3.14.11View Configuration........................................................................................3-61
3.14.12View Properties.............................................................................................3-63
3.14.13Verify.............................................................................................................3-64
TABLE OF CONTENTS - v
4.13
4.14
4.15
4.16
4.17
4.18
4.19
4.20
4.21
4.22
4.23
4.24
4.25
4.26
4.27
4.28
4.29
TABLE OF CONTENTS - vi
TABLE OF CONTENTS - i
LIST OF TABLES
Table 1-1
Table 3-1
Table 3-2
Table 3-3
Table 3-4
Table 3-5
Table 3-6
Table 3-7
Table 3-8
Table 3-9
Table 3-10
Table 3-11
Table 3-12
Table 3-13
Table 3-14
Table 3-15
Table 3-16
Table 3-17
Table 3-18
Table 3-19
Table 3-20
Table 4-1
Table 4-2
Table 4-3
Table 4-4
Table 4-5
Table 4-6
Table 4-7
Table 4-8
Table 4-9
Table 4-10
Table 4-11
Table 4-12
Table 4-13
Table 6-1
Table 6-2
Table 6-3
Table 6-4
Table 6-5
TABLE OF CONTENTS - ii
Table 6-6
Table 10-1
Table 11-1
Table 12-1
Table 12-2
Table 12-3
Table 12-4
Table 12-5
Table 12-6
Table 12-7
Table 12-8
Table 12-9
Preface
This instruction provides information about how to set up a project through the Composer window of the
Composer software package.
A step-by-step example project configuration is also provided.
This instruction reflects the 5.1 software system.
2VAA000812R0001
ii
2VAA000812R0001
Support Services
ABB will provide assistance in the operation and repair of its products. Requests for sales or application services
should be made to your nearest sales or service office. ABB can also provide installation,
repair and maintenance contract services.
When ordering parts, use nomenclature or part numbers and part descriptions from equipment manuals.
Parts without a description must be ordered from the nearest sales or service office. Recommended spare parts lists,
including prices are available through the nearest sales or service office.
ABB has modern training facilities available for training your personnel. On-site training is also available.
Contact your nearest ABB sales office for specific information and scheduling.
Additional copies of this instruction, or other instructions, can be obtained from the nearest ABB
sales office at a reasonable charge.
2VAA000812R0001
1-i
1-ii
2VAA000812R0001
Document Conventions
Microsoft Windows conventions are normally used for the standard presentation of material when entering text, key
sequences, prompts, messages, menu items, screen elements, etc.
Tip icon indicates advice on, for example, how to design your project or how to use a certain function
Warning icon indicates the presence of a hazard which could result in a plant shutdown.
2VAA000812R0001
2VAA000812R0001
1. Introduction
Intended User
1. Introduction
The Composer window of the Composer software application provides an interactive tool for creating, managing, and
implementing project configurations. All the components of a project are created within the Composer window. Projects are
organized into a structure that directly correlates to the actual control system.
1.1
Intended User
This documentation provides the necessary information to use the Composer software to create and configure a project
within the Composer window. It is not a tutorial for process control and assumes the reader has knowledge of graphicsbased process control systems. It is intended for personnel with human system interface and controller configuration
experience. This instruction further assumes the reader is familiar with the Windows operating system.
1.2
Definition
2VAA000812R0001
Control logic
document
(CLD)
Control logic
template
Exchange
Harmony
control unit
Human
systems
interface
Project
Sheet
1-1
1-2
1. Introduction
2VAA000812R0001
2. Description
Composer Environment
2. Description
The Composer product provides an integrated visual development environment for Symphony system configurations. The
Composer environment greatly simplifies the configuration and maintenance of Symphony systems. The following topics
describe the Composer environment, project components, and recommended procedure for developing projects.
2.1
Composer Environment
The base Composer product provides all the functionality necessary to develop and maintain control system configurations.
Contained within the Composer window are the exchange, system architecture, and output windows. Help is provided to
ensure that explanatory information is readily available.
Cut.
Copy.
Paste.
Delete.
2.2
Projects
Projects are the largest structure in a Composer control strategy architecture and typically control a whole process or at
least the major part of one. The structure of a project duplicates the actual control system architecture which greatly
simplifies control system configuration. Contained within a project is all the information needed to support the control
system. Refer to for more detailed information.
2.3
Control Networks
Control networks are communication highways by which information is passed. These networks can be used to subdivide
complex processes into smaller, more manageable groupings. Control networks are the structures that contain all the
human system interfaces, Harmony control units, and controllers. Control networks reside one level below the project in the
project architecture. Refer to Project Architecture for more detailed information.
2VAA000812R0001
2-3
2.4
2. Description
2.5
Controllers
Controllers perform the actual control functions. They are configured using control logic documents. Controllers reside one
level below the node to which they belong. Refer to Project Architecture for more detailed information.
2.6
2.7
2.8
Tag Database
During the configuration of control logic documents, tag links (connections) to various exception reporting function codes
will need to be established and tracked. These tags are entered into a system-wide database (directly or while saving
configurations and displays) which is available through the data browser. Refer to for more detailed information.
2.9
Configuration File
A configuration file is the result of compiling a controller. All the control logic documents for the controller are processed into
one file whose format is understood by the controller. This file is then downloaded to the controller for execution. Refer to
Project Architecture for more detailed information.
2.12 Displays
Displays are the configurations that control what information is presented and how it is presented by the human system
interface. Conductor VMS displays unique to a human system interface reside one level below the display group to which
they belong. Displays used throughout the whole project reside in a folder in the exchange. These displays are copied to
human system interface display groups using drag and drop or copy and paste functionality. These displays remain linked
to the original display until they are edited. Changes made to the original display are reflected in all unedited copies.
Displays reside in the right side of the system architecture window after selecting the display group to which it belongs.
Refer to Project Architecture for more detailed information.
2.13 Logs
Composer can manipulate two types of logs. A Composer event log records actions (configurable) that take place within
Composer. Conductor VMS custom logs are used by Conductor VMS human system interfaces to collect data.
The event log maintains a record of the actions that take place in Composer. The types of actions that are recorded is
configurable on an individual object basis. This log or a subset of it can be archived. A detailed filtering mechanism is
available to permit the archiving of just the required information.
Custom logs can be configured for human system interfaces to collect data. Either time or event triggering can be used for
data collection. The printing of a log can be triggered by time, event, or data collection. Custom logs reside in the right side
of the system architecture window after selecting the human system interface to which it belongs.
Refer to Logsfor more detailed information about logs.
2.14 Lists
There are six types of lists available to a project. They are:
2-4
2VAA000812R0001
2. Description
Configuration Server
Alarm comment.
Tag.
Trend.
Report point.
The engineering unit descriptor list contains a text descriptor for all the normal engineering units. The logic state descriptor
list contains a text descriptor for all the normal logic states. The alarm comments list contains a text descriptor for all the
normal alarm comments. The engineering unit descriptor, logic state descriptor, and alarm comments lists are used by tags
to describe the indicated property. If a display is configured to display the logic state of a tag, the display is referred to the
logic state descriptor list by the tag to get the actual text to display.
The tag, trend, and report point lists contain a group of tags, trends, and report points. These lists are subsets of the total
tag database that are downloaded to human system interfaces. These lists are required because a whole project may
contain more tags than one human system interface can hold. The information in these lists is used by human system
interfaces to support controller and display configurations. Tags entered into these lists receive additional properties specific
to the human system interface. Lists reside one level below the project in the project architecture. Refer to Tag
Configuration for more detailed information.
Areas.
Equipments.
Units.
Security groups.
Graphic displays.
Trend displays.
Group displays.
Historian servers.
These lists contain all the defined items of the type indicated by the name. Operate IT Process Portal tags can be
configured (through property pages) to use the items in these lists. These lists can be edited at any time. Refer to Project
Architecture for more information about these lists.
1.
2.
3.
4.
5.
6.
7.
8.
9.
10. Complete the editing of control logic documents, displays, and tag database.
2VAA000812R0001
2-5
Project Development
2. Description
11. Create the required tag, trend, and report point lists.
12. Compile each controller (creates one configuration file from the control logic documents in the
controller).
13. Download each controller. This sends the configuration file to the actual controller.
14. Export each display. This translates and transfers the display to the human system interface.
15. Execute the new configurations downloaded to the controller.
16. Test the displays as the new configuration is executed.
17. Edit the control logic documents to correct any errors found during execution.
18. Recompile the controller and download the new configuration file.
19. Edit the displays to correct any errors found during testing.
20. Export the corrected displays.
21. Execute the new configuration.
22. Monitor and tune the controller configuration to finalize the configuration.
23. Test the displays to finalize their configurations.
The project is now correct and should be saved.
2-6
2VAA000812R0001
3. Project Architecture
Projects
3. Project Architecture
The following topics describe the project structure and how to create and edit all the parts of a project.
3.1
Projects
A project is the largest grouping of information concerning the control system. The project contains a complete description
of the control system. The structure of the project is identical to that of the actual control system. Instructions on how to
create and open a project follow. The properties of a project and how to refresh the system architecture window, convert an
older project (WinTools 2.0 or previous Composer version) to a usable project, save, rename a project, and binding input
and output references to other projects (so that the project will compile without error) are also explained. How to connect the
Composer software to the run-time system, compact a project, and repair a project are detailed as well. Refer to Common
Editing Functions for information about copying, viewing the properties of, and importing a document into a project.
1.
Right click the project or part of the project containing the control logic documents that
contain input references to output references in other control logic documents in other
projects and select Run Cross Project Binder.
2.
Select the projects to bind to in the Cross Project Binder window and click Scan For Possible
Bindings.
The cross project binder tool searches the specified projects for the output references that correspond to the input
references configured in the control logic documents within the selected part of the project. Successfully matched input and
output references are listed in the Cross Project Scan Results window.
The following table lists the information presented for each successful input (open project) to output (other projects)
reference match.
2VAA000812R0001
Description
Descriptor
IRef CLD/Sheet
IRef Addr
IRef FC Num
Specs
New Specs
ORef FC Num
3-1
Compact
3. Project Architecture
Description
Unsuccessful reference matches (input with no output) are listed in the output window.
3.
NOTE: Selecting (or deselecting) an input reference of a function code that contains multiple input references causes
all the input references to be selected (or deselected). The input references are handled as a group.
4.
If desired, choose to make a new revision of all control logic documents that will be changed before
they are changed by this tool by allowing the Save All Changes to New Revision option to remain
enabled (the default condition).
5.
If desired, copy the information in this window to the output window (click Output Summary) or to a
comma-separated, value formatted file viewable in Excel (click Export to .CSV).
6.
Click Perform Changes. The control logic documents containing the input references will be opened,
the input reference spec values will be changed, and the control logic document will be saved and
closed. After all input references are bound to the appropriate external output references, this project
will compile successfully.
NOTE: Cross reference reports and binding logs will always report internal input reference to external output reference bindings unconnected. This compiler will also generate XRef Unconnected warnings for bindings updated by
this tool. It is up to the user to confirm that these bindings are actually connected.
3.1.3 Compact
NOTE: If projects are prelaunched on one or more client computers, these must be shut down before the Compact
function can get exclusive access to the database (and perform its function). To shut down a prelaunched project,
select the objects for the project on the History tab of the Prelaunch Configuration Utility and click Shutdown Selected
Object. After the compact is complete, go to the Project tab and click Launch Objects Now, or reboot the computer.
To reduce the amount of memory space a project requires:
1.
2.
3.
Click Yes in the dialog box to confirm that the current project is to be closed.
3.1.4 Convert
To convert a WinTools 2.0 or previous Composer version project file into a Composer 5.1 project:
3-2
1.
2.
If a project is currently opened, select Yes in the dialog box to confirm the closing of the currently
opened project.
3.
Enter the project file name and location. Wintools project files have a .PRJ extension while
Composer project files have a .EBP extension.
4.
5.
2VAA000812R0001
3. Project Architecture
6.
Create
Select the project parts (tags, configuration logic, HSI displays) that are to be converted in the project
convert dialog box.
NOTE: All the parts of a previous version Composer project are converted no matter what project parts are selected
for conversion.
7.
If converting a Wintools project, select the traits (limits, attributes, etc.) that the converted project
should have by selecting the type of workstation (console) that has the desired traits in the Context
(Wintools Source Only) field.
8.
If the default regional setting of the workstation is set to one of the English options, proceed to Step
Step 14.
9.
Click Advanced<<<.
10. Verify the original project language and operating system are configured correctly. If not, select the
appropriate language and operating system from the list provided.
11. Set the log operating parameters to the desired condition (enabled or disabled).
12. If the log operating parameters are enabled, verify the current maximum log size and log space
usage warning level are correct. If necessary, edit the values.
13. Verify the current log administrator is correct or specify a new one.
14. Click OK.
15. Monitor progress of the conversion by viewing the messages being logged to the Convert tab of the
output window.
16. Execute the CLD Connection Check function on all control logic documents in the project to ensure
that there are no unrecognized signal to function code connector conditions. Refer to Check Signal
Connections for more information.
When the conversion is complete, the converted project is opened automatically. It may take significantly longer to convert
Wintools projects compared to Composer projects.
3.1.5 Create
To create a project:
1.
2.
3.
4.
Select the traits (limits, attributes, etc.) that the project should have by selecting the type of
workstation (console) that has the desired traits in the Context (Wintools Source Only) field.
5.
Click Advanced.
6.
7.
If the logging if project messages was enabled, enter the maximum size (in megabytes) of the log
and the amount of memory space used by the log (in percent) before a warning message is
generated.
8.
Click OK.
9.
If the destination does not exist, select OK when prompted to create the specified directory.
3.1.6 Open
To open a project:
1.
2.
Specify the project name in the standard Windows open dialog box.
3.
If another project is currently opened, select Yes in the dialog box to confirm the closing of the
currently opened project.
NOTE: Each Composer application can have only one project open at a time.
4.
2VAA000812R0001
Click OK.
3-3
Properties
3. Project Architecture
3.1.7 Properties
The properties of a project include:
Name.
Location.
Size (total).
Status.
Date created.
Project language.
To view or edit the properties of a project, refer to Common Editing Functions for more information.
3.1.8 Refresh
The system architecture of a project shown in a Composer window is automatically kept up to date with all changes made in
that window. However, changes made to the same project in another Composer window (multiple users) are not
automatically sent to other windows having this project opened. In this case, manually refresh the project to ensure it
accurately reflects the current condition of the project. To refresh the system architecture listing:
1.
1.
In the system architecture window, right click the project, control network, list, human
system interface, display group, display, Harmony control unit, or controller.
2.
Select Refresh.
3.1.9 Repair
In some cases (a power outage occurs while the project is open for example), a project may become unusable or the data
may be corrupted. Use the repair function to repair the integrity of the project database.
NOTE: If projects are prelaunched on one or more client computers, these must be shut down before the Repair
function can get exclusive access to the database (and perform its function). To shut down a prelaunched project,
select the objects for the project on the History tab of the Prelaunch Configuration Utility and click Shutdown Selected
Object. After the repair is complete, go to the Project tab and click Launch Objects Now, or reboot the computer.
To repair a possibly corrupt project:
1.
2.
3.
Click Yes in the dialog box to confirm that the current project is to be closed.
Connect.
Disconnect.
Configure.
Restart.
Prompt on connect.
NOTE: The connect, disconnect, restart, and configure run-time functions are also available from within the Configuration Viewer window.
3-4
2VAA000812R0001
3. Project Architecture
Save As
3.1.10.1 Connect
To connect the Composer window to the run-time system (through the Composer server):
1.
2.
Select the logical computer interface module to be used from the list provided in the select logical ICI
dialog box.
3.
Click OK.
The status shown in the lower right corner of the window will change from Not Connected to Connected when a complete
connection to the run-time system has been made. The information transferred across this connection is module status,
module state, etc.
3.1.10.2 Disconnect
To disconnect the Composer window from the Composer server (and the run-time system), select Run-Time > Disconnect.
The connection status in the lower right corner of the window will change to Not Connected when this operation is complete.
3.1.10.3 Configure
The first run-time task that must be done is telling the client Composer window which path to use when connecting to the
Composer server application. This server is in turn connected to the run-time system through a computer interface module.
To configure a Composer client for run-time operation select Run-Time > Configure. This will launch the Harmony System
Configuration tool, hSysCfg. See Section 13, ICI to Computer Interface Setup for information on configuring the connection
to an ICI module (ICI, IET, NCC).
3.1.10.4 Restart
To restart the computer interface module used by the Composer server in the path (logical ICI) selected during the
connection process, select Run-Time > Restart.
3.1.11 Save As
To save a copy of the opened project with a new name:
3.2
1.
2.
Select the location and name for the new project and click Save.
Exchange
The exchange contains folders that contain function codes, human system interface displays, symbols, shapes, borders,
macros, and control logic templates that are used to create control logic documents and human system interface displays.
These items can be copied to a control logic document or display by dragging and dropping the item. There are two types of
folders on the exchange. System folders contain ABB-provided items. User folders contain items stored by the user. These
items can be user-created shapes, macros, control logic templates, etc. as well as shortcuts. Shortcuts are links to items
residing in other folders. Explanations on how to open, create, and put shortcuts into an exchange folder follow. The
properties an exchange folder has are also described. Refer to Common Editing Functions for information about copying,
deleting, moving, viewing properties of, and renaming exchange folders.
3.2.1 Create
To add a new user exchange folder to the exchange or another user exchange folder:
1.
Select the root exchange folder or open the folder that will contain the new folder.
2.
Right click the empty space in the exchange window and select New > Folder.
3.2.2 Open
To open an exchange folder:
1.
2VAA000812R0001
Select the exchange folder to be opened in the field above the exchange contents listing
area.
3-5
Properties
3. Project Architecture
- or 1.
3.2.3 Properties
The properties of an exchange folder are:
Name.
Type.
Location.
Project name.
Status.
To view or edit the properties of an exchange folder, refer to Common Editing Functions for more information.
3.2.4 Shortcuts
A link to an item located in another folder can be added to an exchange folder using the shortcut functionality. Renaming a
shortcut will rename the source document residing on the exchange which causes all other shortcuts to the same document
to change to the new name.
To add a shortcut to a folder:
3.3
1.
2.
Right click in the folder and select New > Shortcut. The select objects for shortcut dialog box
appears.
3.
Select the exchange folder containing the original item sourcing the shortcut.
4.
5.
Click OK.
Control Networks
Control networks are the parts of a project that contain human system interfaces, Harmony control units, and all their
component parts. Instructions on how to create and view properties of a control network follow. Refer to Common Editing
Functions for information about synchronizing the tags used by the control network components with those actually in the
tag database and how to change the address of, move, copy, delete, and rename a control network.
3.3.1 Create
To add a new control network to a project:
1.
Right click the project name and select New > Control Network....
2.
Enter the control network name (64 characters maximum) and address (numbers 1 through 250) in
the dialog box and click OK.
3.3.2 Properties
The properties of a control network include:
Name.
Type.
Location.
Project name.
Status.
To view or edit the properties of a control network, refer to Common Editing Functions for more information.
3.4
3-6
2VAA000812R0001
3. Project Architecture
Create
are also described. Refer to Common Editing Functions for information about copying, deleting, importing a document
into, viewing the properties of, changing the address, inspecting, synchronizing the tags of, and renaming a Harmony
control unit.
3.4.1 Create
To add a new Harmony control unit to the control network:
1.
Right click the control network and select New > Control Unit....
2.
Enter the Harmony control unit name (64 characters maximum) and address (numbers 1 through 31)
in the dialog box and click OK.
3.4.2 Properties
The properties of a Harmony control unit include:
Name.
Type.
Location.
Project name.
Status.
To view or edit the properties of a Harmony control unit, refer to Common Editing Functions for more information.
3.5
Controllers
Controllers are the parts of a Harmony control unit that contain control logic. Instructions on how to create, compile, change
the operating mode of, and print a controller follow. Also explained is how to online configure, import a firmware file,
download a firmware file, delete a firmware file, inspect the controller, edit the C specification (CSP) file of, view a status or
problem report from the controller, and reorder the control logic documents assigned to the controller. The properties used
by a controller are also explained. Refer to Common Editing Functions for information about copying, deleting, importing
a document into, moving, viewing the properties of, changing address, verifying, viewing the function code configuration of,
synchronizing the tags of, transferring tag and specification data in or out of, and renaming a controller.
Load firmware.
Print.
Import document.
Refresh.
Rename.
Properties.
Foundation fieldbus-capable I/O devices can be used with the BRC controller. However, the fieldbus configuration of the I/O
device must be accomplished through third-party software (not supplied). The control logic configuration of the I/O device
follows the same procedures as any other Harmony I/O device.
2VAA000812R0001
3-7
Assigned Controllers
3. Project Architecture
Assigned controllers.
Compile.
Rename.
Properties.
Import document.
Tag synchronize.
Inspect.
Refresh.
Cut.
Copy.
Delete.
Rename.
Properties.
NOTE: This feature is similar to the Module Binding Log feature of WinTools.
1.
2.
Select the Composer item (project, control network, control unit, controller, or control logic document)
containing the desired output references.
NOTE: Selecting a control logic document or the controller containing the control logic document will generate the
same binding log report.
3-8
3.
4.
Select a reference timestamp in the Reference Timestamp for Last Change area of the Module
Binding Log Options window. Refer to Timestamp Options for more information.
5.
Specify the name of the output file in the Output File Name field.
6.
Enable the Send Details to Output Window option to display all the information in the output file in the
output window. If this option is disabled, only one line containing module current time and last
compile time will be displayed for each module being processed. Summary information containing a
list of all modules processed and all modules affected by cross references is also displayed.
2VAA000812R0001
3. Project Architecture
7.
Enable the Check for Unconnected IREFs in Project option to list any IREFs that do not have a
corresponding OREF defined and the source CLD sheet. If this option is disabled, only a single
warning message is displayed if one or more unconnected IREFs have been found.
8.
have been modified since the controllers (within the selected item) containing the output references
were last compiled
- and have associated input references that are located in controllers that were last compiled before the
output references were modified.
The report generated using this option can be used to determine which controllers need to be recompiled as a result of
modifying the output reference.
The last compilation date is determined by the timestamp of the current CFG file for the controller. If the controller has not
yet been compiled, the effective last compilation date is earlier than any timestamp to which it is compared.
Report All References
Selecting this option causes the binding log report to list all output references in the controllers within the selected item and
their associated input references.
1.
2.
Select Run Time > Mode and the desired mode (Configure, Execute, Restart, and Initialize).
3.5.4 Compile
To compile the configuration file for a controller:
1.
2.
If this is the first time the controller has been compiled, enter the desired configuration file name in
the dialog box and proceed to Step Step 5.
3.
Choose to overwrite the existing configuration file or create a new one in the dialog box.
2VAA000812R0001
3-9
Copy Firmware
3. Project Architecture
4.
5.
Click OK.
Text on the Compile tab in the output window will detail if the controller compiled or why it did not compile. Double-clicking
an error message opens the control logic document containing the source of the error message. This output window can be
disabled through the view menu.
1.
Right click the Harmony controller containing the firmware to be copied and select Run Time
> Harmony I/O > Copy Firmware....
2.
Enter the ID of the Harmony I/O device containing the firmware to be copied.
- or a.
b.
Click OK in the dialog box to reset the source Harmony I/O device.
c.
Visually confirm that all the source Harmony device status LEDs are flashing.
d.
Click Yes when prompted to confirm the source Harmony I/O device status LEDs are flashing.
3.
- or a.
b.
Click OK in the dialog box to reset the source Harmony I/O device.
c.
Visually confirm that all the source Harmony device status LEDs are flashing.
d.
Click Yes when prompted to confirm the source Harmony I/O device status LEDs are flashing.
4.
Click Copy.
5.
If the Harmony device controlling the Harmony I/O device receiving the firmware is in execute mode,
select Yes in the dialog box to place it in configure mode.
6.
After a firmware copy to Harmony I/O blocks, the following message may appear:
The destination block label xxxxxx has been deleted by the copy firmware operation. Would you like
to reapply the label?
It is advisable to wait five to ten seconds before confirming the reapply label dialog. If this time is not taken, in some cases
the blocks will get locked in firmware download mode, and the following message will be displayed:
3.5.6 Create
Controllers can be utilized in three ways: individually, as a part of a primary-redundant pair, and as part of a primary-backup
pair. When used individually, the role of a controller is set to Primary. A primary-redundant pair of controllers utilizes only
one HCU address and, therefore, needs only one controller defined whose role is set to Primary\Redundant. A primarybackup pair of controllers utilizes two HCU addresses and therefore needs two controllers defined. The primary controller
role is set to Primary and the backup controller role is set to Backup\Online. The HCU address of the backup controller must
be one greater than that of the primary controller.
NOTE: The primary-backup controller pair is required when the ability to perform online configuration is desired.
To add a new controller to a Harmony control unit:
3-10
1.
Right click the Harmony control unit and select New > Controller....
2.
Enter the new controller name (64 characters maximum), address (numbers 1 through 31), type, role,
firmware revision and identifier. Also specify any custom properties used by the controller.
2VAA000812R0001
3. Project Architecture
3.
Delete Firmware
Click OK.
1.
Right click the control network and select New > HAC....
2.
Enter the new controller name (64 characters maximum), control unit address (numbers 1 through
31), and role.
3.
Click OK.
1.
Right click the control network and select New > SEM....
2.
Enter the new controller name (64 characters maximum) and control unit address (numbers 1
through 31).
3.
Click OK.
A new Harmony control unit and sequence of events controller are created.
1.
2.
Select the firmware file to be deleted and click Delete in the dialog box.
1.
2.
Enter, edit, or verify the information in the fields described in the following table.
2VAA000812R0001
Description
Contract #
Formatted for C
Linked files
Name (file)
3-11
Format Memory
3. Project Architecture
Description
Number of checkpoint
buffers
Plant site
Program description
Size of checkpoint buffer Size (in bytes) of each checkpoint buffer. Set this value
greater than that of the largest file to be sent to a redundant
controller. Set this value to zero when no redundant controller
is used.
Size of module I/O buffer Size (in bytes) of each I/O buffer. Set the value greater than
that of the largest file accessed during file transfers.
Stack size
3.
4.
Click Save.
1.
Right click the controller and select Run Time > Properties.
2.
Select the specifications source (default, manual, or CSP file) on the format tab in the properties
dialog box.
3.
Edit the format specifications (number of files, NVRAM for C, and RAM for C) if the manual
specification source was selected.
4.
Click Format.
1.
2.
Enter or select the firmware file name to import and click Next in the dialog box.
3.
Verify the name, location, type, and revision of the selected firmware is correct. If necessary, click
Back and select the correct firmware.
4.
Click Finish.
3.5.11 Inspect
To view the address, type, firmware revision, function (text descriptor), mode, and status of controllers; right click the
Harmony control unit containing the controllers and select Inspect....
NOTE: Inspecting a Harmony control unit will show the information from all the controllers in the Harmony control
unit.
The output window will display the information about all the controllers in the Harmony control unit.
1.
3-12
Right click the controller and select Run Time > Harmony I/O > Label....
2VAA000812R0001
3. Project Architecture
2.
- or a.
Click ID.
b.
c.
Visually confirm that all the source Harmony I/O device status LEDs are flashing.
d.
Click Yes when prompted to confirm the source Harmony I/O device status LEDs are flashing.
3.
Enter the desired label in the set harmony device label dialog box. It is also possible to select a label
used in the configuration file, control logic, or controller.
4.
5.
NOTE: If a block has a software error (error code indicated by LEDs # 2 and #4 being lit), Composer operations to the
block (such as labeling it) may cause Composer to go into a busy state. If this happens, Composer must be terminated via task manager, the software error on the block must be corrected, Composer must be restarted, and then
the operation must be performed again.
1.
Right click the controller and select Runtime > View Files.
2.
Right click in the View Files window and select Load C or Load Data.
3.
1.
Right click the device and select Run Time > Harmony I/O > Load Firmware....
2.
- or a.
Click ID.
b.
Click OK in the dialog box to reset the target Harmony I/O device.
c.
Visually confirm that all the target Harmony device status LEDs are flashing.
d.
Click Yes when prompted to confirm the target Harmony device status LEDs are flashing.
3.
Select the desired firmware file from the list of imported firmware files in the dialog box.
4.
Click Download.
NOTE: Do not abort or cancel the download operation after the Download button is selected.
5.
If the Harmony device controlling the Harmony I/O device was in execute mode, select Yes in the
dialog box to place it in configure mode.
6.
To load a controller firmware file from the Composer project to a Harmony controller:
1.
Right click the controller and select Run Time > Load Firmware....
2.
Select the desired firmware file from the list of imported firmware files and click Download in the
dialog box.
It is not possible to download firmware to a module via a CPM02 or an IPT01 due to limitations in those modules.
After completing a controller firmware download, it may be necessary to close and reopen Composer to perform additional
controller firmware downloads.
2VAA000812R0001
3-13
Online Configuration
3. Project Architecture
NOTES:
1. The term primary-backup controller pair specifically refers to controller modules having addresses n and n+1
and having the ability to be configured online. Refer to the specific controller module instruction for more information.
2. During online configuration, the primary-backup controller pair may contain two configurations: the original configuration refers to the configuration residing in the primary-backup controller pair before entering online configuration; the new or test configuration refers to any modifications to the original or any other configuration downloaded
to the primary-backup controller pair.
3. During online configuration, the functional role of the physical controllers comprising the primary-backup pair may
switch. The controller at address n is always controlling the process. Upon exiting from online configuration, the roles
and addresses of the physical controllers may be reversed from that when online configuration was entered. This
depends on the actual steps performed during online configuration.
4. Throughout the online configuration process it is the responsibility of the user to correctly make the online configuration changes and wait for the proper controller conditions to be established before each mode change. Incorrect
use can still result in an error in the primary controller that is in control of the process. Refer to the controller module
instruction for detailed sequencing and status information.
5. Online configuration restrictions do not allow the following:
a. Deleting existing function codes. (Permitted in HAC controllers.)
b. Modifying specifications that would increase a function code block memory
utilization.
c. Adding function code blocks within already used block space within the control segments of the controller. Blocks
can only be added following the last block used within a segment. (Permitted in HAC controllers.).
6. If a backup controller fails (halts, losses communication, etc.) during an online configuration operation, the online
configuration operation halts and displays a message stating that online configuration cannot continue until the hardware problem is corrected.
Controllers with Enhanced Status Reporting
Controllers with enhanced status reporting capability can report their configuration complete (CFC) and checkpointing done
(CHK) status when operating on a Cnet or INFI-NET control network. These controllers can also report their function role:
primary/redundant or backup/online.
MFC controllers, pre-F.2 MFP controllers, and any controller operating on a Plant Loop control network must be physically
checked to verify these states. There are two procedures given for online configuration:
Procedure A is used for controllers having enhanced status reporting capability operating on the Cnet or INFI-NET control
network.
Procedure B is used for MFC controllers and pre-F.2 MFP controllers or any controllers operating on a Plant Loop control
network.
3.5.15.1 Procedure A
To online configure a primary-redundant controller pair having enhanced status reporting capability:
1.
Insure the primary and backup controllers have consecutive addresses (primary = n, backup
= n + 1) and both are in execute mode.
2.
Right click the primary controller and select Run Time > Online Configuration....
A dialog box appears asking for confirmation that online configuration should continue. The type, revision, mode, and
address of the primary and backup controllers are also displayed. A message states that the backup controller will be put
into configure mode if online configuration is continued.
3-14
3.
Click OK.
4.
After a short wait, the backup controller goes into configure mode.
2VAA000812R0001
3. Project Architecture
Online Configuration
A new set of buttons appears in the dialog box. These are described in the following paragraphs. The buttons are enabled
and disabled depending on valid operations at each step. Initially, only Go Back is enabled.
5.
6.
3.5.15.2 Procedure B
This procedure describes the steps required for performing online configuration of a primary-backup controller pair lacking
enhanced status reporting capability or any primary-backup controller pair operating on a Plant Loop control network.
To perform online configuration:
1.
Insure the primary and backup controllers have consecutive addresses (primary = n, backup
= n + 1) and both are in execute mode.
2.
Right click the primary controller and select Run Time > Online Configuration....
A dialog box appears asking for confirmation that online configuration should continue. The type, revision, mode, and
address of the primary and backup controllers are also displayed. A message states that the backup controller will be put
into configure mode if online configuration is continued.
3.
Click OK.
4.
After a short wait, the backup controller goes into configure mode.
A new set of buttons appears in the dialog box. These are described in the following paragraphs. The buttons are enabled
and disabled depending on valid operations at each step. Initially, only Go Back is enabled.
5.
6.
2VAA000812R0001
3-15
3. Project Architecture
NOTE: To avoid this issue, the user should not select the test button until the download has completed.
3.5.16 Print
To print a copy of all the control logic documents located in a controller:
1.
3-16
2VAA000812R0001
3. Project Architecture
Properties
2.
Select the sheets to be printed (All, Range, or None (Cross-Reference Report Only)). The default To
field value is 99 when multiple CLDs are being printed. If this field is set to a value greater than the
number of sheets in a CLD being printed, all the sheets will be printed.
3.
Select the print quality, number of copies, destination (printer or file), number of copies, and if the
copies are to be collated.
4.
Select what is to be done with the cross reference report generated by the print operation. Exporting
it to a text file or printing it along with the control logic documents are the available options.
5.
Click Setup... to get to a standard Windows print setup dialog box. Configure the options as
necessary.
6.
Click Style... to configure how the control logic document is to be printed. The style setup dialog box
appears.
7.
On the entries tab of the style setup dialog box, select the specifications, tags, symbols, and cross
references to be printed.
8.
9.
On the Layout tab, set the margins, alignment, and scale of the control logic document.
10. On the Header/Footer tab, configure the header and footer using the codes provided.
11. Click OK.
3.5.17 Properties
The properties of a controller include:
Name.
Type.
Location.
Project name.
Configuration status.
Controller number.
Defined controller type, firmware level and status (only if connected to a run-time system).
Actual controller type, firmware level and status (only if connected to a run-time system).
Format.
To view or edit the properties of a controller, refer to Common Editing Functions for more information.
1.
Select the controller containing the control logic documents being reordered.
2.
3.
Drag one of the selected control logic documents until the cursor is on the control logic document just
below the new location and release the mouse button.
Select control logic documents that are not consecutive are extracted, placed in a sequential order, and inserted at the
specified location.
2VAA000812R0001
3-17
View Files
3. Project Architecture
NOTE: Most C programs developed for MFC and MFP controllers utilized version 4.5 or earlier of the Microtec compiler. Compiler version 5.0 and later treat the physical layout of structures (struct keyword) differently than the earlier
versions. C structures that define external interfaces (communication programs for example) that implement fixed
mapping to external devices must be reverified. Use the packed keyword and pad bytes within the structure to return
the original interface mapping. The n90.h file is an example of this.
The following CUP features are not supported:
The recompiling and relinking of C programs using the Lattice ES68 Development Systems. However, existing Lattice Program
LMS object files and NBS binary files can be loaded/reloaded into IMMFPxx controllers by Composer.
Separately purchase and install the appropriate Microtec C compiler (from Mentor
Graphics).
NOTE: Composer has been updated to support the BRC-300 controller which has the Coldfire processor. Previous
controllers utilized 68000-based processors. Use version 5.3 of the Coldfire compiler when BRC-300 controllers are
being utilized. Use version 5.1 of the 68000 compiler when previous controllers are being utilized.
When the compiler is installed, it sets up several environment variables and modifies the system path. This can be verified
from a DOS prompt using the SET command.
The following is a sample of what will typically be seen. If a different installation location is selected, the output will be
different from this sample. The important part is to verify that the entries exist and then match the installation choice.
LM_LICENSE_FILE=d:\mgc\embedded\license\license.dat
MRI_68K_BIN=d:\microtec\tools\bin
MRI_68K_INC=d:\Progra~1\ABB\Composer\Bin\Cup\include\
MRI_68K_LIB=d:\microtec\tools\lib\nze
MRI_CF_BIN=d:\mgc:\embedded\bin\
MRI_CF_INC=d:\Progra~1\ABB\Composer\Bin\Cup\include\
Path=C:\WINNT\system32;C:\WINNT;c:\ORANT\BIN;;
C:\EWS;d:\microtec\tools\bin;
NOTE: Environment variable MRI_68K_LIB is only required for IMMFC03 controllers. MRI_CF_BIN and
MRI_CF_INC are only required for BRC-300 controllers. MRI_CF_LIB is not required and should be left undefined.
3-18
2VAA000812R0001
3. Project Architecture
2.
Write the C program outside of Composer. To compile, use MCC.BAT (for all controllers prior to BRC300) or MCC_CF.BAT (for BRC-300 controllers) from a command prompt. These files invoke the
appropriate compiler with the correct option settings.
3.
Within the system architecture window of Composers primary interface, right click on the target
controller to display the controller pop-up menu and select Edit CSP file.
4.
Enter the CSP file data and save the .CSP file to disk. Each controller running C should have its own
.CSP associated with it. Composer does not manage .CSP files. It merely maintains a link to the
.CSP file associated with each controller.
5.
Stay in the .CSP file editor. After saving the .CSP file, link the .CSP file to produce the .LMS and
.MAP files that will eventually be loaded to the controller.
NOTE: Always verify (in the Edit CSP view) that the list of files to be linked is correct BEFORE linking. Delete any
incorrect or unrelated entries.
6.
Close the .CSP file editor. This associates the .CSP file name with the controller.
7.
From the controllers pop-up menu, select Properties > Format > Specification Source > CSP File
8.
The .CSP file name previously associated with the controller should already be in the edit control. If it
isn't, browse to the .CSP file and click OK.
9.
Click Format.
NOTE: The controller must be in CONFIGURE mode before its memory can be formatted. If the controller is in EXECUTE mode when Format is selected, confirm the mode change to CONFIGURE prior to the format operation. Be
certain that the process is in a safe state that will allow the controller to be taken offline.
10. A confirmation dialog will appear indicating that the controller was successfully formatted. Close the
property sheet.
11. From the controllers pop-up menu, select Run Time-View Files.
12. A new window containing all the files loaded in the controller will appear. An empty list view indicates
that no files have been loaded to the controller. In either case, right click on the background of the list
view and select the Load C menu item.
13. A file selection dialog will appear. Browse to the directory containing the .CSP file associated with the
controller.
14. Select the .MAP, .LMS, and .CSP files when prompted for each file.
15. Load any data files needed using the Load Data File menu item within the file directory view.
16. At this point, the controller has been formatted to run C, and all the necessary files have been loaded.
All that remains is to load the controllers function block configuration (.CFG file) and put the
controller into execute mode.
NOTE: The default Composer installation will install into C: drive, not the D: drive. If the drive or directory is changed
from the default values, modifications will have to be made to the MCC.BAT and MCL.BAT files used to invoke the
compiler and linker respectively.
3.5.21.3 MCL.BAT
LNK68K.EXE is assumed to be on the system path. If it isnt, hard code the path to the executable in the MCL.BAT file.
2VAA000812R0001
3-19
3. Project Architecture
NOTE: Fully qualified paths must be specified to the user-created object files.
The supplied files mfcmathf_fix.obj and mfpmathf_fix.obj are only required to resolve link issues when using the single
precision functions in MATHF.LIB.
When utilizing IMMFC03 controllers, use the nonexception (nze) version of the mcc68KAB.LIB file to resolve links. The
location of this library is specified by the MRI_68K_LIB environment variable.
The calculated values in the System RAM group do not automatically update when the underlying values are changed for
the calculation. To get the values to recalculate, click Apply. The calculated values will then be properly displayed.
3.6
NOTES:
1. Basic control logic documents (not created from a control logic template) use an icon with a white background.
2. Basic control logic documents that are CLD-locked use a key icon with a white background.
3. Control logic documents created from a template but are not linked use an icon with a blue background.
4. Control logic documents created from and linked to a template use a chain links icon with a blue background.
5. Control logic documents that are created from a template and are CLD-locked use a key icon with a blue background.
3-20
1.
Right click the control logic template and select Actions... from the pop-up menu.
2.
Select the desired view mode and establish any document filters in the control logic template actions
dialog box. The listing of control logic documents can be sorted by name, address, order number,
linked status, revision level, date last updated, and date last modified by selecting the column
heading.
2VAA000812R0001
3. Project Architecture
Create
3.
If desired, select one or more of the listed control logic documents (created from the template) and
use the link, unlink, upgrade, or branch functionality.
4.
To change the default link setting (in control logic template) for all subsequently created control logic documents:
1.
Right click the control logic template and select Properties from the pop-up menu.
2.
Enable or disable the link new CLDs on instantiation setting in the properties dialog box.
3.
Click OK.
3.6.2 Create
To create a new control logic template:
1.
Open the exchange folder that will contain the new template.
2.
Right click empty space in the exchange window and select New > Control Logic Template.
3.
4.
Specify the type (and firmware revision) of controllers that will use the control logic documents
created with this template.
5.
Set the default link status for all control logic documents created from this template.
6.
Click OK.
3.6.3 Edit
Control logic templates are created from within the Composer window but they are edited within the automation architect
window. To edit a control logic template, right click the document and select Open. The automation architect window is
opened with control logic template in a document window.
3.6.5 Properties
The properties of a control logic template include:
Name.
Type.
Location.
Project name.
Status.
Revision.
2VAA000812R0001
3-21
Restore
3. Project Architecture
To view or edit the properties of a control logic template, refer to Common Editing Functions for more information.
3.6.6 Restore
To restore an unlocked control logic document to a condition identical to that of the template used to create it:
1.
Right click the control logic document and select Template Linking from the pop-up menu.
2.
3.
Enable the appropriate conflict resolution and log options in the restore dialog box.
4.
Click Start.
3.6.7 Update
To upgrade all the unlocked control logic documents in a controller with information from the control logic template used to
create it:
1.
Right click the controller and select Upgrade All CLDs... from the pop-up menu.
2.
Enable the appropriate conflict resolution and log options in the upgrade dialog box.
3.
Click Start.
To upgrade an unlocked control logic document with information from the control logic template used to create it:
3.7
1.
Right click the control logic document and select Template Linking from the pop-up menu.
2.
3.
4.
Click Start.
NOTES:
1. Basic control logic documents (not created from a control logic template) use an icon with a white background.
2. Basic control logic documents that are CLD-locked use a key icon with a white background.
3. Control logic documents created from a template but are not linked use an icon with a blue background.
4. Control logic documents created from and linked to a template use a chain links icon with a blue background.
5. Control logic documents that are created from a template and are CLD-locked use a key icon with a blue background.
Assigned an address manually or automatically according to a predefined relative order on a sheet designated as relative.
Assigned an address manually or automatically that is subject to re-assignment according to position within the control logic document.
3-22
2VAA000812R0001
3. Project Architecture
If a function code spans multiple block addresses, the second through last block addresses are displayed in a lighter color.
This aids in determining which blocks are associated with a function code.
Three tabs are provided in the output area at the bottom of the dialog box. The operation tab lists errors, warnings, and
information messages regarding the processing of block management functions. The context tab displays the project,
control network, Harmony control unit, and controller names. Also displayed is the mapping between control logic document
name and the number displayed on the block map. The block map tab lists information related to creating the block map
table. Duplicate addresses are detected and displayed in this tab when the block map table is initially created and whenever
it is refreshed (for example, when executing a menu option).
If properly configured, changes to function block addresses are propagated back to any other function codes in any control
logic documents within the controller that references that address.
When using one of the automatic numbering functions (while preserving the relative order), function codes without function
block addresses are assigned addresses according to the following rules:
Unaddressed function codes located between (as defined by top to bottom, left to right positioning) addressed function codes are
given the next available addresses (based on their positional order) that are greater than that of the preceding function code.
Unaddressed function codes located at the beginning of a sheet (as defined by top to bottom, left to right positioning) are given the
lowest block address (based on their positional order) on the sheet.
Unaddressed function codes located at the end of a sheet (as defined by top to bottom, left to right positioning) are given the next
available addresses (based on their positional order) that are greater than that of the preceding function code.
Example:
A sheet contains nine single block output function codes. These function codes have block addresses of (listed by top to
bottom, left to right position) unassigned, 105, 100, unassigned, 120, 125, unassigned, 104, and unassigned. The automatic
renumbering of all block addresses function and a starting address of 100 are set. The resulting block addresses are 100,
105, 101, 102, 106, 107, 108, 103, and 104.
NOTES:
1. Function codes 81 (executive) and 90 (extended executive) are not affected by this utility.
2. Sheets containing the text BLK.ORDER=USER-ASSIGNED are not affected by the automatic addressing, offsetting, or clearing functions of this utility.
3. Sheets containing the text BLK.ORDER=RELATIVE are automatically addressed according to the current relative
order regardless of the order type selected.
4. Sheets containing the text BLK.ORDER=POSITION are automatically addressed according to the position
regardless of the order type selected.
5. Sheets without any BLK.ORDER= specification text are shown on the block map using the same color code as
sheets containing the text BLK.ORDER=POSITION.
1.
Select Operations > Auto Block > All except FCs with valid Block Addresses.
2.
In the Starting Block Address field, enter the desired target address for the first (lowest) readdressed
function block from the selected control logic documents.
3.
The top to bottom, left to right order option is preselected because unassigned blocks have no
previous relative order.
4.
Verify the auto blocking options are correctly set. If they are correct, proceed to Step Step 8. If not
correct, proceed to the next step.
5.
2VAA000812R0001
3-23
3. Project Architecture
6.
In the spares dialog box, set the location of spares (empty function blocks) and any special
addressing conditions (multipliers) for the first function block of each sheet and control logic
document.
7.
Click OK.
8.
Enable the using text to indicate adapted spec # option if it is desirable to automatically set
specification three of the adapt function code to the specification number indicated in a text string
within the adapt function block or at the end of the tuning line. Only use this option if this convention
is being used because it increases the time required to process the function blocks.
9.
Click OK.
1.
2.
Verify the information in the standard Windows print dialog box is correct and click OK.
1.
Select the portion of the block map table containing the desired function blocks.
2.
3.
Verify the information in the standard Windows print dialog box is correct and click OK.
3-24
1.
2.
In the Starting Block Address field, enter the desired target address of the first (lowest) re-addressed
function block from the selected control logic documents.
3.
Enter the type of order to be used when giving new addresses. The top to bottom, left to right option
is a positional order in which the top left most function code will receive the lowest function block
address and (working down and to the left) the bottom right most function code will receive the
highest block number. The follow existing relative order on drawings option maintains the existing
relative order between function codes while readdressing.
4.
Verify the auto blocking options are correctly set. If they are correct, proceed to Step Step 9. If not
correct, proceed to the next step.
5.
6.
In the spares dialog box, set the location of spares (empty function blocks) and any special
addressing conditions (multipliers) for the first function block of each sheet and control logic
document.
7.
Click OK.
8.
Enable the using text to indicate adapted spec # option if it is desirable to automatically set
specification three of the adapt function code to the specification number indicated in a text string
within the adapt function block or at the end of the tuning line. Only use this option if this convention
is being used because it increases the time required to process the function blocks.
9.
Click OK.
2VAA000812R0001
3. Project Architecture
Description
30
45
48
62
67
68
80
123
129
136
151
177
179
194
211
218
222
223
224
225
229
Pulse/in channel
Example:
A selected control logic document contains five function codes (FC 35, FC 45, FC 39, FC 38, and FC 39) with block
addresses of 500, 200, unassigned, 510, and 508 respectively. A starting block address of 300 and the relative order option
are set. The resulting block addresses would be 300, 200, 301, 303, and 302 respectively.
To give all function codes new function block addresses:
1.
Select Operations > Auto Block > All except existing Exception Report Blocks.
2.
In the Starting Block Address field, enter the desired target address of the first (lowest) readdressed
function block from the selected control logic documents.
3.
Enter the type of order to be used when giving new addresses. The top to bottom, left to right option
is a positional order in which the top left-most function code will receive the lowest function block
address and (working down and to the left) the bottom right-most function code will receive the
highest block number. The follow existing relative order on drawings option maintains the existing
relative order between function codes while readdressing.
4.
Verify the auto blocking options are correctly set. If they are correct, proceed to Step Step 9. If not
correct, proceed to the next step.
5.
2VAA000812R0001
3-25
3. Project Architecture
6.
In the spares dialog box, set the location of spares (empty function blocks) and any special
addressing conditions (multipliers) for the first function block of each sheet and control logic
document.
7.
Click OK.
8.
Enable the using text to indicate adapted spec # option if it is desirable to automatically set
specification three of the adapt function code to the specification number indicated in a text string
within the adapt function block or at the end of the tuning line. Only use this option if this convention
is being used because it increases the time required to process the function blocks.
9.
Click OK.
1.
2.
In the offset options dialog box, enter the function block address from which the offset function will
start in the Start Offset at Block Address field. This field is defaulted to the lowest block address found
in the selected control logic documents.
3.
Choose to offset the block addresses by adding a certain number of block addresses or by specifying
the address of the new first function block. All subsequent function block addresses are changed by
the same value as that used when offsetting the first function block.
4.
Click OK.
1.
2.
Confirm if sheets containing the text BLK.ORDER=RELATIVE are to be cleared and click OK in the
dialog box.
NOTES:
1. This function will remove all concepts of relative order from the control logic document.
2. The specifications of other function codes that refer to a cleared function block number are set to their default
value.
3-26
1.
Double click the warning. This opens the control logic document and properly interconnects
the signal and connector.
2.
Verify the connections are correct and save the control logic document.
2VAA000812R0001
3. Project Architecture
Create
It is recommended to perform this function on individual or small groups of control logic documents because checking for
these conditions make take a long period of time.
3.7.3 Create
To create a new (empty or base) control logic document that can not be associated with a control logic template:
1.
Right click the controller and select New > Logic Document....
2.
Enter the new control logic document name in the dialog box and click OK.
NOTE: Using the following special characters in CLD names may cause errors (pack and/or unpack) when publishing
them for View and Monitor sites:
/ (forward slash)
\ (back slash)
(double quotes)
* (asterisk)
@ (at sign)
- (hyphen)
| (pipe)
: (colon)
< (less than)
> (greater than)
? (question mark)
To create a new control logic document using a control logic template:
1.
2.
Drag the control logic template from the exchange window and drop it on the controller that will
contain the new control logic document.
A control logic document with the same name as the control logic template appears in the right side of the system
architecture window.
3.7.4 Edit
Control logic documents are created from within the Composer window but they are edited within the automation architect
window. To edit a control logic document, right click the document and select Open. The automation architect window is
opened with control logic document in a document window.
3.7.5 Export
Logic entity information from control logic documents within the selected Composer entity (project, control network,
Harmony control unit, controller, or control logic document) can be exported to a database outside of the Composer project.
The types of logic entities that can be exported are function codes, constant blocks, text, input references, and output
references. Tag and function code information can also be exported in a comma separated value text format.
2VAA000812R0001
Type
Description
BlkNum
CLDguid
Text
CLDname
Text
FCDesc
Text
FCName
Text
Entity name.
FCNum
Layer
ObjID
SheetNum
Export
3. Project Architecture
Type
Description
Spec 1 through
60
StringSpec1 &
StringSpec2
Text
TagGuid
Text
TagName
Text
Xcoord
Ycoord
Type
Description
BlkNum
CLDguid
Text
CLDname
Text
Layer
Name
Text
ObjID
SheetNum
Xcoord
Ycoord
Entity name.
3-28
Type
Description
CharSize
CLDguid
Text
CLDname
Text
Layer
ObjID
Orientation
SheetNum
TextName
Text
Entity name.
TextValue
Text
Text value.
2VAA000812R0001
3. Project Architecture
Export
Type
Description
Xcoord
Ycoord
Type
Description
CLDguid
Text
CLDname
Text
FCNum
I/Onum
Layer
Name
Text
ObjID
RefEntity
SheetNum
XRefGuid
Text
Xcoord
XRefDesc
Text
Ycoord
Entity name.
Cross-reference description.
2VAA000812R0001
Type
Description
CLDguid
Text
CLDname
Text
Layer
Name
Text
ObjID
RefEntity
Number Address value referencing the logic entity sourcing the input
to this entity.
SheetNum
XRefDesc
Text
Cross-reference description.
XRefGuid
Text
Entity name.
3-29
Export
3. Project Architecture
Type
Description
Xcoord
Ycoord
Type
Description
Block
CLDFilename
Text
CLDname
Text
FCName
Text
FCNum
Loop
Module
PCU
SheetNum
Spec 1 through
60
Text
TagDesc
Text
TagName
Text
1.
Select the Composer entity containing the control logic document (or control logic template)
that contains the logic entity information in the Composer window.
2.
3.
Select the type of database that will receive the exported information in the DB Type field.
4.
Accept the displayed database or file (Text (CSV) database type selected) name and path or enter a
new name and path in the DB Full Name field. Appropriate extensions (.mdb, .xls, or .csv) are
automatically added to database and file names not containing one. If the specified database or file
does not exist, it will be created.
NOTE: The .TXT file name extension can be used when the Text (CSV) database type is chosen.
5.
Select the type of entity supplying the information being exported in the Table Names area. The
names of the created tables are shown in parentheses.
6.
Enable the Clear Existing Tables option to delete the contents of existing tables prior to the export
operation. Disabling this option causes the exported information to be appended to the information
present in existing tables.
7.
Click OK. The export status is displayed in the CLD Export window.
CLD Export may fail to start if the user workstation is set to a locale that uses the comma (,) instead of a decimal point (.) as
the decimal number separator character.
One possible workaround is to modify the specific Schema.ini file of the output file.
Each file output by Composer in the CSV format goes through the Microsoft Text driver. That driver creates a file called
schema.ini in the same directory as the output file. In the schema.ini file is a section heading for the file, e.g.:
[cldexport.txt]
3-30
2VAA000812R0001
3. Project Architecture
Import
And there are settings specific to that file in that section. The one of interest is the format setting:
Format=CSVDelimited
Change this to:
Format=Delimited(;)
to use semicolons as the separators.
Changing the schema.ini file is not enough, however. The Clear Existing Tables option in the CLD Export window must also
be disabled, otherwise the schema.ini settings are lost and/or overwritten.
The process would be:
a. Copy an exported file from one machine which is configured for a locale that uses the decimal point as decimal separator to
the machine using the desired locale setting
b.
When running the CLD Export tool in Composer, disable the Clear Existing Tables option before exporting.
This should use the semicolons as field separators and allow the tool to run on the target machine. Some issues with this
approach:
a. It must be followed for each output file name used. If you only output to CLDEXPORT1.TXT, then it should be fine, but if
different file names are desired, it could become inefficient.
b. It results in a file that is not in the same exact format as those generated by the tool on machines using the decimal point as
decimal separator. If these output files are to be exchanged with people not expecting semicolons, the output may need to be
edited.
When exporting CLDs containing function code 78 which is only used by the AMM03 modules, error message 3265 ADO
could not find the object in the collection corresponding to the name or ordinal reference requested by the application. (Error
occurred attempting to update field Spec61) is displayed. CLDs containing this particular function code can not be exported.
They must be edited in the Automation Architect.
When exporting CLDs with a target database of Excel, an ADO error stating ADO could not find the specified provider may
be displayed. If this occurs, reload MDAC 2.1 and try again. MDAC 2.1 can be found on the Composer CD disk in the
MDAC 2.1 directory.
3.7.6 Import
Logic entity information can be imported from a database outside of the Composer project to control logic documents within
the selected Composer entity (project, control network, Harmony control unit, controller, or control logic document). The
types of logic entities that can be imported are function codes, constant blocks, text, input references, and output
references. All errors generated during the import operation are displayed in an error window. If errors do exist, it is possible
to import the correct data only or exit this utility. In either case, correcting the database and trying the import utility again are
suggested.
2VAA000812R0001
Type
Description
FCName
Text
Entity name.
Layer
3-31
Import
3. Project Architecture
Type
Description
Spec 1 through
60
StringSpec1 &
StringSpec2
Text
TagName
Text
Xcoord
Ycoord
Type
Description
Layer
Name
Text
Xcoord
Ycoord
Entity name.
3-32
Type
Description
CharSize
Layer
Orientation
TextName
Text
Entity name.
TextValue
Text
Text value.
Xcoord
Ycoord
2VAA000812R0001
3. Project Architecture
Type
Description
Layer
Name
Text
Xcoord
XRefDesc
Text
Ycoord
Entity name.
Cross-reference description.
Type
Description
Layer
Name
Text
Xcoord
XRefDesc
Text
Ycoord
Entity name.
Cross-reference description.
1.
Select the Composer entity containing the control logic document (or control logic template)
that will receive the imported logic entity information in the Composer window.
2.
3.
Select the type of database that is the source of the imported information in the DB Type field.
4.
Accept the displayed database or file (Text (CSV) database type selected) name and path or enter a
new name and path in the DB Full Name field. Appropriate extensions (.mdb, .xls, or .csv) are
automatically added to database and file names not containing one. If the specified database or file
does not exist, it will be created.
NOTE: The .TXT file name extension can be used when the Text (CSV) database type is chosen.
5.
Select the type entity supplying the information being exported in the Table Names area. The names
of the created tables are shown in parentheses.
6.
Click OK. The export status is displayed in the CLD Export window.
3.7.7 Print
To print a control logic diagram:
1.
2.
3.
Select the print quality, number of prints, if they are to be collated, and if they are printed to a file.
4.
Select what is to be done with the cross reference report generated by the print operation. Exporting
it to a text file or printing it along with the control logic document are the available options.
5.
Click Setup... to get to a standard Windows print setup dialog box. Configure the options as
necessary.
2VAA000812R0001
3-33
Properties
3. Project Architecture
6.
Click Style... to configure how the control logic document is to be printed. The style setup dialog box
appears.
7.
On the entries tab of the style setup dialog box, select the specifications, tags, symbols, and cross
references to be printed.
8.
9.
On the layout tab, set the margins, alignment, and scale of the control logic document.
10. On the header/footer tab, configure the header and footer using the codes provided.
11. Click OK.
3.7.8 Properties
The properties of a control logic document include:
Name.
Type.
Location.
Project name.
Status.
Controller address.
To view or edit the properties of a control logic document, refer to Common Editing Functions for more information.
1.
2.
Enter a comment that will uniquely identify this revision (snapshot) from other revisions and click OK.
At the moment a revision is generated, the date and comment of the current revision (the working copy) and newly
generated revision are exactly the same. The date and comment of the current revision will not change until the comment is
changed manually (click Edit Current Desc). It is recommended that the comment of the current revision be changed to help
distinguish it from the last revision created from it.
3.7.10 Status
To view the status of a control logic document:
3-34
1.
Right click the control logic document and select Template Linking > Status... from the popup menu.
2.
View the control logic document and template revision, notification if upgrading is required (the
template it is linked to has changed), linked status, and locked status in the dialog box.
2VAA000812R0001
3. Project Architecture
3.
3.8
Configuration File
Click OK.
Configuration File
Compiling a controller processes control logic documents into a file (filename.cfg) the controller can understand and
execute. Instructions follow on how to load a configuration (and/or program files) from the Composer project to the controller
and how to save the configuration file and/or program files from a controller. Program files are C, BASIC, or batch programs
used in the configuration. The properties of a configuration file are also described. Refer to Common Editing Functions for
information about deleting, viewing the properties of, verifying, and viewing the function codes used by a configuration file.
1.
Right click the controller or click directly on the configuration file and select Run Time >
Load To Controller....
2.
Select the type of information to download (Configuration, Program Files, or Both) and click OK.
3.8.2 Properties
The properties of a control logic document include:
Name.
Type.
Location.
Project name.
Status.
Controller address.
To view or edit the properties of a configuration file, refer to Common Editing Functions for more information.
1.
Right click the controller and select Run Time > Save From Controller....
2.
Select the type of information to save (Configuration, Program/File System Blocks, or Both) in the
save controller configuration dialog box.
3.
If the configuration file is to be saved, choose to overwrite the current or create a new configuration
file within Composer. Enter the current or new configuration file name (as applicable).
4.
If the program files are to be saved (to a single file), choose to overwrite the current or create a new
program file within Composer. Enter the current or new program file name (as applicable).
5.
Click OK.
2VAA000812R0001
3-35
Global Save/Load/Verify
3. Project Architecture
NOTE: Simultaneous execution of multiple GSLV scripts may cause conflicting access to the same controller. The
GSLV utility does not attempt to prevent this condition on the client node where the script is being executed or
between multiple clients. It is the responsibility of the user to ensure that conflicting controller access does not occur.
In an open Composer project, select a node in the system architecture tree. This is either
the project node (the top-most node) or a hardware-related node (a control network, control
unit, controller, or workstation).
2.
Right click on the node and select New > GSLV Document.
A new GSLV document is added to the list of items in the right-hand pane.
3.
To change the name of the document, right click on the new document, select Rename, and change
the name.
4.
5.
Enter the script commands in the main GSLV window, which is a normal text editor. Cut, copy, paste,
find, and replace operations are available.
6.
Comments can be entered in a script by using an apostrophe at the start of a line. For example:
7.
When done, select File > Save. The file is stored in the main project directory, and the filename must
be unique in the project. For example, two scripts can not be named SCRIPT1 in two different nodes
in the Composer project.
In an open Composer project, select a node in the system architecture tree. This is either
the project node (the top-most node) or a hardware-related node (a control network, control
unit, controller, or workstation).
2.
Right click on the node and select New > GSLV Document.
A new GSLV document is added to the list of items in the left-hand pane.
3-36
2VAA000812R0001
3. Project Architecture
Global Save/Load/Verify
3.
4.
Select Script > Run from the menu or click on the black triangle button (Play) on the toolbar.
5.
While a script is running, Script > Stop or the square on the toolbar can be selected.
where: ICI number is an integer value from 1 to 9. Multiple entries for ICI number are separated
by a comma.
Connect to the indicated logical ICIs. For example, the command Connect 1,3,7,9 will attempt to connect to logical ICI 1,
then 3, then 7 and finally 9. The connections will be tried in the order specified until a successful connection is made.
Load L, P, M, cfg description[, nbs description]
Load a configuration to a controller. The cfg description and the nbs description can be replaced by the CFG or NBS
keyword to indicate the tip revision.
NOTES:
1. CFG files are configurations compiled from the control logic documents (CLD).
2. NBS files are binary images of the files system saved from the controller.
Save L, P, M, cfg description[, nbs description]
Save the controllers configuration to disk file.
Verify L, P, M, ref description, src description[, UPDATE_SPECS]
Compare the src configuration to the ref configuration, optionally updating the specification values of the src configuration if
the source specified CLD. The src description and the ref description can be replaced by the CFG keyword to indicate the
tip revision. The ref description can be replaced by the HW keyword to indicate the reference configuration is to be read up
from the controller. The src description can be replaced by CLD to verify and optionally update the specs of the modules
CLDs.
ChangeControllerMode ALWAYS | NEVER | PROMPT
Indicate the action that should be taken when Load encounters a module that is not in CONFIG. Always change the
controllers mode without any prompt. Never change the controllers mode or prompt the user if the controllers mode should
be changed.
InitializeController ALWAYS | PROMPT
Indicate if the controller should be initialized before the configuration is downloaded.
ControllerTypeMismatch PROMPT | IGNORE
Indicate the action that should be taken if Load encounters a controller which differs in type from what is indicated in the
Composer Project.
NOTE: If a controller mismatch occurs when the command is set to IGNORE, the script will abort. This is to prevent
configurations being downloaded to incorrect controllers.
VERIFY 3, 4, 5, 30405MOD
then GSLV looks through the revision list starting at the end (oldest revision first) for a configuration named 30405MOD. If
there are multiple revisions with the same name as the current revision, then the comparison is not being done against the
expected CFG revision but an older one. The best solution is to give the different revisions different names. If that has not
been done, then use the CFG label instead of the revision name VERIFY 3, 1, 2, CFG CLD (do not use quotations marks).
This will make GSLV automatically use the latest revision regardless of what its name is.
2VAA000812R0001
3-37
Global Save/Load/Verify
3. Project Architecture
3-38
2VAA000812R0001
3. Project Architecture
3.9
3.9.1 Create
To add a new human system interface to a control network:
1.
Right click the control network and select New > Console....
2.
Enter the human system interface name, number, and type in the dialog box. Some types of human
system interface may require additional information such as revision level, associated lists (tag,
trend. or both), server group number, etc.
NOTES: Use only alphanumeric and hyphen characters in human system interface names.
3.
Click OK.
3.9.2 Properties
The properties of most human system interfaces include:
Name.
Type.
Location.
Project name.
Status.
Choice of deleting .DT files after use by export function (Conductor VMS and 40 series HSIs only).
2VAA000812R0001
3-39
Display Groups
3. Project Architecture
To view or edit the properties of a human system interface, refer to Common Editing Functions for more information.
3.10.1 Create
To add a new display group to a human system interface:
1.
Right click the human system interface and select New > Display Group....
2.
Enter the display group name in the dialog box and click OK.
3.10.2 Export
To translate and transfer all the displays in a human system interface (that supports display groups) or just a display group:
1.
Right click the human system interface (all displays, all groups) or display group (all
displays, this group only).
2.
Select Export > Displays... (human system interface) or Export... (display group).
3.
Enter the location to receive the exported displays in the dialog box.
4.
Select what is to be exported (all the displays and all the symbols used in the displays, just the
displays, or just the symbols).
5.
If FTP sites are associated with this human system interface and the symbol or display files are to be
exported all the way to the human system interface, proceed to the next step. If FTP sites are not
involved or the files are to be exported to a directory, proceed to Step Step 10.
6.
Enable FTP files to consoles. The files will be exported to the directory and copied to the human
system interface.
7.
If the files have already been satisfactorily exported to the directory, enable FTP existing data files.
The previously exported files will be copied to the human system interface.
8.
Select the FTP sites that will receive the symbol or display files.
If exporting a display or tag list using FTP, verify the FTP site directory is set to allow write access.
Use the following procedure to set Windows workstations serving as a FTP host to allow write
access:
a.
Select Administrative Tools > Internet Services Manager and select the Default FTP site.
b.
Open the Properties page and select the Home Directory tab.
c.
Enable the option for allowing write access (under the FTP Site Directory section) and click OK.
10. Click OK.
During the export operation, a command (.CMD) file is created. This file contains the ordered and processed .DT file for use
by the human system interface. The .CMD file is automatically transferred when the FTP protocol is used but must be
manually transferred otherwise.
3.10.3 Print
To print a copy of all the displays in the display group:
3-40
1.
2.
Specify the printer, print range, and copies settings in the standard Windows print dialog box and
click OK.
2VAA000812R0001
3. Project Architecture
Properties
3.10.4 Properties
The properties of a display group include:
Name.
Type.
Location.
Project name.
Status.
To view or edit the properties of a display group, refer to Common Editing Functions for more information.
3.11 Displays
NOTE: Composer utilizes Conductor VMS, PCV, MCS series, and OIS series displays in the same manner.
Conductor VMS human system interface displays are used to monitor process operation and results of control actions.
Displays can be assigned to tags, keyboard keys, and ADP pushbuttons for data input. Display types include alarm
summaries, graphic overviews, graphic details, groups, trends, and XY plots. Symbols are complex entities composed of
primitive entities, escapes, and other symbols that can be referenced in displays and other symbols. Instructions on how to
create, open, export, print, edit, create references to displays, and synchronize the tags used in the display with those in the
database follow. The properties a display or symbol has are also described. Refer to Common Editing Functions for
information about copying, deleting, moving, renaming, and viewing the properties of a display.
3.11.1 Create
To add a new display to a display group:
1.
Right click the display group and select New > Display....
2.
Enter the display name in the dialog box and click OK.
To add a new document shape. macro, HSI symbol, display, pop-up display, or custom border to an exchange folder:
1.
2.
Right click empty space in the exchange window and select New and Document Shape, Macro,
Console Symbol, Display, or Custom Border.
3.
Enter the display or symbol name in the dialog box and click OK.
3.11.2 Edit
Conductor VMS displays are created from within the Composer window but they are edited from within the graphical display
configuration window. To edit a display or symbol, right click the display and select Open. To edit a Conductor NT or
Operate IT Process Portal model, right click the human system interface or configuration server and select Open. The
appropriate display configuration window is opened with the display in a window.
3.11.3 Export
To translate and transfer a display or symbol:
1.
Right click the display in the system architecture window and select Export....
2.
3.
Select if the symbols used in the display are to be exported along with the display.
4.
If FTP sites are associated with the human system interface containing the file and the symbol or
display file is to be exported all the way to the human system interface, proceed to the next step. If
FTP sites are not involved or the file is to be exported to a directory, proceed to Step Step 8.
5.
Enable FTP files to consoles. The file will be exported to the directory and copied to the human
system interface.
6.
If the file has already been satisfactorily exported to the directory, enable FTP existing data files. The
previously exported file will be copied to the human system interface.
2VAA000812R0001
3-41
Open
3. Project Architecture
7.
Select the FTP sites that will receive the symbol or display file.
Click OK.
To translate and transfer all the displays or symbols used by a human system interface (that supports display groups):
1.
Right click the human system interface and select Export > Displays....
2.
3.
Select what is to be exported (all the displays and all the symbols used in the display, just the
displays, or just the symbols).
4.
If FTP sites are associated with this human system interface and the symbol or display files are to be
exported all the way to the human system interface, proceed to the next step. If FTP sites are not
involved or the files are to be exported to a directory, proceed to Step Step 8.
5.
Enable FTP files to consoles. The files will be exported to the directory and copied to the human
system interface.
6.
If the files have already been satisfactorily exported to the directory, enable FTP existing data files.
The previously exported files will be copied to the human system interface.
7.
Select the FTP sites that will receive the symbol or display files.
8.
Click OK.
During the export operation, a command (.CMD) file is created. This file contains the ordered and processed .DT file for use
by the human system interface. The .CMD file is automatically transferred when the FTP protocol is used but must be
manually transferred otherwise.
3.11.4 Open
To view a display or symbol (located in an exchange folder), right click the display or symbol and select Open.
The opened display or symbol will appear in a window inside the appropriate display configuration window.
3.11.5 Print
To print a copy of a display:
1.
Right click the display in the system architecture window and select Print. The print
Composer displays dialog box appears.
2.
Specify what additional information (None, Tag Indexes, Tag Names, or Display Selects) is to be
printed.
3.
Select Printer Setup to access a standard Windows printer setup dialog box.
4.
Click OK.
It is also possible to print a copy of opened display and symbol files by selecting File > Print... from the display configuration
window.
3.11.6 Properties
The properties of a display include:
Name.
Type.
Location.
Project name.
Status.
3-42
Name.
2VAA000812R0001
3. Project Architecture
Location.
Project name.
References
To view or edit the properties of a display or symbol, refer to Common Editing Functions for more information.
3.11.7 References
It is possible to use references to displays instead of actual displays. These references are created by dragging a display
from an exchange folder to a display group. The display reference acts like a linked copy of the original display. When
saving an edited (in the same manner as a normal display) display reference, a prompt will explain the available save
options. The display reference can also be used to update the original display.
3.12 Lists
Six types of lists available in the Composer application are:
Alarm comments.
Tag.
Trend.
Report point.
NOTE: The configuration server (required by Operate IT Process Portal clients) provides nine lists. Refer to Configuration Server for more information.
NOTE: Composer supports one Return to Normal tag property (BAD/COM0) for Conductor VMS, Conductor NT and
similar consoles. For Process Portal B and 800xA for Harmony consoles, Composer does not support multiple return
to normal alarm comments. Users of those consoles will need to configure those fields on the console or with the Bulk
Configuration Manager.
The engineering unit descriptor list contains a text descriptor for all the normal engineering units. The logic state descriptor
list contains a text descriptor for all the normal logic states. The alarm comments list contains a text descriptor for all the
normal alarm comments.
Every project contains one and only one engineering unit descriptor, logic state descriptor, and alarm comments list. The
tag, trend, and report point lists contain a group of tags, trends, or report points. There is no limit on the number of these
types of lists. Any or all the human system interfaces in the project can use these lists.
Instructions on how to create, assign, export, edit, and print lists follow. Also provided are instructions of how to edit the
provided engineering unit descriptor, logic state descriptor, and alarm comment lists. The properties a list has are also
described. Refer to Common Editing Functions for information about copying, deleting, moving, renaming, and viewing
the properties of a list.
2VAA000812R0001
3-43
Assign
3. Project Architecture
3.12.1 Assign
To assign a tag, trend, or report point list to a human system interface, drag and drop the list onto the human system
interface. Another method is to specify the list on the human system interface property pages.
3.12.2 Create
To add a new tag, trend, or report point list to a project:
1.
Right click the lists symbol and select New > Tag List..., New > Trend List..., or New >
Report Point....
2.
Enter the list name in the dialog box and click OK.
3.12.3 Edit
To edit a list:
1.
Select the list and then select View > Data Browser.
The right side of the system architecture window changes to a database table showing the items in the list and the specific
data that pertains to each item.
2.
Edit the unshaded fields in the list (as appropriate) by clicking in the field and entering the desired
information. Shaded fields are read-only. Blacked out fields do not apply. In some fields, a pull-down
list will present the allowable information. In these fields, select the appropriate information from the
pull-down list.
NOTE: Moving the cursor to a new row enters (or updates) the data edited in the previous row into the database.
Lists can be sorted by any column using the two toolbar sort buttons. Select the column heading, select one of the sort
buttons, and the list is sorted in increasing or decreasing order (depending on which button is used).
More detailed information about how to edit each type of list follows.
NOTE: Not all trend types and fields described in the table are valid for all human system interface types and revisions.
3-44
Format1 Source2
Description
Creation timestamp
FC name
8C
FC number
2VAA000812R0001
3. Project Architecture
Edit
Format1 Source2
Fill type
PCV information.
Life cycle
16C
Loop
3N
Node
3N
Module
2N
Block
4N
Number of events
6N
Number of
retentions
Tag name
14C
Trend collection
method
Trend collection
resolution
Trend GUID
Trend index
4N
Trend mode
3C
Trend resolution
number
Trend resolution
unit
Trend source
6C
Trend span
number
2N
Last user ID
2VAA000812R0001
Description
3-45
Edit
3. Project Architecture
Format1 Source2
Description
Trend subtype
2C
Trend type
8C
Trend usage
12C
Update timestamp
NOTES:
1. N (numeric) = Numbers 0 through 9 only.
C (character) = Alphabetic characters, numbers 0 through 9, and special characters used as
descriptors.
D = Date.
2. C = Customer supplied.
A = ABB supplied.
By default, LAN-90 PCV uses the trnd_dat.fmt trend format file for compatibility with SLDG 5.6.1. A native trend format file
(trnd-pcv.fmt) is provided for compatibility with LAN-90 PCV version 4.3A, 4.3B, and 5.0A. This native trend format contains
additional information to more precisely define LAN-90 PCV trend configurations. To accept trend configurations defined for
the MCS revision S.1 and OIS 40 series revision E.1 consoles, use the LAN-90 PCV provided trnd-S1.fmt trend format file
which assigns:
NOTE: Not all fields described in the table are valid for all human system interface types and revisions.
3-46
2VAA000812R0001
3. Project Architecture
Edit
Format1 Source2
Description
Alarm deadband
Alarm state
Block
4N
Creation timestamp
EU description
6C
EU index
FC name
8C
FC number
Global time-stamp
High alarm
Last user ID
Life cycle
16C
What stage (in the life cycle of the a tag) this tag
is in presently.
Low alarm
Rptpt GUID
Rptpt name
Segment attrib
Segment prty
Segmntcycletime
Significant change
Span
Target period
Value zero
NOTES:
1. N (numeric) = Numbers 0 through 9 only.
C (character) = Alphabetic characters, numbers 0 through 9, and special characters used as
descriptors.
D = Date.
2. C = Customer supplied.
A = ABB supplied.
2VAA000812R0001
3-47
Export
3. Project Architecture
3.12.4 Export
To export a tag, trend, report point, or configuration server list:
1.
Right click the list, List symbol, or human system interface containing the list and select
Export (from list) or Export > list_name List... (from List symbol or human system interface).
2.
3.
5.
When exporting a tag list, select any other lists (engineering unit descriptor, logic state descriptor,
alarm comment, Operate IT Process Portal) to be exported at the same time.
NOTE: At least one engineering unit descriptor, logic state descriptor, alarm comment, or Operate IT Process Portal
list must be selected when exporting to a .MDB file using FTP protocol.
NOTE: Negative engineering unit and logic state descriptor indices are not supported (will not export) in projects containing both OIS and Process Portal B workstations.
6.
7.
If exporting to an ASCII file, select the type of processing (compress or split) done to the lists before
exporting. Compress condenses the list files and adds a .CP file extension. Split divides the list files
into sizes that will fit on floppy disks.
8.
If exporting to a .MDB file, select if Operate IT Process Portal field names should be used and the
view to be used during the export operation. Use Operate IT Process Portal field names if the
exported lists are to be imported into a Operate IT Process Portal human system interface.
9.
If exporting a list from a human system interface using the FTP protocol, proceed to the next step. If
the FTP protocol is not being used, proceed to Step Step 12.
1.
Right click the list or List symbol containing the list and select Export (from list) or Export >
list_name List... (from List symbol or human system interface).
2.
3.
4.
If exporting to an ASCII file, select the type of processing (compress or split) done to the lists before
exporting. Compress condenses the list files and adds a .CP file extension. Split divides the list files
into sizes that will fit on floppy disks.
5.
If exporting to a .MDB file, enter a name for the file and the view to be used during the export
operation.
Click OK.
Versions of LAN-90 PCV prior to 5.4 do not maintain a synchronized alarm comments file between itself and Composer if
there are multiple workstation servers.
When exporting the tag database and alarm comment file from PCV version 5.4 and later, the indices (sp) of alarm
comments existing in the alarm comments file are placed in the .TTG file (for formats >= S1) and any new comments
configured are appended to the alarm comments file (alrmcmnt.tac).
When importing alarm comments into PCV version 5.4 and later, the imported alrmcmnt.tac file overwrites the existing file
in the PCV system (and is mirrored on all networked PCV consoles).
3.12.5 Import
To import a tag, trend, report point, or configuration server list into a project, human system interface, or configuration
server:
3-48
2VAA000812R0001
3. Project Architecture
Import
1.
Right click the list, List symbol, human system interface, or configuration server and select
Import (from list) or Import > list_name List... (from List symbol, human system interface, or
configuration server).
2.
Enter the name and full path of the list file being imported or select one from the list provided in the
File field. Tag lists are named TAGLST1n.CP or use a .TTG file extension. Trend lists are named
TRNLST1n.CP or use a .TTR file extension. Report point lists are named RPTLST1n.CP or use a
.TRP file extension. Lists can also be imported from .MDB files.
2VAA000812R0001
3-49
Import
3. Project Architecture
3.
If the Type/Rev field is set to undetermined, select the type and revision of the list used by the human
system interface sourcing the list. Refer to the following table for more information.
3-50
Tag List
Revision
Trend List
Revision
Report Point
List Revision
PCV / 4.3
PCV / 5.0
PCV / 5.1
PCV / 5.2
PCV / 5.3
PCV / 5.4
PCV / 5.5
Tag L3/M1
Tag L3/M1
Tag S1U
Tag S1U
Tag S1U
Tag S1U
Tag X2U
OIS20 / E.2
Tag S1
Trend S1
MCS / S.3
Tag S1
Trend S1
OIS40 / E.1
Tag S1
Trend S1
Tag R1
Tag S1
Tag V1
Tag X1
Trend R1
Trend S1
Trend S1
Trend S1
OIS41 / E.1
OIS41 / F.1
OIS41 / G.3
Tag S1
Tag T1
Tag V1
Trend S1
Trend S1
Trend S1
OAS / E.1
OAS / F.1
Tag S1
Tag T1
Trend S1
Trend S1
OIS25 / E.2
OIS25 / G.2
OIS25 / J.1
Tag S1
Tag V1
Tag X1
Trend S1
Trend S1
Trend S1
Tag S1
Tag T1
Tag V1
Trend S1
Trend S1
Trend S1
OIS42 / F.1
OIS42 / G.1
OIS42 / G.2
OIS42 / G.3
Tag T1
Tag V1
Tag V1
Tag V1
Trend S1
Trend S1
Trend S1
Trend S1
SIG42 / F.1
SIG42 / G.2
SIG42 / G.3
Tag T1
Tag V1
Tag V1
Trend S1
Trend S1
Trend S1
OIS12 / 5.1
Tag S1
Trend Pre R
SIG12 / 5.1
Tag S1
Trend Pre R
OIS4x / H.2
OIS4x / J.1
Tag V1
Tag X1
Trend S1
Trend S1
SIG4x / H.2
SIG4x / J.1
Tag V1
Tag X1
Trend S1
Trend S1
PWC 90
Tag S1
Trend S1
Conductor NT / 1.0
Conductor NT / 2.0
Conductor NT / 2.1
Tag S1
Trend S1
Tag X1
Trend S1
Tag CNT 2.1 Trend S1
Not applicable
Not applicable
ReportPoint
2VAA000812R0001
3. Project Architecture
Import
Table 3-17 Tag, Trend, and Report Point List Revisions (Continued)
HSI Type / Revision
Tag List
Revision
Trend List
Revision
Trend S1
Trend S1
Trend A0
Report Point
List Revision
Not applicable
Not applicable
ReportPoint
Operate IT Process
Portal Harmony
Real Time Data
Server
Not
applicable
PGP 4.1
S+ Op 1.0
S+ Operations 1.0
S+ Op 1.0
NOTE:
1. Trend list export and import are used to support pre-PCV 5.1 trending. When
using user (Tag
S1U and Tag X2U) tag list export and import, LAN-90 PCV trending is
automatically supported
by including a tag assignment to a historical class.
4.
Select the table to be imported in the Table Name field when importing from a .MDB file.
5.
Enter the name of the list to import in the List Name field. A new list will be created if it does not
already exist in the project or human system interface.
2VAA000812R0001
3-51
Import
3. Project Architecture
6.
Select the appropriate options and click OK. Refer to the following table for an explanation of the
options.
Description
Add new
Items that exist in the list to be imported but do not exist in the list within
Composer will be added to the Composer list.
Overwrite
existing
Items that exist in the Composer list will be overwritten with values from
the same item in the list to be imported.
Skip empty
fields
All fields in the list to be imported that are empty or blank will be
skipped and the amount of time required to import the list will be
decreased.
Auto generate
indexes
New tag indexes will be assigned to imported tags whose indexes are
already being used. This option is only applicable when importing tag
lists.
Use Maestro
field names
Only errors for rejected items will be displayed in the output window.
Log all
operations
A message will be displayed in the output window for each item that is
added, updated, ignored, or rejected.
Include
The engineering unit descriptor (EUD) list will be imported in addition to
engineering unit the selected file. If the selected file is a .TTG file, the EUDSCP.CF file
will be imported. If the selected file is a TAGLST1n.CP file, the
descriptor list
EUDSCP.CP file will be imported. The EUD list must exist in the same
location (drive/directory) as the tag list except when the list resides on
multiple floppy disks and the EUD list is on a different disk than the tag
list. If the selected file is a .MDB file, the engineering unit descriptor
table will be imported. The Add New and Overwrite Existing options
determine if the EUD list is added, updated, or ignored. This option is
only applicable when importing tag lists.
Include logic
The logic state descriptor (LSD) list will be imported in addition to the
state descriptor selected tag list. If the selected file is a .TTG file, the LSDSCP.CF file
list
will be imported. If the selected file is a TAGLST1n.CP file, the
LSDSCP.CP file will be imported. The LSD list must exist in the same
location (drive/directory) as the tag list except when the list resides on
multiple floppy disks and the LSD list is on a different disk than the tag
list. If the selected file is a .MDB file, the logic state descriptor table will
be imported. The Add New and Overwrite Existing options determine if
the LSD list is added, updated, or ignored. This option is only
applicable when importing tag lists.
Include alarm
comment list
The alarm comment list will be imported in addition to the selected tag
list. If the selected file is a .TTG file, the ALRMCMNT.TAC file will be
imported. If the selected file is a TAGLST1n.CP file, the EUDSCP.CP
file will be imported. The alarm comment list must exist in the same
location (drive/directory) as the tag list except when the list resides on
multiple floppy disks and the alarm comment list is on a different disk
than the tag list. If the selected file is a .MDB file, the alarm comment
table will be imported. The Add New and Overwrite Existing options
determine if the alarm comment list is added, updated, or ignored. This
option is only applicable when importing tag lists.
NOTE: Importing a list into a human system interface causes the list to be imported and assigned to the human sys3-52
2VAA000812R0001
3. Project Architecture
tem interface.
To import an engineering unit descriptor, logic state descriptor, or alarm comment list into a project:
1.
Right click the list or List symbol and select Import (from list) or Import > list_name List...
(from List symbol).
2.
Enter the name and full path of the list file being imported or select one from the list provided in the
File field. Engineering unit descriptor lists are named EUDSCP.CF or EUDSCP.CP. Logic state
descriptor lists are named LSDSCP.CF or LSDSCP.CP file extension. Alarm comment lists are
named ALRMCMNT.TAC or ALMCOM11.CP. Lists can also be imported from .MDB files.
3.
Versions of LAN-90 PCV prior to 5.4 do not maintain a synchronized alarm comments file between itself and Composer if
there are multiple PCV servers.
When exporting the tag database and alarm comment file from PCV version 5.4 and later, the indices of alarm comments
existing in the alarm comments file are placed in the .TTG file (for formats >= S1) and any new comments configured are
appended to the alarm comments file (alrmcmnt.tac).
When importing alarm comments into PCV version 5.4 and later, the imported alrmcmnt.tac file overwrites the existing file
in the PCV system (and is mirrored on all networked PCV workstations).
When FTP to send tag lists or displays to a workstation using IIS for it's FTP Server, be sure to enable Write access to the
FTP site. This is not enabled by default in IIS.
When importing a compressed tag list with a large number of alarm comments, and if a temporary directory is selected with
less than 1 megabyte of disk space available, an application error is generated. Make sure to select a temporary directory
with more than 1 megabyte of disk space.
If a tag exists in TaglistA, but does not exist in TaglistB, an attempt to import the tag into TaglistB will fail if the table being
used as the source for the import does not contain the TagIndex field. To work around this, make sure that the source table
has the index field (e.g., if it was created by an export, be sure to include the TagIndex field in the export) or copy and paste
the tags from TaglistA to TaglistB before importing the tags into list TaglistB.
If only the compress option and not the split option are selected when a tag or trend list is exported, the file name created
does not have the proper form (Tag.cp or Trend.cp). In order to re-import, rename the file to taglst11.cp or trnlst11.cp
respectively.
If Access 2000 or later is used to edit a file exported from Composer in .MDB format, and if Access is allowed to upgrade
the files format, then Composer will not be able to import the file. Composer can not import Access 2000 or later format
databases. Exported .MDB files are either to be edited with Access 97 or with Access 2000 without the upgrade option
being selected. This will still allow fields to be edited and records to be added, but not structural changes to be made (no
columns or tables can be added or deleted). Access 97 and Access 2000 can coexist on the same machine as long as
Access 97 is installed first, and the user either starts Access 97 via the start menu or reassociates .MDB files with the
Access 97 executable.
NOTES:
1. This is not an issue with Operate IT B.0.
2. Microsoft Access must be installed because part of the procedure requires modifying the exported .MDB file.
The steps required to create an .MDB file that is compatible with the Maestro 3.1 tag importer:
1.
2.
3.
4.
Type Maestro Tag Composer 2.0 Format as the name for the new user view and click OK to save it.
5.
Press the Fields control to launch the Fields dialog on this new view.
6.
In the Selected Fields list control, remove the following fields (i.e., move them to Available Fields):
AREA GUID
EQUIPMENT GUID
2VAA000812R0001
3-53
3. Project Architecture
UNIT GUID
HISTORIAN SERVER GUID
HISTORIAN ATOM GROUP GUID
SECURITY GROUP GUID
GROUP DISPLAY GUID
TREND DISPLAY GUID
SECTION DISPLAY GUID
OVERVIEW DISPLAY GUID
7.
In the Available Fields list control, add the following fields (i.e., move them to Selected Fields):
Click OK to save the changes and then Close to dismiss the Manage Views dialog.
9.
Export the desired tag list, selecting the Maestro Tag Composer 2.0 Format in the View drop-down
list box on the Export Tags dialog.
3.12.7 Print
To print the list displayed in the data browser:
1.
Select Browser > Print. The standard Windows print dialog box appears.
2.
3.12.8 Properties
The properties of a list include:
Name.
Location.
Project name.
Status.
To view or edit the properties of a list, refer to Common Editing Functions for more information.
3-54
Areas.
Equipments.
2VAA000812R0001
3. Project Architecture
Create
Units.
Security groups.
Graphic displays.
Trend displays.
Group displays.
Historian servers.
These lists contain all the defined items of the type indicated by the name. Operate IT Process Portal tags can be
configured (through property pages) to use the items in these lists. These lists can be edited at any time. Refer to Tag
Configuration for more information about the individual lists.
3.13.1 Create
To add a configuration server to a project:
1.
Right click the project and select New > Config Server.
2.
3.13.2 Properties
The properties of a configuration server to a project:
Name.
Type.
Location.
Project name.
Status.
Workstation name.
To view the properties of a configuration server, refer to Common Editing Functions for more information.
Bitmap image.
Trend document.
Text document.
2VAA000812R0001
3-55
Copy
3. Project Architecture
Wave sound.
WinZip file.
To create an entity, right click on the part of the project architecture that will contain the entity and select File > New >
entity_type.
3.14.3 Copy
To copy a part of a project or the project itself, use the standard Windows copy and paste functions. These functions are
available from the edit menu. They are also available in a pop-up menu displayed by right clicking the part.
NOTE: Right click the associated Harmony control unit when trying to copy a Harmony area or sequence of events
controller.
All tag names in a copied component are renamed. On the first renaming of a tag, a Copy(1) is appended to the tag name.
The second time a Copy(2) is appended to the tag name and so on. This prevents unwanted tag links. Copied control logic
document are appended in the same manner. All changes made during the copy operation are logged to the general tab of
the output window within the Composer window.
Logic state descriptors, engineering unit descriptors and alarm comments and Configuration Server items must be correct
in both source and destination projects, and the default console contexts of both projects must be the same, before copying
tags or errors may result. Exporting tags with these ancillary lists from one project and importing them into the destination
project will display more information if errors do occur.
3.14.4 Delete
To delete a part of a project:
1.
NOTE: Right click the associated Harmony control unit when trying to delete a Harmony area or sequence of events
controller.
2.
NOTE: Deleted SEM controllers will still appear in the tree view (with a red X indicating it has been deleted) until the
project is reopened.
3.14.5 Double-Click
Double-clicking a project structure, exchange item, etc. performs the same function as in Windows applications (expands
structures, open files, etc.).
1.
In the system architecture window, right click the desired part and select Import Document...
or Import > Document.....
3.
4.
Click OK.
Imported documents will appear in the right side of the system architecture window when the part of the project containing
the document is selected. Opening an imported document starts up the software used to create the document and opens
the document itself.
3-56
2VAA000812R0001
3. Project Architecture
Move
3.14.7 Move
To move a part of a project or the project itself, use the standard Windows copy and paste functions. These functions are
available from the edit menu. They are also available in a pop-up menu displayed by right clicking the part.
NOTE: Right click the associated Harmony control unit when trying to move a Harmony area or sequence of events
controller.
3.14.8 Rename
To rename a part of a project (excluding configuration files):
1.
2.
It is also possible to change the name of a part of a project from the property page of the object.
NOTE: Synchronizing a control network or Harmony control unit will cause all the contained control logic documents
to be tag synchronized.
The output window will detail the status of the operation.
68
2VAA000812R0001
Tag Type
Analog
RMSC
Spec #
Data Browser
Field
Description
S2
EUID
S3
Value zero
S4
Span
S5
High alarm
S6
Low alarm
S1
EUID
S3
Value zero
S2 - S3
Span
3-57
3. Project Architecture
177
177
3-58
Tag Type
Station
Spec #
Description
S7
High alarm
S8
Low alarm
S10
Span
S11
Value zero
S12
EUID
S14
DAAnalog S3
DAANG
Data Browser
Field
Value zero
S6
EUID
S22
High 3 delta
S23
High 2 delta
S24
High alarm
S25
Low alarm
S26
Low 2 delta
S27
Low 3 delta
S1 - S3
Span
S24 +
S23
High 2 alarm
S24 +
S23 +
S22
High 3 alarm
S3
Value zero
S6
EUID
S24
High alarm
S25
Low alarm
S1 - S3
Span
2VAA000812R0001
3. Project Architecture
223
Tag Type
Analog
Enh/In
Analog
Enh/Out
Spec #
Data Browser
Field
Description
S3
Value zero
S5
EUID
S6
High alarm
S7
Low alarm
S4 - S3
Span
S3
Value zero
S5
EUID
S7
High alarm
S8
Low alarm
S4 - S3
Span
68
2VAA000812R0001
Analog
RMSC
Spec #
Data Browser
Field
Description
S2
EUID
S3
Value zero
S4
Span
S5
High alarm
S6
Low alarm
S1
EUID
S2
Span + value
zero
S3
Value zero
3-59
3. Project Architecture
177
178
3-60
Station
Spec #
Description
S7
High alarm
S8
Low alarm
S10
Span
S11
Value zero
S12
EUID
S14
DAAnalog S1
DAANG
Data Browser
Field
Span - value
zero
S3
Value zero
S6
EUID
S22
S23
S24
High alarm
S25
Low alarm
S26
S27
S1
Span + value
zero
S3
Value zero
S6
EUID
S24
High alarm
S25
Low alarm
2VAA000812R0001
3. Project Architecture
View Configuration
223
Analog
Enh/In
Analog
Enh/Out
Spec #
Data Browser
Field
Description
S3
Value zero
S4
Span + value
zero
S5
EUID
S6
High alarm
S7
Low alarm
S3
Value zero
S4
Span + value
zero
S5
EUID
S7
High alarm
S8
Low alarm
3.14.11View Configuration
It is possible to view the function code configuration of a configuration file located in the project or executing in a controller
using the Configuration Viewer. The function code configuration of a control logic document can also be viewed. In addition
to being viewed, the function codes can be modified, tuned, read, and deleted. New function codes can be added also.
NOTE: Once the configuration viewer is populated through a summary upload, any blocks in the specified range that
are already being shown in the configuration viewer will be added to the displayed list a second time if a read block
range operation is performed. To avoid this condition, exit the configuration viewer and restart it with the targeted
block range selected.
1.
Verify the Composer application is connected (through the run-time menu) to the actual
control system.
2.
Right click the controller and select Run Time > View Configuration.
1.
Right click anywhere in the configuration viewer window and select Add Block... from the
pop-up menu.
2.
Enter the function code number in the add function code dialog box.
3.
3-61
View Configuration
3. Project Architecture
1.
Right click the function block or anywhere in the configuration viewer window and select
Read Block Range... from the pop-up menu.
2.
3.
Enter the function block numbers or range of numbers in the read block range dialog box. Separate
numbers or ranges of numbers with commas. Use a hyphen to separate beginning and ending range
numbers.
4.
Click OK.
1.
Right click the function block containing the function code to be modified and select Modify
Specs from the pop-up menu.
The spec edit dialog box appears. This dialog box shows the function block number and all the specifications that can be
modified. The specifications for all function codes can be filtered by selecting one of the following filters.
All
Displays all usable specifications.
Inputs
Displays only input specifications.
Internal
Displays only internal specifications.
Tunable
Displays only tunable specifications.
Online Configuration
Displays only online configuration specifications.
Depending on the function code, more filters are available. These filters include:
Analogs
Digitals
Failure Def
Hardware
Input
Input Addrs
Masks
Min/Max
Module
Output
Output Addrs
Port Def
Signal
Simulation
Thermocouple
Times
Tune Params
Z11 - Z15
Z21 - Z25
Z31 - Z35
3-62
2VAA000812R0001
3. Project Architecture
View Properties
Z41 - Z45
Z51 - Z55
2.
3.
Edit the value of the specification as desired. The Minimum, Maximum, and Default buttons set the
value to the indicated number. The Default All button sets all the specifications to their default values.
4.
Click OK.
1.
Right click the function block containing the function code to be tuned and select Tune
Specs from the pop-up menu.
The dialog box shows the function block number and all the specifications that can be tuned. Use the specification filters
(refer to Modify Specifications) to search for the specification to be tuned.
2.
3.
Tune the value of the specification as desired. The Minimum, Maximum, and Default buttons set the
value to the indicated number. The Default All button sets all the specifications to their default values.
4.
Click OK.
1.
2.
NOTE: Changes made to summary upload data can not be saved as a .CFG file.
1.
2.
Enter the name of the revision in the save configuration dialog box and click OK.
3.14.12View Properties
To view or edit the properties of a part of a project:
1.
2.
View or edit (if the current user has access) the desired properties in the properties dialog box.
3.
If a human system interface was selected, use the FTP tab to view information about any associated
FTP sites. Information presented on the tab consists of:
User name.
If necessary, click Add FTP Site and enter the required information to associate a FTP site to this
human system interface. Repeat the procedure as necessary. This information is used when exporting
symbols or displays.
4.
2VAA000812R0001
Click OK.
3-63
Verify
3. Project Architecture
3.14.13Verify
To compare the control logic documents or controller configuration (configuration file) with the same configuration file (same
or different revision) or the configuration file in the controller:
1.
Right click the control logic document, configuration file, or controller containing the items to
be verified and select Run Time > Verify... (controller selected) or Verify... (control logic
document or configuration file selected).
3-64
2.
Select what is to be verified (control logic document or configuration file). The object to be verified is
selected in the source dialog box.
3.
4.
5.
Click Next.
6.
Select the reference type to compare with the source in the reference dialog box. Selecting Controller
sets the actual controller as the reference. Selecting Configuration sets the configuration file residing
in Composer as the reference.
7.
8.
Click Finish.
2VAA000812R0001
4. Tag Configuration
Tag Categories
4. Tag Configuration
The following topics describe how to configure and edit the project tag database through the use of the data browser
functionality. The same methods and procedures described in this section are used when editing lists. With the data
browser view opened, the tags that pertain to any part of the project architecture (except for human system interfaces) can
be filtered out of the whole tag database and viewed by simply selecting that part.
There is one global tag list and any number of user-defined tag lists within a project.
Global Tag List
Contains the tag information that is common to any usage of that tag. The use of a global tag list supports tag linking and
reduces the size of database needed by human system interfaces. Configuration time is reduced since editing of common
information need be performed only once.
User-Defined Tag Lists
Contain the tag information that is unique to a certain human system interface. Within Composer, more than one of these
lists can exist for a human system interface. However, the human system interface can only maintain one user-defined tag
list at a time.
Tags can be defined through the automation architect, added directly into the tag database (data browser functionality), or
imported from another project. Tags added to the project are immediately available for use in lists, displays, and control
logic documents. Changes made to the global tag list are made once and propagated throughout the project.
Whenever a new tag is added, it receives a tag identifier. Tag identifiers are unique to a tag throughout the project and are
used to link the tag to its various points of use. The tag identifier is not editable.
Changes to tags that affect display configurations (specifically tag name, type, or index) are not automatically reflected in
the display configurations that use those tags. There are two ways to update display configurations: 1) opening the display
using the graphic display configuration window or 2) using the tag synchronization function. Opening a large number of files
just to update the tag data may be time consuming and inconvenient. It may be more convenient to update displays using
the tag synchronization function.
4.1
Tag Categories
There are three general categories of tags. One type defines a process control point that is monitored by the human system
interface over the control network. These tags have an associated exception reporting function code that outputs the point
value and alarm conditions of the point. Depending on the function code associated with the tag, the operator may also be
able to control the point.
The second category of tag defines an internal value to be monitored: either from an application processor task or from a
human system interface peripheral. There are no associated function codes and no values are received over the control
network for these tags.
A third tag category receives status information and problem reports from Symphony equipment over the control network. It
does not have an associated function code.
For tags that have an associated function code in the controller configuration, the control network, Harmony control unit,
controller, and block address of the exception reporting function code essentially define the tag. If a tag is defined in the
human system interface data with a corresponding address, then when information from that function code is exception
reported to the control network, the human system interface can receive the value, alarm conditions, and other information
from the function code. The information received and used by the human system interface depends on the function code
and how the tag is configured in the console database. Refer to Field Information Tables for descriptions of each specific
tag type.
4.2
Descriptor Fields
The text descriptor fields that appear in the data browser include the engineering unit descriptor, zero, one, two, and three
state descriptors, feedback descriptors, permissive state descriptors, and alarm comment descriptors. Whether these fields
are applicable depends on the tag type. The descriptor text can be edited but only if the result is a valid descriptor that
exists in the engineering units descriptor, logic state descriptor or alarm comment list. When selecting an engineering unit
descriptor, logic state descriptor, or alarm comment for a tag field, the pull-down list provides details of the available
choices. If a very large number of choices exists, the dialog box can not hold them all so a <MORE> choice is provided.
Selecting <MORE> opens a data browser-like dialog box which allows the viewing of all the available choices. Select one
and click OK.
New engineering unit descriptors, logic state descriptors, and alarm comments can be added in two ways. One method is to
open the appropriate list (engineering unit, logic state, or alarm comment) and enter a new record. This data is now
available throughout the project.
Another method, available while in the data browser, is to:
1.
Click in the tag field requiring a new engineering unit descriptor, logic state descriptor, or
alarm comment.
2.
3.
2VAA000812R0001
4-1
4.3
4. Tag Configuration
4.
5.
Click OK.
4.4
Field Location
The Location column (Refer to Field Information Tables.) indicates whether a field is global (G) or linked to an engineering
unit descriptor list (E), logic state descriptor list (L), alarm comments list (A), or user-configured tag list (C).
4.5
Field Sources
Data in the tag fields can be sourced and maintained from different Composer windows as follows:
4.6
Fields sourced by the automation architect window are indicated by an M in the Source column of Table 4-8. These
fields are updated by the automation architect and are not editable by the data browser (with one exception).
Network, HCU, Controller, and Block fields are editable until the tag is assigned to a function code by the
automation architect. Additionally, all global fields (G in the Location field) can be updated by the automation
architect and are used by the human system interface.
Fields sourced by the data browser window are indicated by a C in the Source column (Refer to Field Information
Tables.). These fields are used by the human system interface.
Fields sourced by data browser window as information only fields are indicated by an I in the Source column (Refer
to Field Information Tables.). Information only fields provide documentation for tags but are not required for the
system to function.
Fields sourced by the data browser window as automatically generated fields are indicated by an A in the Source
column (Refer to Field Information Tables.). These fields are only used internally by Composer and are not
editable by the data browser.
4.7
4.8
4-2
2VAA000812R0001
4. Tag Configuration
Tag Lists
to incorporate each comment. An alarm comment has two parts. Its index number, located in the AC Index column, is one
part. Its text descriptor, located in the AC Descriptor column, is the other part. A total of 20,000 alarm comments can be
defined in the alarm comment list.
4.9
Tag Lists
The global tag list holds all of the tags defined for the whole project. The total number of tags contained in a project is often
so large that a human system interface can not hold them all. For this reason, place only the tags used by a particular
human system interface into a tag list and then assign that list to that human system interface. This tag list will be
downloaded to the human system interface. Adding tags from the global tag list to a user-defined tag list can be done with
the standard Windows copy and paste functionality or the drag and drop functionality.
Areas.
Equipments.
Units.
Security groups.
Graphic displays.
Trend displays.
Group displays.
Historian servers.
These lists are used to organize the Operate IT Process Portal tags into logical groups if desired. The names of appropriate
items can be added to the corresponding list (Generator 2B to the equipments list, Operators to security groups list, etc.). A
tag is associated with these lists through the Operate IT Process Portal pages of the tag property pages. These pages
provides fields for association to project architecture objects (area, equipment, and unit), security groups, associated views
(trend, group, section, and overview), a text string, and historian definitions (historian server and atom collection). A
graphic, trend, or group display can be defined as a section or overview display.
Data Browser
The data browser function allows the viewing and editing of data records. To enable the data browser view, select View >
Data Browser from the Composer window. Right clicking a list and selecting Open will also enable the data browser view.
The right side of the system architecture window changes to a table displaying the data records that pertain to the selected
part of the project architecture. Select the project to get the most complete (global) tag database listing.
The data browser view consists of a table organized by rows and columns. The rows contain the information that belongs to
a record. Each column identifies a data field that contains a particular item of information. Each of these items of information
is stored as a unique field within the record. The fields that apply to a particular record depend upon the data type of the
selected list and the category of the current record. Blacked out fields do not apply, shaded fields are not editable, and nonshaded fields are fully editable.
NOTE: Only the complete contents of the data browser can be exported. Individual records within the current view
can not be exported.
4.11 Views
Views are ways of looking at data. Composer provides a number of standard views. These views can be edited but not
saved. However, the standard views can be copied, edited, and saved to create a custom view. Custom views can be
created using any valid fields, filter criteria, and sort criteria. Views can be created, modified, saved, selected, and a listing
of valid views can be viewed.
4.11.1 Create
To create a new view:
1.
2.
3.
2VAA000812R0001
4-3
Copy
4. Tag Configuration
4.
Enter a name for the view in the create view dialog box and click OK. The name of the new view
appears in the list of available views.
1.
2.
Enter a name for the view in the save view as dialog box and click OK.
NOTE: View name can only contain alphanumeric, forward slash, parenthesis, underscore, hyphen, empty space,
and period characters. Using other characters may cause runtime errors when selecting the view for display. If this
error is displayed, delete the view using the Tools > Manage View option.
4.11.2 Copy
To create a new view that is identical to an existing view:
1.
2.
3.
4.
Enter a name for the new view in the copy view dialog box and click OK.
1.
2.
A list of the views associate with the selected data type is provided in the upper part of the manage view dialog box. The
lower part lists the fields used in the view along with any filter and sort criteria used.
4.11.4 Modify
It is possible to modify the current view to use specific fields, filter criteria, and sort criteria. A standard view for each type of
list is used when the data browser is opened for the first time. The name of this view is listed in the output window and is
considered the current view for that type of list. Save any changes made to the current view using Browser > Save View or
Browser > Save View As or these changes will be lost when the view is closed. If the view was saved, it will be used the
next time a list of same type is opened.
Fields
To specify the fields to contained in the current view:
1.
2.
3.
Move fields from the available fields list to the selected fields list (fields that will be displayed) or vice
versa by selecting the fields and using the appropriate button in the user defined fields dialog box
4.
Arrange the fields in the desired order (top of the list is the left most column and bottom of the list is
the right most column) by selecting the field and using the up and down buttons.
5.
Click OK.
Filters
To specify the filter criteria to be used in the current view:
1.
2.
4-4
3.
If a relatively simple condition is to be configured, select a field whose value will be used in the filter
criteria and proceed to the next step. If a more complex condition is required, proceed to the next
step. The fields to search list contains all the currently viewable fields.
4.
Click Add Where Cond (for a relatively simple condition) or Add Adv Where (for a more complex
condition).
2VAA000812R0001
4. Tag Configuration
Modify
5.
If the Add Where Cond button was used, proceed to the next step. If the Add Adv Where button was
used, proceed to Step 8.
6.
8.
Enter an expression in the Expression1 field in the advanced filter builder dialog box. Refer to the first
table for information about the special search characters (standard SQL functionality), second table
for information about the string functions (standard Visual Basic functions), and third table for
information about the math functions (standard Visual Basic functions).
NOTE: Standard SQL syntax, along with standard Visual Basic string and math functions, is used in this dialog box.
9.
Description
Example
[]
[! ]
Notes:
1. Use these special search characters with string or text data types.
2. When searching for an asterisk, question mark, number sign, opening bracket or hyphen, enclose it
in brackets.
3. When searching for a hyphen and other character simultaneously, the hyphen must be before or
after all the other characters
but inside the brackets. However, the hyphen must be placed after an exclamation point (if being
used).
4. Searching for an exclamation point or closing bracket does not require brackets.
Name
Dialog Box
Using
Function
Description
Where,
Replace
Where,
Replace
IIf
Where,
Replace
2VAA000812R0001
4-5
Modify
4. Tag Configuration
Name
InStr
Dialog Box
Using
Function
Where,
Replace
Description
Returns a number specifying the position of the first
occurrence of one string within another.
Syntax1:
LCase
Replace
Left
Where,
Replace
Where,
Replace
Where,
Replace
Where,
Replace
Where,
Replace
Where,
Replace
Str
String
Where,
Replace
Where,
Replace
Syntax:
Syntax3:
Where,
Replace
Replace
Space(number)
Str(number)
String(number, character)
UCase
RTrim(string)
Where,
Replace
Syntax:
Trim
Right(string, length)
Space
RTrim
LTrim(string)
Right
Len(string)
Mid
Left(string, length)
LTrim
LCase(string)
Len
Trim(string)
UCase(string)
NOTES:
1. The compare parameter is not supported.
2. Does not effect Access data but will effect SQL Server data.
3. Adds a leading space for the sign if the number is positive.
4-6
2VAA000812R0001
4. Tag Configuration
Modify
Name
Dialog Box
Using
Function
Description
Where,
Replace
Multiply
Where,
Replace
Add
Where,
Replace
Subtract
Where,
Replace
Divide
Abs
Where,
Replace
Abs(number)
Where,
Replace
Int(number)
Where,
Replace
Val
Where,
Replace
Val(string)
1.
2VAA000812R0001
Save
4. Tag Configuration
2.
3.
Select the field whose order is to be changed in the sort tag by dialog box.
4.
Click Add. The field name is added to the Sort Fields field along with an indication of the present sort
order.
5.
6.
7.
8.
Configure the order in which the sorts will take place by selecting a sort field and moving it to the
correct position using the up and down buttons. The top sort field is sorted first, then the sort field
below it, and so on.
9.
Click OK.
4.11.5 Save
To save the current view, select Browser > Save View or Browser > Save View As.
4.11.6 Select
To select a new view:
1.
2.
Select the view from the list provided and click OK.
1.
Fill in the asterisked row of the data table with the record data.
2.
The row will automatically receive a number and a new row (with an asterisk) is created.
To add a record to the selected list (method two):
1.
2.
Fill in the data fields of the new record. If the new record is a tag, fill in the Name, Type, Description
(optional), and Customer Tag ID (optional) fields of the tag property dialog box and select OK or
Apply.
NOTE: The tag property dialog box for adding tags can also be displayed by double-clicking the row header of the
asterisked row.
Using OK causes the data to be saved and control is returned to the data browser. Using Apply also causes the data to be
saved but control remains in the tag property dialog box.
4-8
2VAA000812R0001
4. Tag Configuration
Copy Records
1.
2.
Right click the last (or only) selected record and select Delete Current Row (or depress DELETE).
NOTE: Deleting records from a global tag list that are used in other lists initiates a dialog box that states so and
requires an OK input to continue.
1.
Edit the fields in one row as desired. The lock symbol will appear in the row header as soon
as the first change is made.
2.
Click in a field in the next row to be edited. The edited row is saved and unlocked.
1.
Select Browser > Lock all records. The lock symbol will appear in the row header of all the
rows.
2.
3.
4.
5.
Click Yes when asked to confirm the saving of changes. The edited rows will be saved and all rows
will be unlocked.
To automatically lock all the records of each list as they are selected, select Browser > AutoLock all Records. Repeat the
procedure to disable this functionality.
1.
2.
3.
Select the field of interest in the field vocabularies dialog box and click Scan Field.
The selected field in all the records in the view are scanned and a listing is displayed. Column A is the number or word
listing and column B is the number of occurrences.
2VAA000812R0001
4-9
Find Records
4. Tag Configuration
4.
If a listed number or word is to be updated, proceed to the next step. If no updating is required,
proceed to Step 10.
5.
6.
Click Find First. The cursor is moved to the first data browser field (starting from the first record) that
contains the unedited number or word.
7.
View the Current Value and Updated Value (displays the resulting value if replace functionality is
used) fields and verify the correct action is to be performed.
8.
9.
If there are multiple occurrences of the number or word, repeat Steps 7 and 8 until all occurrences
are updated.
10. Repeat Steps 3 through 9 for each data browser field of interest.
1.
2.
3.
If a relatively simple condition is to be configured, select a field whose value will be used in the find
criteria and proceed to the next step. If a more complex condition is required, proceed directly to the
next step. The Field to Search list contains all the currently viewable fields of the list.
4.
Click Add Where Condition.... (for a relatively simple condition) or Advanced... (for a more complex
condition).
5.
If the Add Where Cond... button was used, proceed to the next step. If the Advanced... button was
used, proceed to Step 8.
6.
8.
Enter an expression in the Expression1 field in the advanced filter builder dialog box. Refer to the first
table in the Modify topic for information about the special search characters (standard SQL
functionality), the second table in the Modify topic for information about the string functions (standard
Visual Basic functions), and the third table in the Modify topic for information about the math
functions (standard Visual Basic functions).
NOTES:
1. Standard SQL syntax (with standard Visual Basic string and math functions) is used in this dialog box.
2. Use double quotation marks around string fields
9.
10. Enter an expression in the Expression2 and Expression3 (if the between operation was selected)
fields.
11. Click Validate to have the condition checked for being valid. Correct the condition if necessary.
12. Click OK.
13. Repeat Steps 3 through 12 for the remaining fields (in left-to-right order).
NOTE: AND operators are automatically placed between field conditions.
14. Edit any field conditions by selecting the expression and selecting Modify.
15. Edit the find logic expression by inserting the cursor at the desired location and selecting the desired
logic operator.
16. If the find filter may be needed again, save it by clicking Save Filter and proceed to the next step. If
the find filter is not being saved, proceed to Step 18.
17. Enter a name for the filter in the save/replace filter dialog box.
4-10
2VAA000812R0001
4. Tag Configuration
Go to Record
4.19 Go to Record
To move the cursor to a specific record in the list:
1.
2.
Enter the row number in the dialog box and click OK.
1.
2.
Right click in an editable field in one of the selected records and select:
1.
2.
Drag the column to a position where a red line indicates the desired insertion point.
The order in which columns are displayed can also be changed while modifying the data browser view from the modify view
dialog box. Refer to Modify for more detailed information.
1.
2.
Optionally use the find records functionality to limit the displayed records to only those receiving the
replacement values. Refer to Find Records for more information.
3.
4.
If a relatively simple replace pattern or value is to be configured, select the field whose value is to be
replaced from the list. If a more complex pattern or value is required, proceed to Step 10.
5.
If a previously saved replace filter is to be used, select the name in the saved replace specifiers field
and proceed to Step 23.
6.
7.
8.
9.
10. Click Advanced.... The advanced replace pattern builder dialog box appears.
11. Select the field containing the text value being replaced.
2VAA000812R0001
4-11
Replace Records
4. Tag Configuration
12. Enter an expression (limited to text, numbers, and the special search characters) enclosed in double
quotation marks into the Expression To Search For field. Refer to the following table for more
information about the special search characters.
Description
^ (caret)
Matches the characters when they are at ick$ finds ick within sick but not
the end of a string.
within sickness.
NOTES:
1. If a* is by itself or if more as will be found, the
empty string (zero as) will not be found.
2. If a* is used by itself, it acts like a+.
NOTES:
1. If a? is by itself, a will be found but the empty
string (zero as) will not be found.
2. If a? is by itself, it acts like a+.
4-12
Example
2VAA000812R0001
4. Tag Configuration
Replace Records
Description
Example
If \0 indicates a tagged
expression representing the
entire substring that was
matched. If the substring that
matched the regular expression
is abcd, a replace expression of
xyz\0xyz will changed it to
xyzabcdxyz. Other tagged
expressions can be represented
by \1, \2 .. \9. Although the
tagged expression \0 is always
defined, tagged expressions 1
through 9 are only defined if the
regular expression used in the
search has enough sets of
parenthesis.
Initial value:
lifestyle
Pattern to replace field value:
(.*)fe(.*)
Replace with field value:
\1\2\2\0
Updated field value:
listylestylelifestyle
NOTE: When using the alteration
character within a tagged expression, the
last match found when parsing from left to
right is used.
Initial value:
lifestyles
Pattern to replace field value:
(.*)(fe|ty)(.*)
Replace with field value:
\1add\3
Updated field value:
lifesaddle
[]
2VAA000812R0001
4-13
Replace Records
4. Tag Configuration
Description
Example
NOTE: Regular expression syntax (with standard Visual Basic string and math functions) is used in this dialog box.
NOTE: Advanced replace expressions are case sensitive and support scientific notation. All other expressions used
in Composer are not case sensitive and do not support scientific notation.
13. Enter an expression in the Expression To Replace field. Refer to the following table for information
about the special replace characters, the second table in Modify topic for information about the string
functions (standard Visual Basic functions), and the third table in the Modify topic for information
about the math functions (standard Visual Basic functions).
NOTE: Only plain text, simple numbers, and special replace characters need be enclosed in double quotation marks
in the Expression To Replace With field.
4-14
2VAA000812R0001
4. Tag Configuration
Select Columns
Description
&
14. To test the advanced replace criteria (if desired) or just become familiar with advanced replace
criteria in general, click Practice Dialog. If testing or practice is not required, proceed to Step 23.
NOTE: The advanced replace patterns practice dialog box supports only text, numbers, special search characters,
and special replace characters.
15. Enter the whole value of the field containing the text or value to be replaced in the String to Be
Replaced field.
16. Enter the string that is to be replaced in the Search For field.
17. Enter the replacement string in the Replace With field.
18. Click Replace Text. The Resulting String field displays the end result if this operation really
happened.
19. Repeat Steps 15 through 18 as required.
20. Click Exit.
21. Click OK. The replace expression is validated and a dialog box stating the result is displayed.
22. Click OK to complete configuration of the advanced replace criteria (if criteria is valid) or to return to
the advanced replace pattern builder dialog box (if criteria is not valid).
23. Use the Find First, Find Next, Replace, Replace All, and Undo Changes (restores data after a
replace all operation) buttons to control the replacement functionality.
24. If desired and after a successful replace operation, save the replace criteria by selecting Save
Replace. Enter the name and click OK.
1.
2.
Drag the cursor to the last column and release the button. The selected columns are highlighted.
1.
2.
3.
Repeat Step 2 for the remaining columns to be selected. The selected columns will be highlighted.
1.
2.
3.
Select the font, font style, and size of the text characters.
4.
Choose if strikeout, underline, or normal (no selection required) characters are to be used.
5.
6.
2VAA000812R0001
4-15
Select Records
4. Tag Configuration
1.
2.
Drag the cursor to the last record and release the button. The selected records are highlighted.
1.
2.
3.
Repeat Step 2 for the remaining records to be selected. The selected records will be highlighted.
To select all the records in the current list, Click the Row header (upper left corner of the table). All records will be
highlighted.
1.
2.
Type.
Name.
Description.
Custom identifier.
1.
Right click in the left-most box of the row containing the tag and select Properties.
- or Click the tag icon in the Tag Name field of the tag.
- or Double-click in the row header of the tag.
4-16
2VAA000812R0001
4. Tag Configuration
2.
3.
Click OK or Apply. Using OK causes the data to be saved and control is returned to the data browser.
Using Apply also causes the data to be saved but control remains in the property dialog box.
The specific pages included within the tag property dialog box are determined by the context of the view from which they
are accessed. This context is determined by two factors.
The first factor is the type of item selected in the system architecture window. Selecting the project will display all the fields
of the global tag list. Selecting a user-defined tag list will display the global and human system interface specific fields of the
tag list. Selecting a hardware item (control network, Harmony control unit, controller, or human system interface) will display
a subset of the global list containing the tags used by the item.
The second factor is the current console context setting. Console context refers to the format used to display the tag
information which is used by Conductor VMS, Conductor NT, and Operate IT Process Portal human system interfaces. The
format used by the three types of human system interfaces is different.
Description
Function
Code
ANALOG
ANALOG
ENH/IN
FC 30, FC 47,
FC48, FC 70,
FC 158, FC
222, FC 223
FC 223
FC 21, FC 22,
DAANALG Acquires an analog exception reported value providing
FC 23, FC 80,
enhanced alarm management capabilities. Supports data
acquisition only. It incorporates a DA macro that supports a FC177
control station function code. Also supports the data
acquisition analog function code but does not enable the full
functionality of the function code.
2VAA000812R0001
DADIG
FC 211
Acquires a digital exception reported state providing
enhanced alarm management capabilities. Allows selecting
the input source for the function block in a controller and
writing a user-inserted value to the block. Supports the data
acquisition digital function code.
DADIGTL
FC 129
Acquires a digital exception reported state providing
enhanced alarm management capabilities. Supports data
acquisition only. It incorporates a DA macro that supports a
multistate device driver function code.
DANG
FC 177
Acquires an analog exception reported value providing
enhanced multiple level alarming and deviation and rate
alarming. Allows selecting the input source for the function
block in a controller and writing a user-inserted value to the
block. Supports the data acquisition analog function code.
4-17
4. Tag Configuration
Description
Function
Code
DEVSTAT For internal human system interface use only; no values are Not applicable
received over the control network for this type of tag. Allows
the human system interface to monitor the status of its
peripheral devices: keyboards, annunciator display panels,
monitors, printers, touch screens, and data storage devices.
DIGITAL
FC 45, FC 67,
FC 224, FC
225
DIGITAL
ENH/IN
FC 224
DIGITAL
Acquires exception reported addressing, startup, run-time, FC 225
ENH/OUT override, and failure mode specifications for individual or
redundant pairs of digital output channels on a Harmony I/O
block.
INTANG
For internal human system interface use only; no values are Not applicable
received over the control network for this type of tag. Allows
writing an analog value from an application processor that
can be used throughout human system interface functions.
INTDIG
For internal human system interface use only; no values are Not applicable
received over the control network for this type of tag. Allows
writing a digital value from an application processor that can
be used throughout human system interface functions.
Can also be used for a point being recorded in an SOE log.
Writes descriptive tag information to the log.
MSDD
FC 129
Acquires an exception reported status for a three-state
device while it is in either manual or automatic mode. Allows
initiating manual control. Supports the multistate device
driver function code.
N90STA
Reads detailed status information and problem reports from Not applicable
Symphony equipment over the control network.
PHASEX
RCM
4-18
2VAA000812R0001
4. Tag Configuration
Function
Code
Description
RMCB
FC 136
RMSC
FC 68
STATION
FC 21, FC 22,
FC 23, FC 80
TEXT
FC 194
TEXTSTR Enables communication between the human system
interface and a C language or batch program running in a
controller to allow transfer of text strings. Supports the userdefined data export function code.
Fields
Tag Index (except global tags), Tag Name, Tag Type
2VAA000812R0001
N90STA
DEVSTAT
4-19
4. Tag Configuration
ANALOG
ANALOG ENH/IN
ANALOG ENH/OUT
DAANALG
DADIG
DADIGTL
DANG
DEVSTAT
DD
DIGITAL
DIGITAL ENH/IN
DIGITAL ENH/OUT
INTANG
INTDIG
MSDD
N90STA
PHASEX
RCM
RMCB
RMSC
STATION
TEXT
TEXTSTR
Format2
Source3
Location4
ADS Keyboard
C C
ADS Lamp
C C
ADS Panel
C C
Fields1
4-20
64C
C A
C C
64C
C A
C G
64C
C A
C G
64C
C A
C G
64C
C A
C G
64C
C A
C G
64C
C A
C G
64C
C A
C G
64C
C A
C G
64C
C A
C G
64C
C A
C G
2VAA000812R0001
4. Tag Configuration
Source3
Location4
Format2
Fields1
ANALOG
ANALOG ENH/IN
ANALOG ENH/OUT
DAANALG
DADIG
DADIGTL
DANG
DEVSTAT
DD
DIGITAL
DIGITAL ENH/IN
DIGITAL ENH/OUT
INTANG
INTDIG
MSDD
N90STA
PHASEX
RCM
RMCB
RMSC
STATION
TEXT
TEXTSTR
64C
C A
C G
64C
C A
C C
C G
Alarm Deadband
Alarm Group
C C
2C
C C
C G
C G
C G
C G
C G
C G
C G
C G
C G
C G
C G
C G
C G
2VAA000812R0001
4-21
4. Tag Configuration
ANALOG
ANALOG ENH/IN
ANALOG ENH/OUT
DAANALG
DADIG
DADIGTL
DANG
DEVSTAT
DD
DIGITAL
DIGITAL ENH/IN
DIGITAL ENH/OUT
INTANG
INTDIG
MSDD
N90STA
PHASEX
RCM
RMCB
RMSC
STATION
TEXT
TEXTSTR
Format2
Source3
Location4
C G
Alarm State
C G
C G
Fields1
Alarm Type
3C
C G
C G
Archive
Archive Class
Area GUID
Area Name
Area Ndx
Block
M G
C
1C
C C
CLD
255C M G
CNet
M G
C
C C
C C
1C
C G
Control Enabled
4-22
A G
Customer Tag ID
32C
C G
Device Number
C G
16C
C G
Device Type
16C
C G
Equipment GUID
Equipment Name
Equipment Ndx
EU Descriptor
6C
C E
EUD Index
C G
2VAA000812R0001
4. Tag Configuration
Format2
Source3
Location4
Fields1
ANALOG
ANALOG ENH/IN
ANALOG ENH/OUT
DAANALG
DADIG
DADIGTL
DANG
DEVSTAT
DD
DIGITAL
DIGITAL ENH/IN
DIGITAL ENH/OUT
INTANG
INTDIG
MSDD
N90STA
PHASEX
RCM
RMCB
RMSC
STATION
TEXT
TEXTSTR
6C
C L
C G
6C
C L
C G
6C
C L
C G
6C
C L
C G
6C
C L
C G
6C
C L
C G
6C
C L
C G
6C
C L
C G
FC Name
8C
M G
FC Number
M G
C G
Handshaking
High Alarm5
2VAA000812R0001
High2 Alarm
C G
High3 Alarm
C G
High2 Delta
C G
High3 Delta
C G
4-23
4. Tag Configuration
Format2
Source3
Location4
Fields1
ANALOG
ANALOG ENH/IN
ANALOG ENH/OUT
DAANALG
DADIG
DADIGTL
DANG
DEVSTAT
DD
DIGITAL
DIGITAL ENH/IN
DIGITAL ENH/OUT
INTANG
INTDIG
MSDD
N90STA
PHASEX
RCM
RMCB
RMSC
STATION
TEXT
TEXTSTR
Last User ID
C G
Life Cycle
16C
C G
C G
Low Alarm5
C G
C G
Low2 Alarm
C G
Low3 Alarm
C G
Low2 Delta
C G
Low3 Delta
C G
M G
C
Module
Module/Node Type
16C
C G
C G
Node
M G
C
Node List
C C
C G
One State
6C
C L
C G
C G
PID Block
4-24
6C
C L
C G
6C
C L
C G
6C
C L
2VAA000812R0001
4. Tag Configuration
Format2
Source3
Location4
Fields1
ANALOG
ANALOG ENH/IN
ANALOG ENH/OUT
DAANALG
DADIG
DADIGTL
DANG
DEVSTAT
DD
DIGITAL
DIGITAL ENH/IN
DIGITAL ENH/OUT
INTANG
INTDIG
MSDD
N90STA
PHASEX
RCM
RMCB
RMSC
STATION
TEXT
TEXTSTR
C G
6C
C L
C G
C G
C G
C G
C G
Primary Display
8C
C C
C C
Print Alarm
1C
C C
1C
C C
1C
C C
Save Alarm
1C
C C
1C
C C
1C
C C
Security Group
C C
Security Level
C C
Span
C G
C G
C C
32,
40,
64,C
C G
SP Value Zero
String Length
2VAA000812R0001
Tag Description
Tag Descriptor 1
Tag Descriptor 2
Tag GUID
A G
Tag Index
C C
4-25
4. Tag Configuration
Source3
Location4
Format2
Fields1
ANALOG
ANALOG ENH/IN
ANALOG ENH/OUT
DAANALG
DADIG
DADIGTL
DANG
DEVSTAT
DD
DIGITAL
DIGITAL ENH/IN
DIGITAL ENH/OUT
INTANG
INTDIG
MSDD
N90STA
PHASEX
RCM
RMCB
RMSC
STATION
TEXT
TEXTSTR
Tag Name
14,16 C G
, 32,
C
Tag Type
7C
C G
C G
Three State
6C
C L
C G
Transmit Acknowledge
1C
C C
Transmit Silence
1C
C C
Two State
6C
C L
C G
A G
C G
Unit GUID
Unit Name
Unit Ndx
User Text
Value Zero
Zero State
6C
C L
C G
NOTES:
1. The attributes applicable to a particular tag type are not necessarily required for every tag of that type.
For example, the alarm
inhibit attribute needs to be configured for only those tags needing the alarm inhibit functionality.
2. N (numeric) = Numbers 0 through 9 only.
C (character) = Alphabetic characters, numbers 0 through 9, and special characters used as
descriptors.
G = Globally unique identifier.
3. M = Must/can be maintained by automation architect.
C = Entered into the tag database by the data browser.
I = Information only field; entered into the tag database by the tag browser.
A = Autogenerated by database.
D = Date.
4. A = Contained in the alarm comments list.
C = Contained in the user-configured tag lists.
E = Contained in the engineering unit descriptor list.
G = Contained in the global tag database.
L = Contained in the logic state descriptor list.
5. For DAANALG tags, this field must/can be maintained by the tag browser.
4-26
2VAA000812R0001
4. Tag Configuration
ADS Panel
ADP keyboard, panel, and lamp number defining the full address
of the lamp to light when this tag goes into alarm.
Keyboard range is 0 - 8 (0 = all).
Panel range is 0 - 4 (0 = all).
Lamp range is 0 - 64 (0 = no ADP function).
ADS Lamp
2VAA000812R0001
Description
4-27
4. Tag Configuration
4-28
Description
Alarm Deadband
Alarm Group
Alarm State
Alarm Type
Type of alarming.
Archive
Archive (Y or N).
Archive Class
Area GUID
Area GUID.
Area Name
Area name.
Area Ndx
Area index.
Block
2VAA000812R0001
4. Tag Configuration
2VAA000812R0001
Description
CLD
CNet
Control Enabled
Control enable; Y or N.
Customer Tag ID
Device Number
Device number.
Device subtype.
Device Type
Device type.
Equipment GUID
Equipment GUID.
Equipment Name
Equipment name.
Equipment Ndx
Equipment index.
EU Descriptor
EUD Index
FC Name
Name of the symbol used by the function code to define this tag.
FC Number
4-29
4. Tag Configuration
4-30
Description
Handshaking
Handshaking.
High Alarm5
High2 Alarm
High3 Alarm
High2 Delta
Delta value added to the high variable alarm value to give the 2high variable alarm value - must be positive number in EU.
High3 Delta
Delta value added to the high variable alarm value to give the 3high variable alarm value - must be positive number in EU.
Last User ID
Life Cycle
What stage (in the life cycle of a a tag) this tag is presently in.
Low Alarm5
Low2 Alarm
Low3 Alarm
Low2 Delta
Delta value added to the low variable alarm value to give the 2low variable alarm value - must be positive number in EU.
Low3 Delta
Delta value added to the low variable alarm value to give the 3low variable alarm value - must be positive number in EU.
Low variable alarm tag index. This value of this tag determines
the low variable alarm limit.
Module
Module/Node Type
Node
Node List
2VAA000812R0001
4. Tag Configuration
Description
One State
PID Block
PID block address for tuning function (11 - 9998). Tuning block
number for CLIF tags (0 or 30 - 9998).
2VAA000812R0001
Primary Display
Print Alarm
Save Alarm
Save State
Change
Security Group
Security Level
4-31
4. Tag Configuration
Description
Span
SP Value Zero
String Length
Tag Description
Tag Descriptor 1
Tag Descriptor 2
Tag GUID
Tag Index
Tag Name
Tag Type
Three State
Transmit Acknowledge
Transmit Silence
Two State
Unit GUID
Unit GUID.
Unit Name
Unit name.
Unit Ndx
Unit index.
User Text
User text.
Value Zero
Zero State
NOTE:
1. The attributes applicable to a particular tag type are not necessarily required for every tag of that type.
For example, the alarm
inhibit attribute needs to be configured for only those tags needing the alarm inhibit functionality.
4-32
2VAA000812R0001
4. Tag Configuration
Entry
Applicable Attributes
Std
Fix
Var
Entry
Blank
A
0
1
2
3
H
L
HD
LD
2H
2L
3H
3L
DANG
High rate of change
Low rate of change
HR
LR
2VAA000812R0001
Nomenclature
Description
COMPUTER
N/A
IPT01
INIPT01, NGCM04
LCM01
NLCM01
LCM02
NLCM02
LCM03
NLCM03
4-33
4. Tag Configuration
Nomenclature
Description
MFC
IMMFC03/04/05,
NMFC01/02/03/04/05
MFP
IMMFP01/02/03/05
NPM
INNPM01
OIS10
IIOIS10
OIS40
IIOIS40/IIOIS41/IIOIS42
SBM
NSBM01
SCM
NSCM01,
NNIUO1
SEM
IMSEM01
SSM/ICT
INICT01, NSSM01
4-34
DEV_NUM
DEVSUBTYPE
Printer
Printer number (1 - 4)
Keyboard
Keyboard number (1 - 4)
MKI
EMKI
EMKI Track
ADP panel
Keyboard number (1 - 4)
ADP panel number (1 - 4)
Not applicable
Touch screen
Noncal Elograph
Calib Elograph
CIU
Not applicable
Not applicable
CRT
CRT number (1 - 4)
Not applicable
Clock
Not applicable
Battery
Satellite
Storage
Not applicable
SASI Winchester
SCSI Winchester
Floppy
Magtape
Optical Disk
2VAA000812R0001
5.1
Right click on the item in the project architecture that will contain the trend document.
NOTE: A trend document (no matter where it resides) can access all function blocks in all controllers in the project.
2.
Select New > Trend Document.
A new trend_document.tnd file will be added to the project architecture item.
To create a new trend document from within the trend window:
5.2
1.
2.
3.
4.
5.
5.3
Configure Trends
Configure a trend by:
Entering the address (control network, control unit, controller, and function block number) of the value being
trended.
Entering the maximum value, minimum value, and units configured in the function block.
A maximum of 16 trends can be configured and displayed. It is important to remember that all settings and actions
performed in this window do not effect the actual function blocks in any way.
5.3.1 Color
To select the color of the trend:
1.
2.
Select the desired color from the standard Windows color window and click OK.
5.3.2 Name
Enter an alphabetic text string (32,768 characters maximum) in the Tagname field. This name is only used in this window.
Configure the function block address by entering the appropriate information in the Control Network, Control
Unit, Controller, and Block fields.
2.
Enter the desired maximum value, minimum value, and engineering units (usually identical to that configured
into the function code) into the Maximum, Minimum, and Units fields.
Function block information is converted to a percentage (using the following formula) before it is trended.
[(actual_value - minimum_value)/(maximum_value - minimum_value)]100
2VAA000812R0001
5-1
Type
5.3.4 Type
All values can be trended as integers or real numbers. When trending using a real number type, plotted values will be
connected with a direct line. When trending using an integer type, a combination of horizontal and vertical lines connect
plotter points. To set the type, click in the Type field and select the desired type from the list.
5.3.5 Activation
Use the Scan field to enable or disable a trend.
5.4
Editing Trends
Any of the fields that define a trend can be changed at any time but changes only take affect after trending has been
stopped and restarted. Refer to Trend Window Operation for more information.
5.5
5.5.1 Start
To start trending:
1.
Use the trend on toolbar button to start trending the enabled trends.
2.
Select a logical computer interface when prompted.
All previous data is deleted. The Value field reflects the real-time value of the trend at the most recent data point.
5.5.2 Stop
Use the trend off toolbar button to stop trending and recording (refer to Record) of the data.
5.5.3 Pause
Use the pause toolbar button to pause the collection of data. Use the pause button again to resume data collection. The last
data point collected before pausing and the first data point collected after pause was cancelled will be connected with a line.
Data values that occurred while the display was paused are not collected and can not be displayed or recorded. All data
collected up to the time pause was used is still available when pause is cancelled.
5.5.4 Record
Trend data can be recorded to an ASCII text file for use by other software packages such as Excel. To start the recording of
trend window data:
1.
Click the trend and record on or record on (when trending is already started) toolbar button.
2.
3.
Specify the time interval that describes when the data is to be recorded. The available intervals are:
5-2
4.
Click Next.
5.
If the always interval was selected, proceed to Step 7. If the from start time interval was selected, specify a start
time in the dialog box. If the before stop time interval was selected, specify a stop time in the dialog box. If the
interval option was selected, specify a start and stop time in the dialog box.
6.
Click Next.
7.
2VAA000812R0001
Pan
5.5.5 Pan
The pan left, pan right, pan up, and pan down toolbar buttons allow the display to be panned in all directions. Use the undo
pan button to return to the default view.
5.5.6 Zoom
The zoom in and zoom out toolbar buttons allow the display resolution to be increased or decreased as required. Use the
undo zoom button to return to the default zoom setting.
5.5.8 Properties
There are five properties that affect a trend document. These properties are:
Y axis maximum.
Y axis minimum.
The properties of the currently opened trend document are accessed by selecting File > Properties.... Changes made to
these properties will be visible the next time the trend document is opened. The properties used when creating a trend
document are accessed by selecting Tools > Options. An explanation of the properties follows.
Samples Per Series
This property sets the maximum number of data points per trend that will be saved in the buffer. When the buffer is full, old
data points are lost to make room for new data points. This property multiplied by the number of active trends determines
the amount of memory needed to support the buffer.
NOTE: Use caution when setting the samples per series property and the number of active trends to prevent the buffer from using unacceptably large quantities of memory space.
Sample Rate (mSecs)
This property sets the rate at which data is collected.
Line Cursor Color
The color of the line cursor is set by this property. To change the color, click on the present color and choose a new color
using the standard Windows dialog box provided.
Y Axis Maximum
The maximum y axis percentage value displayed in the trend window when it is opened is set by this property.
Y Axis Minimum
The minimum y axis percentage value displayed in the trend window when it is opened is set by this property.
5.5.9 Print
To print a trend document:
1.
2.
3.
4.
5.
6.
Click Print.
2VAA000812R0001
5-3
5-4
2VAA000812R0001
6. Logs
Composer Event
6. Logs
The following topics describe how to configure Composer event logs and Conductor VMS custom logs from within
Composer.
6.1
Composer Event
The Composer event log records object actions such as:
Compile.
Add.
Delete.
Copy.
Modify.
Convert.
Export.
Import.
Download.
Save.
Verify.
Open.
Mode changes.
Tune.
Upload.
The event log is controlled by the log administrator and is usually disabled when the project is created. To set the event log
to by (by default) enabled, set:
HKEY_LOCAL_macliessoftware\abbAutomation\Composer\InstalledComposerSettings\EventLogixFaultStatus=1
If necessary, enable the event log using the instructions provided in this section. It is also possible to enable the event log
through the project property pages (advance tab) or while converting a project. The log can be viewed and the view can be
changed by any Composer user but only the log administrator can enable, disable, configure, or archive the log.
NOTE: There can be only one log administrator at a time. Once the current log administrator designates another log
administrator, the newly designated log administrator has sole control of the log.
NOTE: Changing a tag name generates a modify event identified with the new name.
NOTE: Messages generated by the copying and pasting a tag indicate the modified instead of copied.
6.1.1 Enable
To enable the event log after the project has been created:
1.
2.
3.
4.
If the log was enabled, enter the maximum size (in megabytes) of the log and the amount of available
memory space (in percent) being used before a warning message is generated.
5.
Click OK.
6.1.2 View
To view the event log, select View > Event Log from within the Composer window. The following data for each recorded
event is displayed:
Event message.
Cnet address.
Node address.
Controller ID.
6-1
Configure
6. Logs
1.
2.
Drag the column on top of the column that will be to the right of and adjacent to the desired position
of the moved column.
1.
Right click any column heading and select Modify View Sorting from the pop-up menu.
2.
Select a column that is part of the sort criteria from the fields list in the sort event by dialog box. and
click Add.
3.
If necessary, modify the sort order of the column by clicking ASC or DESC.
4.
Repeat Steps 2 through 3 for all the columns in the sort criteria.
5.
Arrange the columns in the desired order of precedence and click OK.
1.
Right click any column heading and select Modify View Fields from the pop-up menu.
2.
Move the appropriate columns to and from the available fields and selected fields lists until the
selected fields list contains the required columns.
3.
6.1.3 Configure
To specify which actions are to be recorded in the event log:
1.
2.
3.
4.
Choose the action for each event object type that is to be recorded (Y) or omitted (N).
5.
NOTE: The project must be closed and reopened before configuration changes take effect.
6.1.4 Archive
To archive the event log:
6-2
1.
2.
3.
2VAA000812R0001
6. Logs
6.2
4.
Specify a location and name for the archived event log file in the archive log data dialog box. If the
specified file (any .MDB file) already exists, it will be appended with the new information.
5.
Specify what is to be done with the data in the event log after the log is archived. Possible options
include clearing (deleting) all archived records from the log, only archiving the records (no deletion),
and clearing (no archiving) of the selected records.
6.
Choose the records to archive by filter the log by selected actions and objects, time, user, any
combination of these methods. When filtering by time, be sure to enable the check box to the right of
the time values being used.
7.
Click OK.
NOTES:
1. Log configurations created with the Composer interface must be converted to the appropriate format on the
human system interface. Refer to the appropriate human system interface for this information. There is no conversion
from human system interface format back to Composer format.
2. This is a DOS utility launched from the Composer interface.
3. Only one copy of the log configuration utility can be running.
4. When creating a log file for a PCV or Conductor VMS console, use the Import Document feature to get quick
access to the log file from the Composer Navigator. To enable this feature, the LOG.EXE program must be associated to .LF files using standard Windows procedures.
5. Log configurations created with WinTools do not get converted to Composer. Manually copy the files to the new
Composer project.
6.3
1.
In the Composer window, right click a human system interface and select New > Log....
2.
6.4
Enter the appropriate human system interface type and press ENTER.
6.5
1.
2.
At the prompt, type in the log number and press ENTER. The log configuration header screen
appears.
3.
Configure the log. Refer to Editing Existing Logs for more information.
4.
1.
2.
Enter the log number and press ENTER. The log configuration header screen appears with current
field information for this log.
3.
Fill in the log configuration header fields using the following table as an aid. Refer to Editing
Functions for information about field editing and cursor movement.
The following are general notes to observe when editing the log configuration header:
2VAA000812R0001
6-3
6. Logs
Not all fields are relevant to all log types. Make entries to only the pertinent fields.
Entry fields for pre-trip and post-trip periods pertain only to trip logs.
Valid Entries
Description
Log number
1 to 300
Log number.
Log status
Active
Inactive
Log name
Log description
Log type
Standard
Periodic
Trip
Trend log.
Snapshot log.
Trip log.
1 to 16
Number of columns
1 to 64
Number of columns.
Number of rows
1 to 250
Number of rows.
Number of retentions
0 to 9
Collection type
Demand
Event
Time
Print type
Demand
Event
Time
Collect
Yes/No
Count
Units
Up to 999.
Hours, minutes, seconds.
NOTE: For a periodic log, this time period
elapses before the log collects.
Example: To have a periodic log collect
upon the occurrence of an event, configure
the log to collect upon the trigger event, and
configure the collection period to be zero.
6-4
Count
Units
Up to 999.
Hours, minutes, seconds.
Time
Count
Units
Up to 999.
Hours, minutes, seconds.
2VAA000812R0001
6. Logs
Valid Entries
3H
2H
H
N
(blank)
L
2L
3L
Description
Trigger on 3H condition.
Trigger on 2H or 3H.
Trigger on H, 2H, or 3H.
Trigger on return to normal condition.
No trigger.
Trigger on L, 2L, or 3L.
Trigger on 2L or 3L.
Trigger on 3L conditions.
Refer to Analog Collection Trigger Conditions for further explanation.
Boolean collection
trigger conditions states
Boolean collection
trigger alarm status
3H
2H
H
N
(blank)
L
2L
3L
Trigger on 3H condition.
Trigger on 2H or 3H.
Trigger on H, 2H, or 3H.
Trigger on return to normal condition.
No trigger.
Trigger on L, 2L, or 3L.
Trigger on 2L or 3L.
Trigger on 3L condition.
Refer to Analog Print Trigger Conditions
for further explanation.
Boolean print
trigger alarm status
2VAA000812R0001
6-5
6. Logs
Valid Entries
Military format
13:00 = 1:00 pm
Description
Time of first collection.
NOTE: For a periodic log, the actual
collection of the first snapshot is the log
starting time minus the length of one
collection period. This field should not be
used for a trip log.
Example: To have a periodic log collect at
1:00 and once an hour thereafter, the log
starting time must be 12:00 and the
collection period must be one hour.
Time
Depending upon collection type, entry fields for collection trigger tags and trigger conditions may or may not be
utilized.
Depending upon print type, entry fields for print trigger tags, print times and trigger conditions may or may not be
utilized.
Changing row and column size on existing logs adds and deletes cells as required. Be careful not to inadvertently
delete information from an already created log.
Log configuration does not have access to the tag or trend lists. Therefore, give the tag index when assigning data
to the Collection Trigger Tag and Print Trigger Tag fields; and select the tag type when changing the tag index and
leaving the field. There are a maximum of 25 tag types (not all are valid.) Press + or - until the correct type appears.
During log definition entry, only valid fields for user entries are displayed; invalid fields are blanked out.
At the present time, logs are limited to approximately 12,000 cells (240 rows by 50 columns, or 187 rows by 64
columns.
NOTE: When a log is activated, validity of the log header configuration is checked. If any field is not configured correctly, an error message is displayed and the cursor (input field) appears at the wrong data field to prompt the user for
correction.
Cells
4.
From the log configuration header screen, press F3 to activate the edit cell screen.
5.
Position the cursor on the cell to be edited. Use the following keys to move the cursor about the cell
fields.
6.
Choose the appropriate cell type by making a selection from the menu at the bottom of the cell
configuration screen. This brings up submenus in order to record additional information about the cell
type. Refer to Cell Types for more information.
7.
For fields that the human system interface permits entry of either the tag name or the index, use only
the tag index. Use + and - to scroll through and select from available entries.
8.
Compress the ASCII space. Refer to Compressing ASCII Space for more information.
9.
When log configuration is complete, save the log by returning to the log header configuration display
or the log configuration/help menu.
The edit cell screen also provides cell editing functions such as:
Delete Cell
Position the cursor on the cell and press K.
Define Column Width
Press L. This defines the width of each of the columns of the log. (Columns default to a width of six printable characters.)
Column widths are used to determine the starting point for each column and for justifying values within a column field. ASCII
text, time and date, offset time, and tag configuration data type cells are allowed to cross column boundaries for ease of
definition.
6-6
2VAA000812R0001
6. Logs
Cell Types
Copy Cell
Press M. This copies one cell definition to another. Enter the row and column of the source cell (defaulted to the currently
selected cell) and the row and column of the destination cell (also defaulted to the currently selected cell). Pressing ENTER
performs the function, pressing ESC returns to the cell definition menu without performing the function.
Copy Row
Press N. This copies one entire row to another row. The default destination and source rows are the same as the currently
selected row. The function copies the entire source row of cell definitions to the destination row cell definitions.
Copy Column
Press O. This copies one entire column of cell definitions to another. The default source and destination columns are the
same as the currently selected column.
Copy Log
Press Q. This copies an entire log definition to another log definition file. The source log is the log currently being defined or
reviewed; the destination log must be specified.
Control Description
C0
C1
Turn compressed print on (allows maximum of 200 characters per line). C1 puts the
printer into compressed mode and leaves it in compressed mode. The printer is not
reset to normal mode (132 characters per line) by the printing of another log. To
configure this log only to be printed in compressed mode, use a C0 command as the
last cell printed.
The color in the custom configured logs can be specified through an ASCII cell definition. For example, the escape
sequence %K2 sets the color output to red. This escape sequence does not occupy any character position in the actual
output. Other color escapes are listed in the following table.
The number denoting the color is terminated by any nondigit character. If the nondigit character is %, it is not in the output.
This % character acts as the terminating character for the color, and allows a numeric character to be output immediately
following the color escape sequence.
2VAA000812R0001
Color
Sequence
Color
%K0
Black
%K6
Magenta
%K2
Red
%K7
Yellow
%K3
Green
%K12
Blue-magenta
%K5
Cyan
6-7
Cell Types
6. Logs
Description
Trend index
Offset time of
first cell
Resolution
Number of
Number of consecutive cells to be defined as trend cells.
consecutive cells Must not exceed maximum cells in row or column.
Direction of cells Specifies how consecutive cells are to be defined.
Vertical = down a column.
Horizontal = across a row.
Single or multiple trend cells can be defined. When defining multiple cells, the starting cell is the current cell. When using
the feature # of Consecutive Cells and the Resolution (log generator will then copy trend cells with an offset), log data
values are listed in ascending time order from either the starting time or earliest value of the log. Therefore, it is not possible
for the data in a log to be printed in reverse chronological order using this feature.
6.5.1.5 Alarm/Quality
Alarm and quality specifies a tag name or index in order to get the alarm and quality status for that tag. This status can only
be associated with tag values (snapshot values), not trended values. Trended values do not carry along a status. In
addition, a status field width of either one or three characters can be specified. A three character field will have two
characters for the alarm status and one character for the quality. It is treated in a similar fashion to the five character alarm
and quality field in the human system interface display subsystem, minus the two characters for the alarm group. A one
character field will have an abbreviated alarm status, overridden by bad quality, similar to a one character alarm and quality
field in the human system interface display subsystem.
6.5.1.6 Formula
Formula defines a cell to be a function of other cells. Specifically, a cell can be defined to be the sum of a row or column, the
average of a row or column, a minimum of the row or column, or the maximum of the row or column.
Formula cells perform calculations on all cells within the row or column of tag value, trend value or constant cell types. If any
one of the cells involved in the calculation is bad quality, it is omitted from the calculation. The resulting formula cell value is
marked with the suspect indicator ?. The suspect indicator is the fourth item choice in the alarm quality configuration text
set. This indicator overwrites the right-most character (least significant digit position) of the formula cell field.
NOTE: The formula includes all values in a given row or column, not just those values above the sum. For example,
if a sum for a column resides above the formula for the average of the same column, the sum will be included in the
average.
6-8
2VAA000812R0001
6. Logs
Cell Types
Date
Format
Example
Time
16:32:00
Date
19-JUL-94
Day
Tuesday
Time/date
16:32:00 19-JUL-94
Time/day
16:32:00 Tuesday
Date/day
19-JUL-94 Tuesday
Time/date/day
Day-month-year
19-JUL-1994
Month-day-year
JUL-19-1994
Year-month-day
1994-JUL-19
The following describe the log start time for the log types:
Standard (trend) - time that the log starts collecting. Normally, the first trend cell is offset zero from the log start time. In this
case, the log start time is also the time of the first trend cell.
Trip - time of the event.
Periodic (snapshot) - time the snapshot was made.
The following describe the current time for the log types:
Standard - time that collection of the log is complete. This does not include the processing time required to format the log
for printing.
Trip - time that collection of the log is complete, i.e., the time of the latest post-trip data that has been collected. This time
does not include processing.
Periodic - time that collection of the log is complete. This does not include the processing time required to format the log for
printing.
Example
HH:MM:SS
12:30:00
HH:MM
12:30
DATE HH:MM
20 12:30
MM:SS
30:00
To configure a log that has 24 trend values and has the offset time shown beside each trend, enter count as one (hour) and
number of cells (24), and select the direction (vertical or horizontal). After pressing ENTER, 24 offset cells with the correct
offset value in each cell are created.
2VAA000812R0001
6-9
6. Logs
At collection completion for the 11:30 am collection, the log will be rescheduled for final collection at 1:00 pm, if
current time is prior to 1:00 pm.
At collection completion for the 11:30 am collection, if current time is 1:01 pm, then the log will be rescheduled for
final collection at 2:30 pm.
If current time is 3:00 pm, then the log will be rescheduled for final collection at 4:00 pm.
If 2H is specified, the trigger occurs when the tag goes to the alarm states 2H or 3H from non-2H or non-3H alarm
states.
If 2H and 3H are specified for conditions one and two, the trigger occurs when the tag goes to the alarm states 2H
or 3H from non-2H or non-3H alarm states. The second condition at 3H is redundant.
If H and L are specified, the trigger occurs when the tag goes from normal into alarm (H, 2H, 3H for condition one;
L, 2L, 3L for condition two).
6-10
If 2H is specified, the trigger occurs when the tag goes to the alarm states 2H or 3H from non-2H or non-3H alarm
states.
If 2H and 3H are specified for conditions one and two, the trigger occurs when the tag goes to the alarm states 2H
or 3H from non-2H or non-3H alarm states. The second condition at 3H is redundant.
2VAA000812R0001
6. Logs
6.6
If H and L are specified, the trigger occurs when the tag goes from normal into alarm (H, 2H, 3H for condition one;
L, 2L, 3L for condition two).
6.7
Saving Logs
NOTE: Before saving a log, be sure to compress ASCII space first. Refer to Compressing ASCII Space.
To save a log from the log configuration main menu, press F7.
To save a log from the log configuration header screen, press F4.
6.8
Editing Functions
Use the following keys and guidelines when editing log fields.
HOME
Goes directly to column one, row one.
Moves the cursor to a specific field for
, , ,
and
editing and to bring off screen cells into
view.
Moves the cursor within a text field or
CTRL-
scrolls through available selections in
and
fields that have a fixed number of
CTRL-
selections.
+ and Scrolls through available selections in
fields that have a fixed number of
selections. These keys are on the
numeric keypad.
Goes to the next or previous group of
PAGE UP
and
eight rows (the column position
PAGE
remains unchanged).
DOWN
In variable fields (Log Name, Description, and Collection Trigger Tag), type in numeric or alphanumeric information. In fields
with system choices (Log Type, Collection Type, Print Type, etc.), use + and - on the numeric keypad to scroll through
available selections.
6.9
Exporting Logs
To transfer a log from one human system interface to another:
1.
Right click the human system interface and select Export > Logs....
2.
Enter the location to receive the exported logs in the export logs dialog box and click OK.
2VAA000812R0001
6-11
Exporting Logs
6-12
6. Logs
2VAA000812R0001
7. Example Configuration
Introduction
7. Example Configuration
7.1
Introduction
This section describes the configuration of a simple project from the Composer window.
7.2
HARMONY
C O NTRO L
U N IT
H C U _O N E
HARM ONY
CONTROL
U N IT
H C U _T W O
C O N D U C TO R V M S
H U M A N S Y S T E M IN T E R FAC E
H S I_O N E
C O N D U C TO R N T
H U M A N S Y S T E M IN T E R FAC E
H S I_T W O
(C O N TA IN S T W O G R O U P S O F
D IS P LAY S A N D O N E TAG LIS T.
G R O U P _O N E C O N TA IN S D IS P LAY S
P U M P _R O O M , C O M P R E S S O R _O N E ,
R E AC TO R _O N E , R E AC TO R _T W O.
G R O U P _T W O C O N TA IN S D IS P LAY
E X H AU S T _M O N ITO R . TAG LIS T
H S I_O N E _TAG S C O N TA IN S T H E
R E Q U IR E D TAG S.)
(C O N TA IN S F U R N AC E _O N E
D IS P LAY S A N D A TAG LIS T.
TAG LIS T H S I_T W O _TAG S
C O N TA IN S T H E R E Q U IR E D TAG S .)
HARM ONY
C O NTRO LLER
C O N T R O L_O N E
HARM ONY
C O N T R O LLE R
C O N T R O L_T W O
(C O N T R O L_O N E IS
C O N F IG U R E D U S IN G
C O N T R O L LO G IC
DOCUM ENTS
C LD _O N E , C LD _TW O,
A N D C LD _T H R E E .)
(C O N T R O L_T W O IS
C O N F IG U R E D U S IN G
C O N T R O L LO G IC
DOCUMENT
C LD _F O U R .)
T 020 38A
7.3
Configuration Procedure
This procedure is divided into five parts. These parts are:
1.
2.
Enter the location where the project will be stored in the Location field of the dialog box.
3.
PLANT_ONE
4.
Click OK.
5.
2VAA000812R0001
7-1
6.
7.
7. Example Configuration
NETWORK_ONE
8.
Click OK.
1.
2.
3.
HCU_ONE
4.
Click OK.
5.
6.
7.
CONTROL_ONE
8.
10
9.
C1
12. Click OK.
13. Right-click the controller (CONTROL_ONE).
14. Select New > Logic Document....
15. In the name field, type:
CLD_ONE
16. Click OK.
17. Right-click the controller (CONTROL_ONE).
18. Select New > Logic Document....
19. In the name field, type:
CLD_TWO
20. Click OK.
21. Right-click the controller (CONTROL_ONE).
22. Select New > Logic Document....
23. In the name field, type:
CLD_THREE
24. Click OK.
7-2
1.
2.
7. Example Configuration
3.
HCU_TWO
4.
Click OK.
5.
6.
7.
CONTROL_TWO
8.
8
9.
C2
12. Click OK.
13. Right-click the controller (CONTROL_TWO).
14. Select New > Logic Document....
15. In the name field, type:
CLD_FOUR
16. Click OK.
1.
2.
3.
HSI_ONE_TAGS
4.
Click OK.
5.
6.
7.
HSI_ONE
8.
5
9.
In the HSI Type and Rev field, select Conductor VMS 4.0 from the list provided.
10. In the Tag List field, select HSI_ONE_TAGS from the list provided.
11. Select the FTP settings tab.
12. Click Add FTP Site.
13. In the FTP Site Description field, type:
HSI_ONE WORKSTATION
14. In the Computer Name or IP Address field, type:
HSI_1
15. In the User Name field, type:
2VAA000812R0001
7-3
7. Example Configuration
OISENGR
16. In the Password and Retyped Password fields, type:
OISENGR
17. Click OK.
18. Right-click the human system interface (HSI_ONE).
19. Select New > Display Group....
20. In the name field, type:
GROUP_ONE
21. Click OK.
22. Right-click the display group (GROUP_ONE).
23. Select New > Display....
24. In the name field, type:
PUMP_ROOM
25. In the Export File Name field, enter the display file name the human system interface will use to call
this display by typing:
PUMP_RM
26. Click OK.
27. Right-click the display group (GROUP_ONE).
28. Select New > Display....
29. In the name field, type:
COMPRESSOR_ONE
30. In the Export File Name field, enter the display file name the human system interface will use to call
this display by typing:
CMPRSR_1
31. Click OK.
32. Right-click the display group (GROUP_ONE).
33. Select New > Display....
34. In the name field, type:
REACTOR_ONE
35. In the Export File Name field, enter the display file name the human system interface will use to call
this display by typing:
REACTR_1
36. Click OK.
37. Right-click the display group (GROUP_ONE).
38. Select New > Display....
39. In the name field, type:
REACTOR_TWO
40. In the Export File Name field, enter the display file name the human system interface will use to call
this display by typing:
REACTR_2
41. Click OK.
42. Right-click the human system interface (HSI_ONE).
43. Select New > Display Group....
7-4
2VAA000812R0001
7. Example Configuration
GROUP_TWO
45. Right-click the display group (GROUP_TWO).
46. Select New > Display....
47. In the name field, type:
EXHAUST_MONITOR
48. In the Export File Name field, enter the display file name the human system interface will use to call
this display by typing:
XHST_MTR
49. Click OK.
1.
2.
3.
HSI_TWO_TAGS
4.
Click OK.
5.
6.
7.
HSI_TWO
8.
15
9.
In the HSI Type and Rev field, select Conductor NT 2.3 from the list provided.
10. In the Tag List field, select HSI_TWO_TAGS from the list provided.
11. In the Server Group field, type:
S2
12. Select the FTP Settings tab.
13. Click Add FTP Site.
14. In the FTP Site Description field, type:
HSI_TWO WORKSTATION
15. In the Computer Name or IP Address field, type:
HSI_2
16. In the User Name field, type:
EXAMPLE_USER
17. In the Password and Retyped Password fields, type:
EXAMPLE
18. In the FTP Destination Directory field, type:
FTP_FILES
19. Click OK.
2VAA000812R0001
7-5
7. Example Configuration
Figure 7-2 shows what the Composer window should look like after completing the example project configuration.
TC00979A
7-6
2VAA000812R0001
8. Miscellaneous Procedures
8. Miscellaneous Procedures
The following topics describe the procedures for:
8.1
8.2
1.
2.
Select the project to copy these items from by entering the full path in
the Source Project field or navigating to it via the File button.
3.
4.
Click Display to search the source project for user views, filters, and
replace specifiers which will be listed in the listbox to the left of the
Display button.
5.
Select the items in the listbox that are to be copied and click Copy. A
message box will indicate how many items were copied to the
destination project.
2VAA000812R0001
Procedure
8. Miscellaneous Procedures
8.2.2 Procedure
1.
Create a PROJECT.PRJ file. The Composer conversion program requires a WinTools 2.x
project file. A dummy project file can be created by completing the following steps.
a. Create a directory for the project. Create an ASCII text file using Microsoft Notepad or WordPad with the extension .prj as shown below:
C:\\aproject\aproject.prj
b. Type or cut and paste the following four lines of text into the project file:
[Main]
Description=Aproject
JHD=
TDT=TDT\Aproject
c.
Create the appropriate directory structure. WinTools 2.x manages the user's configuration in a
directory structure that reflects the hierarchy of the control system. Composer's conversion utility
depends upon this directory structure. The directory structure created here will be used to establish
the system architecture of the Composer project. Once the configurations have been imported, the
hierarchy can be modified in Composer.
a. Create a directory for each control network (INFI-NET or Super-Loop) in the system. Loop directories must be
named as L1, L2 L250. For example:
C:\Aproject\L1
b. Create a directory for each operator console on the project where the number that appears after Cons reflects the
node address of the console on the INFI-NET. Console directories must be named as Cons1, Cons2 Cons250. For
example:
C:\Aproject\L1\Cons1
c. Create a Microsoft Notepad or WordPad ASCI text file document named Console.cfg for each console. For
example:
C:\Aproject\L1\Cons1\Console.cfg
d. Type or cut and paste the following eight lines of text into the Console.cfg file.
[Console]
OIS_TYPE= 43
OIS_REVISION=J1
DRIVE_TYPE= 7
Description=
TagList=
TrendList=
ReportPointList=
NOTE: The console type and revision is not important at this point. The console properties can be modified in Composer after the conversion.
e. Save and exit the file.
8-2
2VAA000812R0001
8. Miscellaneous Procedures
f. Create a directory for each console symbol group on the project. Console symbols directory names must end with
.dys.
g. Move symbol .dy files to the console symbol directory. For example:
C:\Aproject\L1\Cons1\Symbols1.dys
h. Create a directory for each console display group on the project. Console displays directory names must end with
.drs.
i.
Move display .drs files to the console display directory. For example:
C:\Aproject\L1\Cons1\Displays1.drs
j. Create a directory for each operator PCU on the project. PCU directories must be named as P1, P2 P250. For
example:
C:\Aproject\L1\P2
k.
Move Cadews libraries that are common to all the models in this PCU to this directory.
l. Create a directory for each operator module on the project. Module directories must be named as M1, M2
M30). For example:
C:\Aproject\L1\P2\M5
3.
a. Run Composer Convert to convert the dummy project created in Step 1 into a Composer Project.
b. Use the tag list import feature of Composer to import the tag database.
NOTE: The tag synchronization will not take place until the graphic displays have been opened and saved in Composer.
8.3
1.
Run DCOMCNFG.
2.
3.
4.
On the Location tab, check the Run application on this computer checkbox and be sure the other
check boxes are left unchecked.
5.
On the Security tab, select Use custom access permissions and then edit the custom access
permissions by clicking Edit.
6.
Be sure the custom access permissions include everyone with access permission.
7.
On the Security tab, select Use custom launch permissions and then edit the custom launch
permissions by clicking Edit.
8.
Be sure the custom launch permissions include everyone with launch permission.
9.
On the Security tab, select Use custom configuration permissions and then edit the custom
configuration permissions by clicking Edit.
10. Be sure the custom configuration permissions include CREATOR OWNER and SYSTEM with full
control permission. Everyone should have read permission. INTERACTIVE gets special access with
the following options checked:
Query value.
Set value.
Create subkey.
2VAA000812R0001
8-3
8. Miscellaneous Procedures
Enumerate subkeys.
Notify.
Delete.
Read control.
11. On the Identity tab, select This User and enter the login id and password of a user with administrator
access to this machine.
8.4
Composer has the ability to pack or unpack CLDs (tip revisions only) from within the Navigator (Project Explorer) itself.
Packing and unpacking can be done without the time required to start the Revision Manager. It also incorporates optimized
operation that improves performance and stability.
The Revision Manager Power Tool is still available and has not been changed; users can still pack and unpack CLDs using
that tool if desired. Since the Navigator Pack only works on tip revisions, users will need to use the Revision Manager if they
need to pack other revisions of CLDs.
8.4.1 Pack
The pack operation prepares selected CLDs for archiving or transport to another project. To pack the tip (latest) revision of
CLDs:
1.
Right click the project, control network, control unit, or controller node containing the CLDs
and select Pack. A message is displayed and the pack operation is cancelled if no CLDs
exist on the selected node.
2.
Select the CLDs to be packed by placing a check mark in the check box next to the CLD in the Pack
Selection window. Multiple CLDs can be check marked by using standard Windows multi-select
methods, right clicking the selected CLDs, and selecting Check on the context menu. Use the Select
All CLDs to Pack option to check mark all CLDs.
3.
Click Next.
4.
Enter (or select) the path and name of the .epg file created by the pack operation in the Pack Options
window. This file contains information about the packed CLD files. It is recomended that this location
be a new or empty directory.
5.
If desired, enable the Automatically create a revision for each CLD option to create a new revision of
each selected CLD in the source project (as a backup or to document which revision was packed)
before the pack operation takes place. When creating revisions, the Create revision information
option can be used to manually specify revision information. If this option is not enabled, revision
information will be extracted from the tip revision.
6.
Click Pack. A progress window displays the progress of the pack operation. Information about the
operation is also displayed in the Composer Navigator output window. The .epg file and the packed
CLDs are located in the selected location (Step 4) when the pack operation completes. The epg file
and packed CLDs can then be zipped and/or transferred to other Composer workstations for
unpacking.
8.4.2 Unpack
The unpack operation imports CLDs from another project into this project and makes them the tip revision. It is recomended
that the destination project be backed up before unpacking and the unpack take place when no other users are making
changes (copying, importing, unpacking, etc.) to the project. To unpack CLDs:
8-4
1.
2.
Select the .epg file to unpack in the Open window and click Open.
2VAA000812R0001
8. Miscellaneous Procedures
3.
Unpack
Select the CLDs to be unpacked by placing a check mark in the check box next to the CLD in the
UnPack CLD Selection window. Multiple CLDs can be check marked by using standard Windows
multi-select methods, right clicking the selected CLDs, and selecting Check on the context menu.
Use the Select All CLDs to Unpack option to checkmark all CLDs. Composer 5.1 also provides
additional options to select subsets of CLDs listed in the pack file.
NOTE: By default the unpack operation replaces the tip revision of the CLDs unpacked. Making a backup of CLDs
before unpacking is strongly recommended. Backups of the entire project should be made on a regular basis.
4.
If desired, enable the Pack selected CLDs before unpacking from pack file option to save the current
tip revision of these CLDs (the CLDs found in the project receiving the unpacked CLDs) before the
unpack operation is started.
5.
If desired, enable the Create a new revision for each selected CLD before unpacking option to create
a new revision (in the destination project) of each of the CLDs to be unpacked before the tip revision
is replaced.
6.
Click OK.
7.
If either or both of the backup options has been checked, The Unpack Options window is displayed.
If the Pack selected CLDs before unpacking from pack file option was enabled, enter the location and
name of the backup .epg file. If desired, enable the Default Filename option to enter a location for the
backup pack file in the form: <current project directory>\Backup <timestamp>\Backup.epg where
<current project directory> is the drive and path of the project, and <timestamp> is the current date
and time, make the location unique.
If the Create a new revision for each selected CLD before unpacking option was enabled, revision
information can be manually specified or extracted from the tip revision.
8.
Click OK. A progress window displays the progress of the unpack operation. Information about the
operation is also displayed in the Composer Navigator output window.
NOTE: Due to performance enhancements built into theunpack operation, it will continue to completion once OK is
clicked. If this operation is interrupted, restore the backed up or packed CLDs corresponding to the CLDs that
were to be unpacked or restore the destination project from a backup.
The project now contain the CLDs from the pack file as the tip revisions of the CLDs in the project when the unpack
operation completes. Additionally:
If the Pack selected CLDs before unpacking from pack file option was enabled, the backup .epg file is saved to the
specified location.
If the Create a new revision for each selected CLD before unpacking option was enabled, revisions of the selected
CLDs are will be in the history for each CLD.
2VAA000812R0001
8-5
Unpack
8-6
8. Miscellaneous Procedures
2VAA000812R0001
Configuration Files
9.1
Configuration Files
Configuration files (.cfg) can be opened, uploaded from a controller, edited, downloaded to a controller, verified, saved, and
printed.
9.1.1 Close
To close a configuration file, select File > Close Configuration.
9.1.2 Download
To load the configuration currently displayed in the Configuration Viewer window to a controller:
1.
2.
Enter the controller address information in the Download Configuration to Controller window and click
OK.
9.1.3 Open
To open a configuration file for viewing, editing, etc.:
1.
2.
Select the desired configuration and click Open in the standard windows browse window.
9.1.5 Upload
To load the contents of a configuration file from a controller for viewing, editing, etc.:
1.
2.
Enter the controller address information in the Upload Configuration from Controller window.
3.
Choose to upload all the function blocks in the configuration (enable All Blocks option) or just the
specified blocks (single block number, range of block numbers, or a comma-delimited list of block
numbers), and click OK.
9.1.6 Verify
To compare the file information in the Configuration Viewer to the configuration file information in another controller or
configuration file:
1.
2.
Choose to compare the file information in the Configuration Viewer to information in a controller (Use
Other Controller) or another configuration file (Use External Config File) in the Verify window.
3.
a. Enter the address of the controller in the Separate Controller area and click Test Controller.
b. If Composer has not already connected to the controller, select the appropriate logical ICI and click OK in the
Select Logical ICI Window.
c.
Proceed to Step 5.
4.
9-1
5.
9.2
Click OK in the Verify window and wait for the comparison results to be displayed in the output
window.
9.2.1 Add
To add a function block to the configuration:
1.
Right click anywhere in the configuration viewer window and select Add Block.
2.
Enter the function code number in the add function code dialog box.
3.
9.2.2 Delete
To delete a function block from the configuration, right click the function block to be deleted and select Delete Block.
9.2.3 Read
To read specific function blocks or a range of function blocks and their specifications:
1.
Right click the function block or anywhere in the configuration viewer window and select
Read Block Range.
2.
3.
Enter the function block numbers or range of numbers in the read block range dialog box and click
OK. Separate numbers or ranges of numbers with commas. Use a hyphen to separate beginning and
ending range numbers.
9.2.4 Modify
To modify the specifications of a function code:
1.
Right click the function block containing the function code to be modified and select Modify
Specs.
The spec edit dialog box appears. This dialog box shows the function block number and all the specifications that can be
modified. The specifications for all function codes can be filtered by selecting one of the following filters.
All
Displays all usable specifications.
Inputs
Displays only input specifications.
Internal
Displays only internal specifications.
Tunable
Displays only tunable specifications.
Online Configuration
Displays only online configuration specifications.
Depending on the function code, more filters are available. These filters include:
Analogs
Digitals
Failure Def
Hardware
Input
Input Addrs
Masks
Min/Max
9-2
2VAA000812R0001
Tune
Module
Output
Output Addrs
Port Def
Signal
Simulation
Thermocouple
Times
Tune Params
Z11 - Z15
Z21 - Z25
Z31 - Z35
Z41 - Z45
Z51 - Z55
2.
3.
Edit the value of the specification as desired. The Minimum, Maximum, and Default buttons set the
value to the indicated number. The Default All button sets all the specifications to their default values.
4.
Click OK.
Locking a specification in the control logic document but does not prevent it from being changed in the controller. This
allows for situations where immediate or temporary specification changes are required. As such, the configuration viewer
allows any specification to be changed whether it is locked or not when the source is a CFG file or a controller. However,
when trying to change locked specifications whose source is a CLD or group of CLDs, the Configuration Viewer window will
allow the specification values to be changed on screen only. Click OK and an error is displayed and all of the specifications
will return their previous values. If the user changes one locked specification and one non-locked specification and then
clicks OK, both of the specification values will be returned to their previous state.
9.2.5 Tune
To tune the specifications of a function code:
1.
Right click the function block containing the function code to be tuned and select Tune
Specs.
The dialog box shows the function block number and all the specifications that can be tuned. Use the specification filters
(refer toModify Specifications on page 62 to search for the specification to be tuned.
9.3
2.
3.
Tune the value of the specification as desired. The Minimum, Maximum, and Default buttons set the
value to the indicated number. The Default All button sets all the specifications to their default values.
4.
Click OK.
9.3.1 Connect
To connect the Configuration Viewer window to the runtime system (through the Composer server):
1.
2.
Select the logical computer interface module to be used from the list provided in the select logical ICI
dialog box.
3.
Click OK.
The status shown in the lower right corner of the window will change from Not Connected to Connected when a complete
connection to the run-time system has been made. The information transferred across this connection is module status,
module state, etc.
9.3.2 Configure
The first runtime task that must be done is telling the Configuration Viewer window which path to use when connecting to
the Composer server application. This server is in turn connected to the runtime system through a computer interface
module. To configure a Configuration Viewer window for runtime operation:
2VAA000812R0001
9-3
Disconnect
1.
Select Runtime > Configure. This will launch the Harmony System Configuration tool,
hSysCfg.
2.
Select the number of the logical computer interface module (actually a path) being used by the
Composer client in the ICI configuration dialog box.
3.
4.
Enter the IP address of the Composer server node that will supply the run-time information.
5.
Select the protocol used to communicate between client and server. Local protocol is selected when
client and server are located in the same computer. TCP/IP protocol is selected when the client and
server are located in different computers.
6.
Enter the name or number of the server computer communication port through which the client
communicates. This field is only used when the TCP/IP protocol is used.
7.
Click OK.
9.3.3 Disconnect
To disconnect the Configuration Viewer window from the Composer server (and the runtime system), select Runtime >
Disconnect. The connection status in the lower right corner of the window will change to Not Connected when this operation
is complete.
9.3.4 Restart
To restart the computer interface module used by the Composer server in the path (logical ICI) selected during the
connection process, select Runtime > Restart.
9-4
2VAA000812R0001
Configuration
10.1 Configuration
The Composer prelaunch service must be configured by the service administrator on each Composer workstation before it
will function on that workstation. All other users will only be able to view the configuration settings. To configure the
Composer prelaunch service on a workstation:
1.
Determine the name and password of the user configuring this service if this was not
already configured during installation. This user must:
a. Have access to all Composer projects to be prelaunched wherever they may be located in the file system or network.
b. Be an administrator on this workstation.
NOTE: Use this account only for configuring the Composer prelaunch service.
NOTE: It is recommended that the 800xAService account be used when installing Composer software on 800xA system workstations.
2.
Select Start > All Programs > ABB > Composer > Composer Prelaunch Service Configuration.
3.
If the prelaunch service administrators name and password were not specified during installation,
enter them in the Configure a Username and Password window and click OK.
4.
Select up to five projects to be prelaunched and click Launch Objects Now on the Projects tab.
5.
A window stating that not all changes will be applied until all logged on users log off or execute the
Composer Prelaunch Logon Agent application (available from the Start menu) is displayed. Select
the appropriate answer when asked if these changes should still be made.
NOTE: If the configuration changes are made, notify all currently logged on users that they need to log off and log
back in (or run the Composer Prelaunch Logon Agent application) in order to utilize the configuration changes.
6.
Enable the Replace Claimed Objects option (on the Options tab) if prelaunched applications are to be
replaced as they are handed off to Composer. The next time Composer opens that project, there is a
prelaunched version ready and waiting. Without this option enabled, only the first time Composer
opens that project will the prelaunched version be available.
7.
Select the History tab and verify the prelaunched process history is as desired. The following table
describes the displayed columns. If necessary, select an application that has not been handed off to
Composer and click Shutdown Selected Object to close the application. The Refresh List button
retrieves the application list from the Composer prelaunch service. The Clear Inactive Objects button
removes all applications that:
- or -
2VAA000812R0001
10-1
c.
Have been shut down using the Shutdown Selected Objects button.
NOTE: If a prelaunched process fails (indicated by a timestamp in the Failure Time column on the History tab), check
the Windows Application Event Log for error messages from DBSPrelaunchSvc for details.
Description
Type
Project Path
Owner
Object PID
Composer PID
Start Time
Handoff Time
Failure Timestamp Date and time the application was closed due
to an error.
1.
Determine the name and password of the new service administrator. This user must:
a. Have access to all Composer projects to be prelaunched wherever they may be located in the file system or network.
b. Be an administrator on this workstation.
NOTE: Use this account only for configuring the Composer prelaunch service.
NOTE: It is recommended that the 800xAService account be used when installing Composer software on 800xA system workstations.
2.
Select Start > All Programs > ABB > Composer > Composer Prelaunch Service Configuration.
3.
Select the Options tab, enter the desired user name and password, and click OK.
NOTE: If the password for the user account that is the Prelaunch Administrator changes, the password must also be
changed on the Log On tab of the Service Properties of the Prelaunch Service and saved before the Prelaunch Service will use the new password.
10-2
2VAA000812R0001
Table 11-1 Taglist Structures (R1, S1, T1, V1, X1, S1U, X1U, and X2U)
Field
Number
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
2VAA000812R0001
Field Name
TAGINDEX
TAGNAME
TAGDESC
CUSTTAGID
TAGTYPE
EUDESC
EUINDEX
VAL0
SPAN
SETPTVAL0
NUMDECPL
ZEROSTATE
ONESTATE
TWOSTATE
THREESTATE
FB1_0STATE
FB1_1STATE
FB2_0STATE
FB2_1STATE
FB3_0STATE
FB3_1STATE
FB4_0STATE
FB4_1STATE
LOOP
PCU
MODULE
BLOCK
ALMSTATE
ALARMTYPE
HALARM
H2ALARM
H3ALARM
LALARM
L2ALARM
L3ALARM
ALARMDB
HVARALMTAG
H2DELTA
H3DELTA
LVARALMTAG
L2DELTA
L3DELTA
ALMINHTAG
ALMINHST
PRIMDISP
Type
Width
Numeric
Character
Character
Character
Character
Character
Numeric
Numeric
Numeric
Numeric
Character
Character
Character
Character
Character
Character
Character
Character
Character
Character
Character
Character
Character
Numeric
Numeric
Numeric
Numeric
Character
Character
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Character
Character
5
14
32
32
7
6
3
11
11
11
6
6
6
6
6
6
6
6
6
6
6
6
6
3
3
2
4, 51
6
3
11
11
11
11
11
11
11
5
11
11
5
11
11
5
2
8
Tag List
Versions
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
11-1
Table 11-1 Taglist Structures (R1, S1, T1, V1, X1, S1U, X1U, and X2U) (Continued)
Field
Number
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
11-2
Field Name
ALMGROUP
ALMACKBC
ALMACKNL
ALMACKTR
ALMSILTR
ADSKEYBD
ADSPANEL
ADSLAMP
PR_ALARM
SV_ALARM
PR_STCHNG
SV_STCHNG
PR_OPACT
SV_OPACT
MODTYPE
MODREV
APTASK
APSTATE
TP0TYPE
TP1TYPE
ARCHIVE
TP0LANG
TP1LANG
PM1_0STATE
PM1_1STATE
PM2_0STATE
PM2_1STATE
TEXT_SET
DEV_TYPE
DEV_NUMBER
DEVSUBTYPE
ALRM_PRTY1
ALRM_PRTY2
ALRM_PRTY3
ALRM_PRTY4
ALRM_PRTY5
ALRM_PRTY6
ALRM_PRTY7
ALRM_PRTY8
ALRM_PRTY9
ALRM_PRTYA
ALRM_PRTYB
ALRM_PRTYC
PID_BLOCK
SEC_LEVEL
SEC_GROUP
ALRMCMNT01
ALRMCMNT02
Type
Width
Numeric
Character
Numeric
Character
Character
Numeric
Numeric
Numeric
Character
Character
Character
Character
Character
Character
Character
Character
Character
Character
Numeric
Numeric
Character
Numeric
Numeric
Character
Character
Character
Character
Numeric
Character
Numeric
Character
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
2
1
2
1
1
2
2
2
1
1
1
1
1
1
8
2
8
2
2
2
1
1
1
6
6
6
6
3
16
1
16
1, 22
1, 22
1, 22
1, 22
1, 22
1, 22
1, 22
1, 22
1, 22
1, 22
1, 22
1, 22
4, 51
2
2
5
5
Tag List
Versions
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
2VAA000812R0001
Table 11-1 Taglist Structures (R1, S1, T1, V1, X1, S1U, X1U, and X2U) (Continued)
Field
Number
94
95
96
97
98
99
100
101
102
103
Type
Width
ALRMCMNT03
ALRMCMNT04
ALRMCMNT05
ALRMCMNT06
ALRMCMNT07
ALRMCMNT08
ALRMCMNT09
ALRMCMNT10
ALRMCMNT11
CNTRLENABL
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Numeric
Character
5
5
5
5
5
5
5
5
5
1
104
STR_LENGTH
Numeric
105
PRIMDSPCRT
Numeric
106
ALRM_PRTYD
Numeric
1, 22
107
ALRM_PRTYE
Numeric
1, 22
108
ALRMCMNT12
Numeric
109
ALRMCMNT13
Numeric
110
111
TAGTYPESRC
USER1 (Manual
Inhibit)
USER2 (Alarm
Print Inhibit)
USER3 (Inhibit
Delay)
USER4 (Station
Type)
USER5 (Deviation
Alarm Limit)
USER6 (Switch
Type)
USER7 (Archive
Class Name)
USER8 (Default
Value)
Character
Character
8
4
Tag List
Versions
All
All
All
All
All
All
All
All
All
S1, T1, V1, X1,
S1U, X1U, X2U
S1, T1, V1, X1,
S1U, X1U, X2U
T1, V1, X1,
X1U, X2U
V1, X1, X1U,
X2U
V1, X1, X1U,
X2U
V1, X1, X1U,
X2U
V1, X1, X1U,
X2U
X1, X1U, X2U
S1U, X1U, X2U
Character
Character
Character
Character
12
Character
12
Character
16
Character
16
112
113
114
115
116
117
118
Field Name
NOTES:
1. Tag list structure X2U value.
2. Tag list structure S1U and X1U value.
2VAA000812R0001
11-3
11-4
2VAA000812R0001
Revision Manager.
Advanced Trend.
The Control Logic Editor, Automatic Drawing Generator, and Advanced Trend applications require an additional license
while the Revision Manager does not. Refer to the Introduction and Installation instruction for information about installing
these application.
NOTE: Use the View > Refresh option to update the Manipulate CLs window with the latest data from the Composer
project.
1.
2.
Each new control logic document is given a name of the following format:
2VAA000812R0001
12-1
original_cld_name.original_sheet_name
Where:
1.
2.
Enter a name for the new control logic document being created and click OK.
3.
Each sheet in the new control logic document is named using the following format:
original_cld_name.original_sheet_name
Where:
original_cld_name = Name of one of the original control logic document being merged
together.
original_sheet_name = Name of one of the sheets from one of the original control logic
document being merged together.
If a sheet name exceeds 32 characters in length, a prompt will require a new, shorter name be specified for the sheet.
The original control logic documents are deleted.
Example:
Control logic document 3000 (containing sheets named ABC and DEF) and 3001 (containing sheets named GHI and JKL)
are merged together. The resulting control logic document contains four sheets named 3000.ABC, 3000.DEF, 3001.GHI,
and 3001.JKL. Control logic documents 3000 and 3001 are deleted.
12-2
1.
Right click one of the selected control logic documents and select Print.
2.
Enable or disable the auto orientation option in the Print window. When enabled, revisions utilizing a
horizontal border are printed using landscape orientation and revisions utilizing a vertical border are
printed using a portrait orientation.
3.
Select the sheets to be printed (All, Range, or None (Cross-Reference Report Only)). The default To
field value is determined automatically from the CLD when only one CLD is being printed. The default
To field value is 99 when multiple CLDs are being printed. If this field is set to a value greater than the
number of sheets in a CLD being printed, all the sheets will be printed.
4.
Select to export the cross-reference report to a text file, print it along with the CLDs, both, or do
nothing with report.
5.
6.
Select the desired print quality and number of copies of each revision.
7.
8.
Click Setup to open the standard Windows print setup dialog box. Configure the options as
necessary.
9.
2VAA000812R0001
Text/Xref Editor
10. On the entries tab of the style setup window, select the specifications, tags, symbols, and crossreferences to be printed.
11. On the layers tab, set the layers to be printed.
12. On the layout tab, set the margins, alignment, and scale of the control logic document.
13. On the header/footer tab, configure the header and footer using the codes provided.
14. Click OK.
15. Click OK.
1.
Select one or more control logic documents whose order number is to be changed. Selected
documents do not need to be contiguous.
2.
Drag the control logic documents to a position such that a green arrow is displayed next to the control
logic document ahead of which the moved control logic documents will reside.
3.
Repeat Steps 1 and 2 until all control logic documents are in the desired order.
4.
1.
Select Tools > DB Warning Options or Operations > Warning Options (Database Utilities).
2.
Configure the appropriate database size warning level and click OK.
AAA.BBB.CC.DD
Where:
12-3
Text/Xref Editor
CC = Controller address.
DD = Controller ID.
Information in the Orig Position field is in the format:
EE.FFFF.GGG-HHII
Where:
EE = Controller ID.
FFFF = Control logic document number.
GGG = Sheet number.
HH = Y coordinate of the function code from the border.
II = X coordinate of the function code from the border.
1.
2.
1.
2.
3.
Move fields from the available fields list to the selected fields list (fields that will be displayed) or vice
versa by selecting the fields and using the appropriate button in the user defined fields dialog box
4.
Arrange the fields in the desired order (top of the list is the left most column and bottom of the list is
the right most column) by selecting the field and using the up and down buttons.
5.
Click OK.
1.
2.
3.
If a previously saved filter is to be used, select the filter and proceed to Step 16.
4.
If a relatively simple condition is to be configured, select a field whose value will be used in the filter
criteria and proceed to the next step. If a more complex condition is required, proceed to the next
step. The fields to search list contains all the currently viewable fields.
5.
Click Add Where Cond (for a relatively simple condition) or Add Adv Where (for a more complex
condition).
6.
If the Add Where Cond button was used, proceed to the next step. If the Add Adv Where button was
used, proceed to Step 8.
7.
Select the condition by which the field is true and proceed to Step 12.
8.
Enter an expression in the Expression1 field in the advanced filter builder window. Refer to Special
Search Characters (Filter and Find), String Functions, and String Functions for more
information. Standard SQL syntax (special search characters), along with standard Visual Basic
string and math functions, are used in this dialog box.
9.
10. Enter an expression in the Expression2 and Expression3 (if the between operation was selected)
fields.
11. Click Validate to have the condition checked for being valid. Correct the condition if necessary.
12. Click OK.
12-4
2VAA000812R0001
Text/Xref Editor
13. Repeat Steps 4 through 12 as required. AND logic operators are automatically placed between field
conditions.
14. Edit any field condition by selecting the expression and clicking Modify.
15. Edit the filter logic expression by inserting the cursor at the desired location and selecting the desired
logic operator.
16. Click Close.
1.
2.
Select a field that is to be moved to another location within the record and move the field to the
desired location using the up and down arrow keys.
3.
4.
1.
2.
3.
Select the field whose order is to be changed in the sort tag by window and click Add. The field name
is added to the Sort Fields field along with an indication of the present sort order.
4.
5.
6.
Configure the order in which the sorts will take place by selecting a sort field and moving it to the
correct position using the up and down buttons. The top sort field is sorted first, then the sort field
below it, and so on.
7.
Click OK.
1.
2.
Select the data type to be used in the new view and click New in the manage views window.
3.
Enter a name for the view in the create view dialog box and click OK. The name of the new view
appears in the list of available views.
1.
2.
Enter a name for the view in the save view as dialog box and click OK.
1.
2.
3.
Select the view being copied from the list and click Copy.
4.
Enter a name for the new view in the copy view window and click OK.
12-5
Text/Xref Editor
Not applicable fields (based on the record shape type, function code number, or extraction option used) are displayed in
solid dark blue.
Records that can not be marked for deletion (because they are locked or a template controls their deletion) have the Shape
Name or Function Code Number field displayed in blue (locked) or red (template deletion controlled) on a gray background.
All other text in the record is displayed in dark green on a gray background.
Records that can not be moved (because they are location locked or a template controls their location) have XY coordinates
and relative XY coordinates displayed in blue (locked) or red (template location controlled) on a gray background.
Specifications that can not be edited (because they are locked or controlled by a template) are displayed in blue (locked) or
red (template location controlled) on a gray background.
Records marked for deletion are displayed with a line through all text.
Records containing an error that occurred during an update are displayed in magenta and the Update Error Text field will
contain error description text. The following table provides a summary of these color conditions.
Condition
Text
Color
Background
Color
Field
Editable
Black
White
Field
Black
Off-white
Field
Uneditable
Black
Gray
Field
Not applicable
Black
Dark blue
Record (whole)
Various,
lined
through
White
Record (whole)
Magenta
White
Blue
Gray
Red
Gray
Dark
green
Gray
Specification
Blue
Gray
Specification
Red
Gray
XY and relative XY
coordinates of entity
Blue
Gray
XY and relative XY
coordinates of entity
Red
Gray
12-6
1.
2.
Select the source list name (Cross References And Text when in the text/xref editor and Function
Codes when in the function code editor) in the export to external database window.
3.
Select the name of the external database file and table receiving the exported data.
2VAA000812R0001
Text/Xref Editor
4.
Select to export all data fields or just those displayed in a certain view.
5.
If necessary, select the view to be used when exporting data. The exported view must contain the
object name field In order to import changes made in the external database.
6.
Click OK.
NOTE: Use the extract function to update the Text/Xref Editor with the latest data from the Composer project.
1.
2.
3.
Select the type of data to extract and what coordinates to use in the Extract Wizard - Filters window.
Relative coordinates are measured from the border origin.
NOTE: Views only alter the way the extracted information is displayed. They do not supplement or add information.
For example, if OREFs are not extracted, they can not be seen by using a view that shows OREFs.
4.
Click Next.
5.
Select the control logic documents from which to extract the data (select the box to the left of the
control logic document) in the Extract Wizard - Selections window and click Next. If Next is clicked
without anything being selected, the control logic documents that were selected in the Composer
navigator when the control logic editor was started will be automatically selected.
6.
7.
To extract data from the project database for use by the Function Code Editor:
NOTE: Use the extract function to update the Function Code Editor with the latest data from the Composer project.
1.
2.
3.
Select the type of data to extract, coordinates, and the additional options to use in the Extract Wizard
- Filters windows. Relative coordinates are measured from the border origin. Address specifications
are not editable and slow down the extract operation so it not recommended that they be extracted
unless they are needed for reference. If the Extract Ambient Text option is selected, up to three text
strings will be extracted from the upper left corner of a function code in the order found of closeness.
This text must have its origin within a 40x60 grid increment square that has its lower left corner
defined as -20,0 (0,0 is the top left corner). This feature is very useful for removing tag name and
description text placed above a function code in projects converted into Composer. The Extract
Ambient Text option also extracts a text entity placed within a function code. If more than one text
entity exists, the entity closest to the upper left corner of the function code will be extracted.
NOTE: Views only alter the way the extracted information is displayed. They do not supplement or add information.
For example, if OREFs are not extracted, they can not be seen by using a view that shows OREFs.
4.
Click Next.
5.
Select the control logic documents from which to extract the data (select the box to the left of the
control logic document) in the Extract Wizard - Selections window and click Next. If Next is clicked
without anything being selected, the control logic documents that were selected in the Composer
navigator when the control logic editor was started will be automatically selected.
6.
7.
1.
2.
2VAA000812R0001
12-7
Text/Xref Editor
3.
If a relatively simple condition is to be configured, select a field whose value will be used in the find
criteria and proceed to the next step. If a more complex condition is required, proceed directly to the
next step. The Field to Search list contains all the currently viewable fields of the list.
4.
Click Add Where Condition (for a relatively simple condition) or Add Adv Where (for a more complex
condition).
5.
If the Add Where Cond button was used, proceed to the next step. If the Add Adv Where button was
used, proceed to Step 8.
6.
7.
8.
Enter an expression in the Expression1 field in the advanced filter builder window. Refer to Special
Search Characters (Filter and Find), String Functions, and Math Functions. Standard SQL
syntax (special search characters), along with standard Visual Basic string and math functions, are
used in this window.
NOTE: This functionality pattern matches an entire field and is case sensitive. The replace functionality searches for
and replaces substrings within a field and is not case sensitive.
9.
10. Enter an expression in the Expression2 and Expression3 (if the between operation was selected)
fields.
11. Click Validate to have the condition checked for being valid. Correct the condition if necessary.
12. Click OK.
13. Repeat Steps 3 through 12 for the remaining fields. AND operators are automatically placed between
field conditions.
14. Edit any field conditions by selecting the expression and selecting Modify.
15. Edit find logic expression by inserting the cursor at the desired location and selecting the desired
logic operator.
16. If the find filter may be needed again, save it by clicking Save Filter and proceed to the next step. If
the find filter is not being saved, proceed to Step 18.
17. Enter a name for the filter in the save/replace filter window.
18. Click Close.
19. Click the appropriate find button and the cursor will be placed in the record.
12.1.2.11 Go to a Record
To move the cursor to a specific record in the list:
1.
2.
Enter the record number in the dialog box and click OK.
1.
2.
Select the name of the database file and table containing the information being imported in the Import
from External Database window.
3.
Select the destination list name (Cross References And Text when in the text/xref editor and Function
Codes when in the function code editor) in the to list name field.
4.
Enable or disable the import new records, overwrite existing records, and ignore empty fields options.
5.
Select to log all operations or only the errors and click OK.
Only changes made to fields that can be edited in the browser view will be imported. The export all fields option must be
used when selecting the export view in order to use the import new records option (to import records created in the external
database).
12-8
2VAA000812R0001
Text/Xref Editor
1.
2.
NOTE: Records shown in the current view that are marked for deletion will be removed from the control logic document during the update operation.
1.
2.
1.
2.
Click OK when notified that changed records that no longer match the view criteria will not be
displayed in this view.
1.
2.
3.
This procedure only removes the record from the user database. It does not remove the entity associated with the record
from the control logic document. Records that have been removed from view are not visible in any view until the record is
again extracted from the control logic document or imported from an external database.
1.
2.
Optionally, use the find records functionality to limit the displayed records to only those receiving the
replacement values.
3.
4.
If a relatively simple replace pattern or value is to be configured, select the field whose value is to be
replaced from the list. If a more complex pattern or value is required, proceed to Step 9.
5.
If a previously saved replace filter is to be used, select the name in the Saved Replace Specifiers
field and proceed to Step 21.
6.
Click inside the Value to replace field and enter the current field value that is going to be replaced.
7.
8.
9.
10. Select the field containing the text value being replaced.
11. Enter an expression (limited to text, numbers, and the special search characters) enclosed in double
quotation marks into the Expression To Search For field. Refer to Special Search Characters
(Replace). Regular expression syntax (with standard Visual Basic string and math functions) is used
in this window.
12. Enter an expression in the Expression To Replace With field. Refer to Special Replace Characters,
String Functions, and Math Functions for more information. Only plain text, simple numbers, and
2VAA000812R0001
12-9
Text/Xref Editor
special replace characters need be enclosed in double quotation marks in the Expression To Replace
With field.
NOTE: This functionality searches for and replaces substrings within a field and is not case sensitive. The find functionality pattern matches an entire field and is case sensitive.
13. To test the advanced replace criteria (if desired) or just become familiar with advanced replace
criteria in general, click Practice Reg Expr. If testing or practice is not required, proceed to Step 21.
The advanced replace patterns practice dialog box supports only text, numbers, special search
characters, and special replace characters.
14. Enter the whole value of the field containing the text or value to be replaced in the String To Be
Replaced field.
15. Enter the string that is to be replaced in the Search For field.
16. Enter the replacement string in the Replace With field and click Replace Text. The Resulting String
field displays the end result if this operation really happened.
17. Repeat Steps 14 through 16 as required.
18. Click Exit.
19. Click OK. The replace expression is validated and a dialog box stating the result is displayed.
20. Click OK to complete configuration of the advanced replace criteria (if criteria is valid) or to return to
the advanced replace pattern builder dialog box (if criteria is not valid).
21. Use the Find First, Find Next, Replace, and Replace All buttons to control the replacement
functionality.
22. If desired and after a successful replace operation, save the replace criteria by selecting Save
Replace As. Enter a name and click OK.
1.
2.
Every editable field in the control logic editor has a corresponding original data field. All fields that have been edited (differ
from the original data field) have an off-white background. This feature allows all changes made to the extracted data to be
removed at one time.
1.
2.
Select the view from the list provided and click OK.
1.
2.
3.
4.
Select if strikeout, underline, or normal (no selection required) characters are to be used.
5.
6.
2VAA000812R0001
Text/Xref Editor
1.
2.
Drag the cursor to the last column and release the button.
1.
2.
Drag the cursor to the last record and release the button.
1.
2.
3.
1.
2.
3.
1.
Select Tools > DB Warning Options or Operations > Warning Options (Database Utilities).
2.
Configure the appropriate database size warning level and click OK.
All User-Specific Database Data. This updates the control logic documents with all of the user-specific database data even if the
editable data matches the original data fields that were extracted from the control logic documents. This is useful in
instances where an extract operation was performed, data was changed, an update was performed, and then a few
changed fields were changed back to match their extracted value. The data in these fields will be written back to the control
logic documents if the Update All Records option is used as opposed to the Update option which only updates control logic
documents with user-specific database data that is different from the original data fields that were extracted from the control
logic documents.
To update the control logic documents with user-specific database data even if the editable fields match the extracted data:
1.
Select a view. Only the records shown in the view will be used to update the control logic
documents.
2.
3.
Click OK when prompted that the control logic documents will be updated with the values of all
editable fields.
4.
Select the appropriate update options found in the Update Wizard window and click OK. Refer to
Changed User-Specific Database Data for more information about these options.
5.
Changed User-Specific Database Data. To update control logic documents with user-specific database data that is different from
the data that was extracted from the control logic documents originally (using the text/xref editor):
1.
Select a view. Only the records shown in the view will be used to update the control logic
documents.
2.
3.
Click OK when prompted that control logic documents will be updated from all editable fields (within
the records) that differ from the original extracted data.
2VAA000812R0001
12-11
Text/Xref Editor
4.
Enable the appropriate options in the Update Wizard window and click Finish.
The delete signal line options also apply to XREF shapes that were changed to text. The
propagate OREF description changes options are used to rename IREFS that are
associated with the OREF being changed. The display overwrite warning option is used to
notify the user that the extracted data in the original data fields no longer matches the data
in the control logic document for a field that is about to be updated. If the data does not
match, a change has been made to the control logic document since the data was
extracted.
5.
To update control logic documents with user-specific database data that is different from the original data fields that was
extracted from the control logic documents (using the function code editor):
1.
Select a view. Only the records shown in the view will be uses to update the control logic
documents.
2.
3.
Click OK when prompted that control logic documents will be updated from all editable fields (within
the records) that differ from the original extracted data.
4.
Enable the appropriate options in the Update Wizard window and click Finish.
The delete input signal branches option allows the automatic deletion of all signal line
branches associated with the function codes inputs when a function code is deleted. For
example, assume an IREF is connected to two function codes (A and B). Deleting function
code A (using this option) deletes the function code and only the signal line branches
connected to it. When output signal lines are to be deleted, all the signal lines connecting
other entities to the function code outputs are deleted. The display overwrite warning option
is used to notify the user that the extracted data in the original data field no longer matches
the data in the control logic document for a field that is about to be updated. If the data does
not match, a change has been made to the control logic document since the data was
extracted.
5.
1.
2.
A list of the views associate with the selected data type is provided in the upper part of the manage view window. The lower
part lists the fields used in the view along with any filter and sort criteria used.
1.
2.
3.
View the desired properties in the properties window and click OK.
12.1.2.26 Vocabulary
It is possible to select one of the text or number based fields in the current view and get a listing of all the unique numbers
or words contained in that field for all the records. Also displayed is a count of how many times each number or word
occurs. The listed numbers or words can be edited and that change can be propagated (one field at a time or all at once)
throughout all the records in the view.
To use the vocabularies function:
12-12
1.
2.
3.
Click Scan Field. The word in column is the number or word listing, the change to column lists
replacement data, and the count column lists the number of occurrences.
2VAA000812R0001
4.
If a listed number or word is to be updated, proceed to the next step. If no updating is required,
proceed to Step 9.
5.
Edit the number or word as required in the change to field and click Find First. The cursor is moved to
the first data browser field (starting from the first record) that contains the unedited number or word.
6.
View the Original Field and Updated Value (displays the resulting value if replace functionality is
used) fields and verify the correct action is to be performed.
7.
8.
If there are multiple occurrences of the number or word, repeat Steps 6 and 7 until all occurrences
are updated.
9.
Add a Record.
Change Fields.
Edit Data.
Export Data.
Extract Data.
Find Records.
Go to a Record.
Import Data.
Refresh Records.
Remove Records.
Replace Records.
Restore Data.
Select Font.
Vocabulary.
The Assigned Tag field (in the Function Code Editor window) displays the existing tag that is associated with the function
code. Changing this field value causes a different existing tag to be associated with this function code. This field can not be
used to edit a tag name or create a new tag name (use the tag editor within Composer).
2VAA000812R0001
12-13
Database Utilities
The String Spec n fields are used to edit string type specifications because strings can not be entered into the fields Spec 1
through Spec 54. For example (in function code 221), String Spec 1 would represent specification 1 while String Spec 2
would represent specification 30.
The information in the Orig Address and Orig Position fields is used to identify record. Information in the Orig Address field
is in the format:
AAA.BBB.CC.DD
Where:
EE.FFFF.GGG-HHII
Where:
EE = Controller ID.
FFFF= Control logic document number.
GGG = Sheet number.
HH = Y coordinate of the function code from the border.
II = X coordinate of the function code from the border.
The database must be closed before it is exported after changes have been made using the Control Logic Editor. The
database table will not be updated if the database is not closed.
NOTE: If projects are prelaunched on one or more client computers, these must be shut down to release all connections and allow the Database Utilities to have exclusive access to the project database (and perform the requested
function). To shut down a prelaunched project, select the objects for the project on the History tab of the Prelaunch
Configuration Utility and click Shutdown Selected Object.
1.
Select Operations > Database Utilities > Append Selected Database to User DB.
2.
Select the data types to append (Function Codes, Cross References and Text, or both) and click OK.
3.
1.
2.
Select Operations > Database Utilities > Project Database Management > Compact Selected
Database.
3.
12-14
1.
2.
3.
Miscellaneous Topics
1.
2.
Select Operations > Database Utilities > Project Database Management > Delete Records and
Compact Selected Database.
3.
Select the types of data to be deleted (Function Codes, Cross References and Text, or both) and
click OK.
4.
Click OK when prompted that the delete and compact operation has completed.
1.
2.
Select Operations > Database Utilities > Delete Records and Compact User DB.
3.
Select the types of data to be deleted (Function Codes, Cross References and Text, or both). and
click OK.
4.
Click OK when prompted that the delete and compact operation has completed.
1.
2.
Select Operations > Database Utilities > Project Database Management > Delete Selected
Database.
1.
2.
1.
2.
Select Operations > Database Utilities > Project Database Management > Rename Selected
Database.
3.
NOTE: Renaming the currently active user database causes it to become an external user database. A new active
user database is created the next time the function code or text/xref editor is opened.
2VAA000812R0001
12-15
Miscellaneous Topics
Description
Example
[]
[! ]
Matches any single character not within the "b[!ae]ll" finds bill and bull but
brackets.
not ball or bell.
NOTES:
1. Use these special search characters with string or text data types.
2. When searching for an asterisk, question mark, number sign, opening bracket
or hyphen, enclose it in brackets.
3. When searching for a hyphen and other character simultaneously, the hyphen
must be before or after all the other characters but inside the brackets. However, the
hyphen must be placed after an exclamation point (if being used).
4. Searching for an exclamation point or closing bracket does not require brackets.
12-16
Description
Example
"^ape" finds ape within apes but not within
grapes.
"Just[^5-9]" finds Just4 or JustA but not
Just8.
^ (caret)
Matches the characters when "ick$" finds ick within sick but not within
they are at the end of a string. sickness.
2VAA000812R0001
Miscellaneous Topics
2VAA000812R0001
Description
Example
12-17
Miscellaneous Topics
Description
Example
12-18
[]
2VAA000812R0001
Miscellaneous Topics
Description
Example
Initial value:
Mr.
Pattern to replace field value:
"(Mr)(\.)"
Replace with field value:
"\1s\2"
Updated field value:
Mrs.
Initial value:
abc
Pattern to replace field value:
"(a)b(c)"
Replace with field value:
"&-\1-\2"
Updated field value:
abc-a-c
Initial value:
bcd
Pattern to replace field value:
"(alb)c*d"
Replace with field value:
"\0-\1"
Updated field value:
bcd-b
Initial value:
abcde
Pattern to replace field value:
"(.*)c(.*)"
Replace with field value:
"&-\1-\2"
Updated field value:
abcde-ab-de
2VAA000812R0001
(continued)
Initial value:
cde
Pattern to replace field value:
"(ablcd)e"
Replace with field value:
"&-\1"
Updated field value:
cde-cd
12-19
Miscellaneous Topics
Description
&
Dialog Box
Description
double
quotation
marks
Where,
Replace
Where,
Replace
IIf
Where,
Replace
InStr
Where,
Replace
LCase3
Replace
Left
Where,
Replace
Len
Where,
Replace
LTrim
Where,
Replace
Mid
Where,
Replace
Right
Where,
Replace
RTrim
Where,
Replace
12-20
2VAA000812R0001
Miscellaneous Topics
Dialog Box
Where,
Replace
Description
Returns a string consisting of the specified number of
spaces.
Syntax: Space(number)
Str
String
Where,
Replace
Where,
Replace
Syntax6: Str(number)
Where,
Replace
UCase3
Replace
NOTES:
1. When multiple string literals are used in the find criteria, wild cards are only
effective in the first element. For example, "*pa" + "s*" would find Bypas* but not
Bypass.
2. The compare parameter is not supported.
3. Does not apply to the Where because it is not case sensitive. Replace is case
sensitive.
4. Len of a null field value returns null (not zero).
5. Does not effect Access data but will effect SQL Server data.
6. Adds a leading space for the sign if the number is positive.
Dialog Box
Description
Where,
Replace
Multiply
Where,
Replace
Add
Where,
Replace
Subtract
Where,
Replace
Divide
Abs
Where,
Replace
2VAA000812R0001
12-21
Revision Manager
Dialog Box
Where,
Replace
Description
Removes the fractional part of a number and returns the
integer portion of the number.
Syntax: Int(number)
number can be a double or any valid numeric expression. If
number contain null, null is returned. If number is an
uninitialized variable, a value of zero is returned. If number is
negative, the first negative integer less than or equal to
number is returned (-8.4 is returned as -9).
Round
Where,
Replace
Val
Where,
Replace
NOTE: If control logic documents are unpacked into a project and then either these control logic documents or parts
of the project hierarchy containing them (e.g., controller, control unit etc.) are deleted from the Composer project, a
second unpack of these control logic documents will fail to generate any control logic documents in the project. The
revision manager power tool must be closed and then restarted before these control logic documents can be
unpacked a second time.
NOTE: Using the following special characters in CLD names may cause errors (pack and/or unpack) in the Revision
Manager feature:
/ (forward slash)
\ (back slash)
(double quotes)
* (asterisk)
@ (at sign)
- (hyphen)
| (pipe)
: (colon)
< (less than)
> (greater than)
? (question mark)
The pack actually suggests the operation was successful, however, only the pack file (.EPG file) and the CLDs with
valid characters will be exported. The subsequent unpack will report errors on the missing CLDs.
12-22
2VAA000812R0001
1.
Select the working versions of the control logic documents from which new revisions will be
created and select Actions > Create New Revision. The Create New Revision window will
appear.
2.
If desired, enter a comment for the new revision in the Revision Comment field.
3.
If desired, select a designer and/or reviewer from the drop-down lists provided.
4.
If desired, select data for the Data1 and Data2 fields from the drop-down lists provided.
5.
Click OK.
NOTE: If the drop-down lists do not contain the desired names or data choice, click Modify PickList and edit the pick
list to contain the desired name or data.
1.
Select the revisions to be deleted and select Actions > Delete Revision.
2.
NOTE: The deleted revisions will no longer be shown on borders or in Composer windows. However, revision letter
designators from deleted revisions can not be used again. For example, the working version of a control logic document can not be made equal to a revision that has been deleted. Also, there is no way to delete all the revisions and
then reset all working versions to revision letter A.
1.
Click Add and enter the name or text in the Name field.
2.
3.
Select the fields that will be able to use this name (available in the pull-down list).
To delete a name from the pick list, select the line containing the name and click Delete.
To exit the PickList Edit window, click Close.
1.
Select the working version of a control logic document and select Actions > Edit Working
Version Comment.
2.
Edit the current comment or enter a new comment in the working version comment window and click
OK.
1.
Select View > Filter Criteria. The Modify View to Match The Following Criteria window
appears.
2.
Select the revision data and/or information that must be found in order for a revision to be displayed.
NOTE: Designer ID, requested reviewer, data1 field, and data2 field pull-down lists are created from pick list information.
2VAA000812R0001
12-23
1.
2.
Enable or disable the auto orientation option in the Print window. When enabled, revisions utilizing a
horizontal border are printed using landscape orientation and revisions utilizing a vertical border are
printed using a portrait orientation.
3.
Select the sheets to be printed (All, Range, or None (Cross-Reference Report Only)). The default To
field value is 99 when multiple CLDs are being printed. If this field is set to a value greater than the
number of sheets in a CLD being printed, all the sheets will be printed.
4.
Select to export the cross-reference report to a text file, print it along with the CLDs, both, or do
nothing with report.
5.
6.
Select the desired print quality and number of copies of each CLD.
7.
8.
Click Setup to open the standard Windows print setup dialog box. Configure the options as
necessary.
9.
10. On the entries tab of the style setup window, select the specifications, tags, symbols, and crossreferences to be printed.
11. On the layers tab, set the layers to be printed.
12. On the layout tab, set the margins, alignment, and scale of the control logic document.
13. On the header/footer tab, configure the header and footer using the codes provided.
14. Click OK.
15. Click OK.
To print the selected control logic document revisions:
1.
2.
Enable or disable the auto orientation option in the Print window. When enabled, revisions utilizing a
horizontal border are printed using landscape orientation and revisions utilizing a vertical border are
printed using a portrait orientation.
3.
Select to export the cross-reference report to a text file, print it along with the CLDs, both, or do
nothing with report.
4.
5.
Select the desired print quality and number of copies of each revision.
6.
7.
8.
9.
On the entries tab of the style setup window, select the specifications, tags, symbols, and crossreferences to be printed.
2VAA000812R0001
Select/Deselect Revisions
12.2.10.1 Procedure
To specify an approval or rejection review status for revisions:
1.
Select the revisions whose review status is to be set and select Actions > Set Review
Status. The Set Reviewer Information window appears.
2.
Select CLDs OK (to approve) or CLDs Not OK (to reject) the revision.
3.
4.
5.
Click OK.
6.
If the reviewer selected in Step 4 is not the reviewer specified by the revision designer, a message
stating this discrepancy is displayed. Click OK to acknowledge this condition and continue. Click
Cancel to abort this procedure.
1.
Make a revision of the working version (D). The working version will now be E and the
revision will be D.
2.
Make the working version (E) equal to the rejected revision (C).
3.
Make the required changes to the working version (E, which is equal to C).
4.
Make a revision of the working version (E). The working version will now be F and the revision will be
E.
5.
6.
Make the working version (F) equal to revision D. The working version is now in the same condition it
was before starting this procedure.
7.
1.
2VAA000812R0001
Select the working versions whose borders are to be changed and select Actions > Swap
CLD Borders. The Swap Borders window appears.
12-25
2.
3.
4.
Select the border that will be used in place of the existing border from the pull-down menu.
5.
If desired, offset the new border using the x offset and y offset fields. Offsets are based on the origin
of the current border.
6.
7.
Click OK.
1.
Select Actions > Swap Template Borders. The Swap Borders window appears.
2.
3.
4.
Select the border that will be used in place of the existing border from the pull-down menu.
5.
If desired, offset the new border using the x offset and y offset fields. Offsets are based on the origin
of the current border.
6.
7.
Click OK.
_r_text.cld
Where:
1.
Select the revisions and working versions that are being transferred from this project
(source) to another project (destination) and select Actions > Pack Revisions.
2.
Enable or disable the Automatically Create a New Revision for Each Working Version Being Packed
option as appropriate and click OK.
3.
Select a name and location for the pack & go context file (.epg file extension) and click Open. The
directory containing this file is considered the output directory.
12-26
1.
2.
Open the revision manager and select Actions > Unpack Revisions.
2VAA000812R0001
View Revisions
3.
Select the pack & go context file (.epg file extension) associated with the revisions to be unpacked
and click Open.
4.
5.
Enable or disable the Store Revision of Current Working Revision Before Unpacking option as
appropriate and click Unpack.
NOTE: The revision is unpacked into the same location in the destination project. The same project tree structure
that contained the revision or working version in the source project is created in the destination project if it does not
already exist.
NOTE: If the progress indicator of a pack or unpack operation fails to indicate that CLDs are being processed:
1. Terminate the Revision Manager process using the Windows Task Manager.
2. Shut down Composer.
3. Restart the workstation (recommended).
4. Retry the pack or unpack operation.
12.2.14View Revisions
To open or view the selected control logic document revisions, select File > View/Open Selected Documents.
The control logic documents will be displayed in the automation architect window.
Standardized control logic templates (templates for each type of control logic) contained in a Composer project.
Refer to Attribute Values Syntax for information about the attributes that are placed on the control logic template
layers.
Procedures that control how database information is transferred to the control logic documents.
Knowledge of the organization of the actual control system (control networks, control units, controllers, etc.).
Knowledge of the current (or proposed) control logic. This will enable the selection of the correct control logic
template.
To create a control logic document from a database, control logic template, and procedures:
1.
2.
Configure the system architecture (of the new project) to match the organization of the actual control
system.
3.
Copy (drag and drop) the standardized control logic templates into the appropriate exchange folder in
the new project.
4.
Create a new generation context file. Refer to Generation Context File for more information.
5.
It is recommended that the template instantiation powertool (TIP) utility be activated and used. Refer
to Template Instantiation Power Tool for more information.
6.
Drag and drop the proper control logic template from the exchange to the appropriate controller.
7.
Process the control logic document by supplying the appropriate information in the control logic
processing window. Refer to Template Instantiation Power Tool for more information.
NOTE: If the template instantiation powertool utility was not activated, manually process the control logic document.
Refer to Manual CLD Processing for more information.
2VAA000812R0001
12-27
8.
Repeat Step 6 and Step 7 for each control logic document being created.
point_name. This identifies a record (point) in the database. The expression will use data from this record. If point_name is not used
and a ^ is used (^ProcedureX for example), the first valid record associated with the control logic document will be made the
current record. The expression will use data from this record. If point_name and a ^ are used (ProcedureX for example), no
resetting of the current record will occur. The expression will use data from the current record.
NOTE: The first valid record associated with the control logic document, will be made the current record when a new
entity (function code, text object, etc.) is encountered.
In multiple instruction attribute values, omitting point_name will cause the expression to use data from record specified in
the previous instruction. Consider the following instruction:
language. This specifies the language used to create the expression (Visual FoxPro or VBScript). Use VFP for Visual Foxpro and VB
for VBScript.
If a language is not specified and the first word in the expression is an existing procedure, the expression will be
evaluated in the language used to write the procedure. Consider the following example instruction:
Pointabc^CreateTagName ( ) + "AB"
CreateTagName ( ) + "AB" is the expression and CreateTagName is the first word in the expression. The
CreateTagName procedure (found in one of the listed procedure files) was written using Visual FoxPro. Therefore,
Visual FoxPro will be used when evaluating the CreateTagName ( ) + "AB" expression.
If a language is not specified and the procedure (listed first in the expression) is not found in one of the files listed in
the procedure stack, VBScript will be used when evaluating the expression. Consider the following example
instruction:
Pointabc^CreateTagName ( ) + "AB"
CreateTagName ( ) + "AB" is the expression and CreateTagName is the first word in the expression. The
CreateTagName procedure is not found in any of the listed procedure files. VBScript will be used when evaluating
the CreateTagName ( ) + "AB" expression.
If a language is not specified and the procedure is not listed first in the expression, VBScript will be used when
evaluating the expression. Consider the following example instruction:
Pointabc^"AB" + CreateTagName ( )
"AB" + CreateTagName ( ) is the expression. The CreateTagName procedure (found in one of the listed procedure
files) was written using Visual FoxPro. VBScript will be used when evaluating the "AB" + CreateTagName ( )
expression.
2VAA000812R0001
1.
Select Tools > ADG [Automatic Drawing Generator] in the Composer window.
2.
3.
4.
5.
6.
Select the name of the table or query (view) containing the data.
7.
Enable or disable the Use Option Fields option. Refer to Layer Options for more information.
NOTE: The Use Option Fields option must be enabled in order to manipulate control logic document layers. All control logic template layers will be created in the control logic document if this option is disabled.
8.
Click OK.
9.
Double click the name of the procedure file containing the procedure (listed under procedure stack).
- or
Select the Function View tab of the GC properties subwindow and double click the procedure name.
This window allows fields used in procedures that are part of this generation context to be
mapped to fields existing in the database. Field names used in procedures must be
declared in special comments in the following format if they are to be displayed in this
window.
*<<FIELDS: name>>
- or 2VAA000812R0001
12-29
1.
Select Tools > ADG [Automatic Drawing Generator] in the Composer window.
2.
Select File > Activate Template Instantiation Powertool (or De-Activate Template Instantiation
Powertool).
3.
To use the template instantiation powertool utility wizard to process a control logic document:
1.
Enter a name for the control logic document to be created (or accept the default name) and
click Next.
2.
Enable the layers that are to be part of the newly created control logic document and click Next. All
the layer options defined in the control logic template are displayed in this window. Refer to Layer
Options for more information.
3.
Assign points used in the attributes in the control logic template to fields in the database by dragging
and dropping the points from the list of points column to the appropriate point fields. Refer to Point
Associations for more information.
NOTE: It is also possible to assign a point by typing the point name in the appropriate point field.
4.
Click Next.
5.
Assign values to all the prompt fields specified in the procedures that are used by the ADG utility to
generate and process the control logic document. Refer to Prompt Fields for more information.
NOTE: To set the prompt field values to the same values used by the last control logic document produced from this
control logic template during this ADG session, click Apply Last Settings.
6.
Click NextCLD and repeat Steps 1 through 7 to create another control logic document from the same
control logic template (if desired).
7.
Click Next.
8.
Select the automatic drawing generator attributes that are to be processed and click Finish.
12-30
1.
2.
3.
Enable the Process Attributes in Existing Control Logics Only, Regenerate Existing Control Logics, or
Remove Unwanted Layers Only option.
The Process Attributes in Existing Control Logics Only option processes the selected
control logic document and removes any unwanted layers (based on layer option settings)
but does not incorporate any changes made to the control logic template. The Regenerate
Existing Control Logics option deletes the selected control logic document, regenerates it
from the control logic template, removes any unwanted layers (based on layer option
settings), and processes the control logic attributes found. The Remove Unwanted Layers
Only option removes any unwanted layers (based on layer option settings) and does not
process control logic attributes.
4.
Click Next or Finish (if the Remove Unwanted Layers Only option was enabled).
5.
Enable the automatic drawing generator attributes that are to be processed and click Finish.
12.3.2.1 Init_Generation ( )
This procedure is executed at the start of the generation or update processes. The first record in the recordset will be the
current record. Using sorts or filters on the recordset may change which record is listed first in the recordset. Therefore, the
actual record which will be the current record may not always be the same.
These procedures are very useful in setting up and cleaning up flags and variables used in the creation of control logic
documents.
12.3.2.2 End_Generation ( )
This procedure is executed after the entire generation or update process has completed.
12.3.2.3 Init_ControlLogicTemplate ( )
This procedure is executed at the start of the generation or update processes. The first record that contains the template
name will become the current record.
12.3.2.4 End_ControlLogicTemplate ( )
This procedure is executed after all control logic documents have been processed.
12.3.2.5 Init_ControlLogic ( )
This procedure is executed once for each control logic document before its attributes are processed.
12.3.2.6 End_ControlLogic ( )
This procedure is executed once for each control logic document after all of its attributes have been processed.
1.
2.
Select Tools > ADG-Modify Assignments (Based on Control Logic) or Tools > ADG-Modify
Assignments (Based on Template). Refer to Modify Assignment Options for more information.
3.
4.
Select the layer options icon to access the layer options enabled for the control logic document.
Refer to Layer Options for more information.
5.
Select the point associations icon to access information about how the points have been assigned.
Refer to Point Associations.
6.
Select the field associations icon to access information about prompt field values. Refer to Prompt
Fields.
7.
2VAA000812R0001
12-31
Miscellaneous Topics
Attribute Type.
Layer Options.
Macros.
Point Associations.
Prompt Fields.
Attrib.
This property provides the attribute as a string and can be useful when printing to the output window.
AI.Trace "Failed to find valid value while processing " & AI.Attrib
ConstantBlock, FunctionCode, GraphicEntity, Iref, Oref, SignalLine, and HostEntity. These properties apply directly to
the automation interface objects and are typically used for advanced functionality.
ControlLogic. This property provides access to data associated with the control logic document. Examples include the setting of
unique cross-references (based on control logic document name).
FCData.
This property provides access to data associated with a function code and can be useful when setting block numbers.
AI.FCData.SetBlockNumber Block_Num, 1
This property is typically used for advanced functionality because specification and cross-reference descriptors are more
easily set using the PT-XrefDesc, PT-Specs, and PT-AllSpecs attributes.
FieldExists. This property returns a true condition if the specified field exists in the database.
GetEUIdx. This property retrieves the index of the specified EUDesc text string.
IrefData, and OrefData. These properties are typically used for advanced functionality because specification and cross-reference
descriptors are more easily set using the PT-XrefDesc, PT-Specs, and PT-AllSpecs attributes.
IsFieldNull. This property returns a true condition if the specified field is null.
LowerSpecLimit. This property is used in PT-ADVANCED attributes to determine the index of the lowest value specification that can
be set.
LSD.
Point.
This property provides the point as a string and can be useful when printing to the output window.
AI.Trace "Value field was blank for point " & AI.Point
The property can also be used to move the current record position in the database to another point associated with the
same control logic document.
AI.Point = "AI07"
12-32
2VAA000812R0001
Miscellaneous Topics
PointFound. This property returns a true condition if the expression is executing after the point specified in the attribute has been
positioned in the database.
This property provides access to data associated with the sheet and can be useful when setting sheet names.
AI.Sheet.Name = sName
SpecArray. This property sets multiple specifications for a function code in a single procedure.
Tag.
This property provides access to data associated with a tag. AI.Tag is equivalent to AI.EBFCData.Tag. Tag data can be set
by using
AI.Tag.Update
UpperSpecLimit. This property is used in PT-ADVANCED attributes to determine the index of the highest value specification that can
be set.
Common Usage Examples. A listing of useful Automation Interface properties and methods follows.
Write messages to the output window:
If AI.PointFound Then
Determine if the database field currently exists:
If AI.FieldExists ("FieldName")
Determine if the field has a value:
AI.Point = "AO01"
AI.SpecArray (18) = Zero
AI.SpecArray (19) = Span
AI.Point = "AO02"
AI.SpecArray (18) = Zero
AI.SpecArray (19) = Span
etc.
Write a value to a database field from within a procedure:
2VAA000812R0001
12-33
Miscellaneous Topics
Attribute
Type
PT-SPEC
Applies
To
All
function
codes
Data Type
of
Evaluated
Instruction
Variant
Integer
(1 to 64)
Description of Action
PT-SPEC
(continued)
PTALLSPECS
All
function
codes
Variant
Example 2:
Integer
(1 to 64)
POINT1^SpecVal ( ); 1
All
function
codes
None
(A supplied
array of 64
variants is
available
within any
expression
used in this
attribute.)
Example:
The following attribute may be placed on a
function code 30 or 68 to set the zero and span
specifications.
POINT1^MyAllSpecSub ( )
The MyAllSpecSub ( ) is:
Sub MyAllSpecSub ( )
if AI.FCData.FCNumber = 30 then
AI.SpecArray (3) = ZeroValField
AI.SpecArray (4) = SpanValField
else AI.FCData.FCNumber = 68 then
AI.SpecArray (3) = ZeroValField
AI.SpecArray (2) = SpanValField
End Sub
Refer to AI Object Properties, Methods, and
Common Usage.
12-34
2VAA000812R0001
Miscellaneous Topics
Attribute
Type
PT-LSD
Applies
To
Exception
reporting
function
codes
Data Type
of
Evaluated
Instruction
None)
(The
supplied
object
contains
properties
correspondi
ng to logic
states the
host
function
code could
have.)
Description of Action
PTADVANCED
2VAA000812R0001
12-35
Miscellaneous Topics
Attribute
Type
PT-MACRO
Applies
To
Data Type
of
Evaluated
Instruction
Description of Action
Long
Integer
(output)
Integer
(spec
number)
12-36
2VAA000812R0001
Miscellaneous Topics
Attribute
Type
Applies
To
Data Type
of
Evaluated
Instruction
Description of Action
PT-TEXT
Text
entities
String
PTXREFDESC
String
Cross
reference Integer
s and I/O (0 to 7)
function
codes
Option Groups. Option groups are groupings of one or more options, each located on a different layer. For example, the following
items are placed on layers two, four, and six.
2VAA000812R0001
12-37
Miscellaneous Topics
During the creation of a control logic document from this control logic template (using the TIP wizard and enabling the Use
Option Fields option), the following selection will be displayed in the layers options window.
Options. Individual options can be placed on a layer using the following format.
Database Layer Options Data. The database used by the generation context to create a control logic document may or may not
contain layer information. Layers two through 16 can be individually included or excluded from the control logic document
using the information in the layer information field contained in the database if the Use Option Fields option is enabled.
Layer information consists of a 15 character string of - (dashes) and D (capital letter D) that correspond to layers two
through 16. Dashes indicate inclusion while Ds indicate exclusion.
NOTE: When processing control logic documents, it is important to remember that layers that are not part of the
existing control logic document can not be included. All combinations dashes and Ds are possible when creating and
regenerating control logic documents.
If layer information is contained in the database, the Use Option Fields option is enabled, but no layer option syntax exists in
the control logic template:
Single point control logic templates will use the value in the layer information field corresponding to that point to
create the appropriate layers in the control logic document.
Multiple point control logic templates will determine which control logic document layers to create by resolving the
layer information from all the points as shown in the following example:
(Point A layer information field data) = ---D-DDD-DD--(Point B layer information field data) = -----DDD--D-DD
(Internal resultant value) = -----DDD--D--The internal resultant value is used but not displayed or saved.
If layer information is contained in the database, the Use Option Fields option is enabled, and layer option syntax exists on
one or more layers of the control logic template:
Single point control logic templates will modify the database layer information to reflect the layer option choices
made.
Multiple point control logic templates will determine which control logic document layers to create by resolving the
layer information from all the points with the layer option choices made as shown in the following example:
(Point A layer information field data) = ---D-DDD-DD--(Point B layer information field data) = -----DDD--D-DD
(Internal resultant value) = -----DDD--D--(Layer option syntax on layer three) = disabled
(Layer option syntax on layer eight) = enabled
(Final layer information value) = -D---D-D--D--The final layer information value is saved in the layer information field of point A and B.
If there is no layer information contained in the database, the Use Option Fields option is enabled, but no layer option syntax
exists in the control logic template:
All layers in the control logic template will exist in the control logic document.
Layer information is not saved in the layer information field of the point. It will remain empty.
If there is no layer information contained in the database, the Use Option Fields option is enabled, and layer option syntax
exists on one or more layers of the control logic template:
12-38
The layer information field of the points is assumed to be --------------- (create all layers).
The assumed database layer information is modified to reflect the layer option choices made.
2VAA000812R0001
Miscellaneous Topics
The final layer information value is saved to the layer information field of the points.
12.3.4.4 Macros
Example Macro Directives:
1.
PointA^MacroName ( ); PointB^BlockNumber
The block numbers in the macro will be offset by the value (PointB^BlockNumber ( ) - lowest
block number in macro).
2.
PointA^"MyMacro"^VB; 200
In this example, (if the instruction is part of a function code or input reference) the origin of
the macro will be placed on the first output connector of the function code or input reference.
If the instruction is part of an output reference, the origin of the macro will be placed on the
input connector of the output reference. The block numbers in the macro will be offset by the
value (200 - lowest block number in macro).
3.
"MyMacro"^VFP; 200; ; 15
The block numbers in the macro will be offset by the value (200 - lowest block number in
macro). The origin of the macro will be placed on the specification 15 input of the host
function codes. Point names will not be changed because there is no point in the instruction.
4.
The block numbers in the macro will be offset by the value (200 - lowest block number in
macro). The origin of the macro will be placed on the specification 15 input of the host
function codes. Point names will not be changed because there is no point in the instruction.
5.
"MyMacro"^VB; ; 3
Point names will not be changed because there is no point in the instruction. The origin of
the macro will be placed on the third output connector of the host function code.
Points in Entities Contained in Macros
Points (using the keyword POINT) in the entities that are placed on a sheet as part of a macro being placed on a sheet will
be replaced by the point in the first argument of the macro instruction. If a macro contained a function with the following
attributes
PT-MACRO abc^GetMacroName ( )
then the resultant attributes would be
A control logic document was created from a control logic template that contains 10 layers.
Only five of the layers were selected during control logic document creation. Additionally, a
macro (containing points) was configured on the control logic document.
ADG-Modify Assignments (Based on Control Logic). Selecting this option would display the five layers in the control logic
document and the points used in the macro. This option would typically be used when only processing the attributes of the
selected control logic document.
ADG-Modify Assignments (Based on Template). Selecting this option would display all 10 layers from the template and none
of the points used in the macro. This option would typically be used when regenerating control logic documents to include
changes made to the database.
2VAA000812R0001
12-39
Miscellaneous Topics
The color scheme for the left side of the database view of this window is:
The fields that will contain control logic template, control network, control unit, controller, and control logic document
information for each point are populated at the same time as the point field. The names of the database fields are obtained
from the address field mapping for the point field on which the point was dropped. Refer to Generation Context File for
more information about address field mapping.
Multiple field mappings can be used on the same control logic document as long as the following rules and suggestions are
understood.
Two points from the same control logic document can not be assigned to the same database record.
Points do not need to be assigned to a point field if the attribute values for that point are configured appropriately.
Enter new text or edit the existing text. This will set the field value used by all points.
- or
Select a value from the drop down list which contains the different values that have been used in this field in other
points. This will set the field value used by all points.
- or
Use browse button to choose a value suggested in the procedure (will set the field value used by all points) or set
different values for other points. Refer to Using Suggested Values for more information.
1.
12-40
Select the browse button next to the value field in the field assignments area of the control
logic processing window.
2VAA000812R0001
Advanced Trend
2.
Select a value from the drop-down list for the field value or enter the desired value. This drop-down
list displays the suggested values from the procedure.
3.
Enable or disable the Use Same Value for all points function. Enabling this function will set the value
of this field used in all points to the value of the first point listed.
4.
Click Assign.
The newly assigned values will not be written to the database until NextCLD is clicked or the TIP utility wizard runs to
completion.
2VAA000812R0001
Description
Loop
Loop name.
PCU
Controller
Block
Tunable Spec
Description
F.C.
Spec
Value
ICI Status
12-41
The outputs area located across the bottom part of the window displays a combination of user and system-provided
information for values that are to be trended in the chart area. The following table lists the information contained in this area.
The columns can be sorted and rearranged using standard Windows methods.
Description
Trend
Color
Loop name.
PCU
Controller
Block
Maximum
Minimum
Value
Units
Type
ICI Status
Quality
Alarms
12-42
1.
Select Options > Default Options (sets default options for new trend documents) or Options
> Document Options (set the options for this trend document only).
2.
Enter the total number of rows displayed in the tunable specifications area (20 or less) in the
Maximum Number of Tunable Specifications field in the Default Options or Document Options
window.
3.
Enter the total number of rows displayed in the outputs area (20 or less) in the Maximum Number of
Outputs field.
4.
Enter the scan period (interval between ICI scans) for monitoring outputs in the ICI Scan Period
(milliseconds) field. A value of 50 milliseconds or greater must be entered.
2VAA000812R0001
Configure Outputs
5.
Enter the number of sampled values that will be maintained (accessible to the line cursor) in the chart
for each trended output in the Samples Per Series field. Each output has one series of values.
6.
Select the color of the cursor (vertical line) that is used when playing back values stored in the chart
at runtime. The outputs area indicates the actual values of the trended values at the cursor location.
7.
Enter the maximum value (in percentage) to display along the Y axis of the chart in the Y Axis
Maximum (%) field.
8.
Enter the minimum value (in percentage) to display along the Y axis of the chart in the Y Axis
Minimum (%) field.
9.
1.
2.
3.
4.
Refer to the second table in Advanced Trend for a complete description of the columns
Output data is edited in the same manner. One or more cells in a row may be selected and then cut, copied or pasted to the
windows clipboard. To select a complete row, click on the left hand cell of the desired row. A single action Undo facility is
provided to allow the undoing of the last action performed.
The output data may also be sorted and rearranged using standard Windows methods. Additionally, a fill down feature (File
> FillDown) allows all cells in a column that are below the selected cell to filled with the same value as the selected cell. For
instance, if all blocks to be monitored were on the same Loop, you could go to the top cell of the Loop column, type in the
desired loop number, press Enter and then select Edit > FillDown. All other cells in the loop column will then have the same
loop number as the top cell.
1.
2.
Enter the name of the file that will contain the trended output values in the Record File Name field in
the Recording Options window. By default, this file has the same name as the trend document but
with a .rcd extension.
3.
Select the time interval (time period the recording takes place) and click OK. Available options are:
1.
2.
3.
4.
Refer to the first table in Advanced Trend for a complete description of the columns
Tunable specification data is edited in the same manner. One or more cells in a row may be selected and then cut, copied
or pasted to the windows clipboard. To select a complete row, click on the left hand cell of the desired row. A single action
Undo facility is provided to allow the undoing of the last action performed.
2VAA000812R0001
12-43
The tunable specification data may also be sorted and rearranged using standard Windows methods. Additionally, a fill
down feature (File > FillDown) allows all cells in a column that are below the selected cell to filled with the same value as the
selected cell. For instance, if all blocks to be monitored were on the same Loop, you could go to the top cell of the Loop
column, type in the desired loop number, press Enter, and then select Edit > FillDown. All other cells in the loop column will
then have the same loop number as the top cell.
1.
Select File > Convert Trend Files - Composer (.tnd) to Advanced (.tat) Format or File >
Convert Trend Files - Advanced (.tat) to Composer (.tnd) Format.
2.
Select the source file in the standard Windows file selection window and click OK.
The new file has the same name (different file extension) and is created in the same location as the source file.
12.4.7 Pan
The pan left, pan right, pan up, and pan down toolbar buttons allow the chart area to be panned in all directions. Use the
undo pan button to return to the default view.
1.
2.
Enter the appropriate loop number, starting node number, and ending node address in the Scan Loop
window.
3.
To view a report of the status of all the modules in the scan, click Module Status Report.
To view a report of the problems reported by the modules in the scan, click Module Problem Report.
NOTE: A new record file is created every time recording is started. Previous files with the same name will be overwritten!
The stop scan and record, pause scanning, start record, and stop recording buttons perform the indicated functions.
a.
1.
2.
Enter the appropriate address (control network, control unit, and controller) in the Tune/Edit Block
window. A warning message is displayed if the controller is not in execute or configure mode.
3.
If necessary, click the >> button next to the Status field and select the desired controller mode
(execute or configure).
4.
Click Get Configuration to retrieve the current configuration from the controller.
5.
- or 12-44
2VAA000812R0001
b.
Zoom
Enter the block number in the Block field and click Get Block.
6.
Edit the tunable specifications (appended with a - T). Non-tunable specifications can also be edited
when the controller is in Configure mode. Modified data is sent to the controller immediately.
12.4.11Zoom
The zoom in and zoom out toolbar buttons allow the chart area display resolution to be increased or decreased as required.
Use the undo zoom button to return to the default zoom setting.
2VAA000812R0001
12-45
Zoom
12-46
2VAA000812R0001
Introduction
ww
xx
yyy
Major version
Minor version
Build number
This information may be needed when performing upgrades or reporting issues with hSysCfg.
The following sections explain the configuration using various connection methods (serial, TCP/IP, and SCSI).
2VAA000812R0001
13-1
Information
The description input into this field will appear in the Application Logical ICI
field after clicking Apply > Quit and then restarting the hSysCfg program.
The Physical ICI Device field is used to define the type of physical device to be connected. Click the Physical ICI Device
arrow for a listing of available options.
The Physical Connection Type field is used to define the network communication protocol to be used by client applications
when using the logical ICI. When a COM port is selected for the Physical ICI Device, the Physical Connection Type is set
automatically to SERIAL. Likewise, SCSI devices use a SCSI Physical Connection Type and Ethernet interfaces use
TCP/IP as the Physical Connection Type. More than one logical ICI can be defined to communicate with the same physical
computer interface using different network communication protocols.
Caution
13-2
2VAA000812R0001
Information
Command Buttons
SCSI will ONLY appear in the Physical Connection Type field when an
attached SCSI device is detected or when a SCSI device is added manually
using the SCSI tab in the Connection Type definition frame
The Default button is used to return all configuration fields for the currently selected logical ICI back to their ABB
defaults.
The Restore button is used to return all configuration fields back to their last saved values (last time Apply was
clicked) for the currently selected logical ICI.
The Export button will create a disk file that can be used to transfer settings to another PC.
The Quit button exits the hSysCfg program without saving. If changes have been made to the configuration,
clicking Quit will prompt the user to save the changes.
Information
The IP Address field is used to enter the IP address of the INIET800 node or the NCC, or the name or IP address
of the remote communication server. The INIET800s IP address must be in standard IP dot notation (xx.xx.xx.xx).
Information
2VAA000812R0001
By default the hSysCfg program populates the IP Address field with the local
computers name. When using a name for a remote server, the name of the
remote server must be in a Domain Name Service (DNS), a WINS server, the
LMHOSTS file, or in the computers internal host entry table.
13-3
The Port field is used to enter a TCP/IP service port number. When TCP/IP network protocol is the physical
connection type between the INIET800 or NCC and the PC, the port number is set to 3000 and the field is disabled.
For remote server applications, enter the port number in the Port box.
The Test Connection button is used to verify communications with a target INIET800. After completing the IP
Address and Port boxes, Click Test Connection to verify communication. Upon successful communication with the
target INIET800 the following message will be displayed:.
If a valid IP address is entered, but the device is not an IET, or communication or security settings do not match the
settings of the INIET800 module, the following message will be displayed:
The IET800 Settings, Security Level radio buttons are used to select the type of security to be used with the
INIET800. When the INIET800 is configured for Ethernet communications both the Basic and Advanced security
level options are available. Selecting the Advanced security radio button enables SSL security. Otherwise Basic
security is used. See the INICI800 users manual for a description of the security scheme used in the INIET800.
NOTE: The security setting defined in the software must match the security setting defined on the module hardware.
See INICI800 users manual for instructions needed to set up the INIET800 module.
The Assign IP button is used to assign or to re-assign the IP address of the INIET800. Enter the desired IP address
into the IP Address field and select Assign IP.
Information
The PC running hSysCfg and the INIET800 must be on the same network
segment in order for Assign IP to function properly. If they are not on the
same segment, then the IP address of the INIET800 must be configured
using the INIET800s serial diagnostic port connector.
13-4
1.
2.
Click Assign IP. An attempt will be made to ping the address. No response should occur.
2VAA000812R0001
3.
4.
Enter the desired IP address (again), and the default Ethernet gateway and subnet mask.
5.
Click OK. The hSysCfg program will enter BOOTP mode and then waits for the INIET800 to send a
BOOTP request.
6.
Restart INIET800 module. The INIET800 will send a BOOTP request on restart, and hSysCfg will
then respond by assigning the INIET800 the IP information previously entered. The INIET800 will
then restart and hSysCfg will issue a ping command to the INIET800. The hSysCfg program then
reports a successful IP address assignment.
IP Reassignment Procedure.
1.
2.
3.
4.
5.
6.
Restart INIET800 module. The INIET800 will send a BOOTP request on restart, and hSysCfg will
then respond by assigning the INIET800 the IP information previously entered. The INIET800 will
then restart and hSysCfg will issue a ping command to the INIET800. The hSysCfg program then
reports a successful IP address assignment.
NOTE: IP reassignment will take the INIET800 offline and will disrupt any active communication.
The Global Network Adapter Parameter Tuning (IET only) box lists all of the available network adapters on the
workstation. The hSysCfg program will modify communication parameters for the selected adapter in order to
optimize communication with INIET800 module. Select one or more network adapters from this list that will be used
for communication with the INIET800.
The Baud Rate box is used to select the baud rate for the serial connection. Click the Baud Rate arrow to select
from the available options. Baud rate options will vary depending on the Physical ICI Device setting.
The Parity box is used to select the parity to be used for the serial connection. Click the Parity arrow to select from
available options (none, odd, or even).
2VAA000812R0001
13-5
The Data Bits box is used to enter the number of data bits to be used for the serial connection. Click the Data Bits
arrow to select from available options (7 or 8).
The Stop Bits box is used to enter the number of stop bits to be used for the serial connection. Select the Stop Bits
arrow to select from available options (0, 1, or 2).
The Baud, Parity, Data Bits, and Stop Bit boxes are enabled whenever COM selection is made in the Physical Connection
Type drop down box. The settings selected on this screen must match the INIET800 modules settings. See INICI800 users
manual for instructions on setting up the INIET800 module.
13-6
The Bus field is used to select the bus associated with the SCSI device. Select the Bus arrow to select from
available options (0 - 7).
The Controller field is used to select the controller number. Select the Controller arrow to select from available
options (0 or 1).
The LUN or Logical Unit Number field is used to select the SCSI address associated with the SCSI device. Select
the LUN arrow to select from available options (0 - 7).
The TCP/IP Port field is used to identify which port will be used when the ICI is acting as a remote communication
server.
2VAA000812R0001
The Electronic ID box will display the INIET800s MAC address. After completing all fields on the TCP/IP Tab, click
Read License to update the Electronic ID box. Clicking the Read License button will cause hSysCfg to query the
INIET800 specified by the values assigned in the IP Address and Port setting fields. The hSysCfg program will
attempt to complete the Electronic ID and Device License fields. Blank fields will be returned if the INIET800 cannot
be found or if a valid INIET800 license has not been written to the device. The INIET800 must already have had its
IP address assigned in order to use these functions.
The Write License field is used to enter the INIET800 user license key. See the instructions that came with the
INIET800 on how to obtain an INIET800 license key from ABB. Contact ABB Support for help in obtaining INIET800
license keys.
Clicking the Write License button causes the license string listed in the License Key field to be written to the
INIET800 identified in the Application Logical ICI field. If an incorrect license file is written the hSysCfg program will
return the following error message
If the INIET800 already contains a valid license, it will be over written by the new license data.
2VAA000812R0001
Installation of the Harmony API software and the configuration of one or more serial logical/physical computer
interfaces using the hSysCfg program.
13-7
Verification that the server system can communicate with the selected physical computer interface. This must be
done by running the application program on the target machine and verifying that it can communicate with the
computer interface.
NOTE: Only ICI serial interfaces may be setup to run as a Windows service. This section does not apply to Ethernet
interfaces because an Ethernet interface can be accessed from client applications directly without need for a separate communication server.
DD_<connection type>
For example, a physical INIET800 interface connected to the COM1 serial port would have a Harmony API server service
named DD_COM1.The service is installed by running DeviceAsService.exe (from its fully qualified path) with the service
Information
All HarmonyAPI servers that are installed as a service must conform to this
naming convention
DD_COM1 installed
Run the DeviceAsService.exe for each physical ICI that is to be run as a Windows service.
13-8
1.
After double-clicking the Services icon, highlight the Harmony API server service record
and click Startup.
2.
By default, the Startup Type is set to Manual. The Startup Type option may be set to
Automatic (recommended) to ensure that the service will start automatically every time the
computer is rebooted. Click OK to close the dialog box.
2VAA000812R0001
From Services in the control panel, select the service and click Start.
Invoke the NET.EXE utility command sequence from the Windows Run dialog box by entering:
Check the Event Viewer > Application Log to determine if the service has been started correctly. Startup, shutdown, and
diagnostics will also be displayed in this log.
Login to the system and terminate the DeviceAsService.exe program using Windows Task Manager.
From Services in the Windows Control Panel, select the service and click Stop.
From Services in the Windows Control Panel, select the service, click Startup, select either Manual or Disabled,
click OK and reboot the computer.
NOTE: The terminal emulation program must be capable of performing a file transfer using XModem protocol.Third
party terminal emulation software, such as Tera Term, is not supplied by ABB
1.
Connect a PC's serial port to the IET800's DB-9 diagnostic connector, P11, which is located
behind the IET800's front plate. Configure the PC's terminal emulation software (third party
terminal emulation software is not supplied by ABB) for 9,600 baud, 8-bits, 1-stop bit, No
parity.
2.
Set the IET800's SW1 pole-2 to OPEN, SW2 pole-6 to OPEN, SW4 poles-6,7,8 to OPEN. All other
switch poles are set to CLOSED. Install the IET800 into the MMU, along side its NIS21.
The following should appear on the PC terminal emulation software display.
13-9
1-->TALK90
2-->Configure/View callup password
3-->Computer command/reply sequences (off)
4-->Set local time/date
5-->Monitor mode (off)
6-->Real Value Conversion
7-->Port address (-1)
9-->Default Time Sync accuracy (3)
Select option:
Starting up at IP address 0.0.0.0
with IP mask 255.255.255.0
default gateway 0.0.0.0
and security Advanced
MAC0 Address: 00C0C90144B9
MAC1 Address: 00C0C98144B9
Connection established with ICI Type 14 Mode 14
Firmware Revision A_0
Node 21 Loop 1
Not Restarted Off-line
Autostart Completed!
3.
Enter a zero '0' after the above appears. Note: This may take up to 1 minute following a reset, if the
IET800's configuration is set to its default IP address of 0.0.0.0.
4.
SELECT OPTION: 3
7.
2VAA000812R0001
ELECTRONIC IDS
0--> Read all MicroLAN Electronic IDs
1--> Read License
2--> Enter License
3--> Reset License
4--> Read MAC Address
5--> Read/Enter IP Address/Mask/Gateway
6--> Read License/Security Status
7--> Test License
Enter option: 5
9.
2VAA000812R0001
13-11
13-12
2VAA000812R0001
INDEX - i
A
Abbreviations 1-1
Add entity (file, database, etc.) 3-55
Advanced trend 12-41
Assign list 3-44
Automatic drawing generator 12-27
B
Binding log 3-8
Binding report 3-8
Branch control logic document 3-20
C
C files
Load 3-13
C program and data files 3-18
Change address 3-55
Change controller mode 3-9
CLD 2-4
CLT 2-4
Communication issues 3-20
Compile controller 3-9
Composer power tools 12-1
Advanced trend 12-41
Automatic drawing generator 12-27
Control logic editor 12-1
Revision manager 12-22
Composer prelaunch service 10-1
Configuration 10-1
Logon agent 10-2
Service administrator 10-2
Compress log 6-11
Configuration file 2-4
Change revision 3-35
Delete 3-56
Delete revision 3-35
History 3-35
Load from controller 3-35
Load to controller 3-35
Move 3-57
Properties 3-35
Rename 3-57
Verify 3-64
View configuration 3-61
Configuration server
Copy 3-56
Delete 3-56
Move 3-57
Control logic document 2-4, 3-22
Branch 3-20
Change address 3-55
Change revision 3-34
Copy 3-56
Create 3-27
Create revision 3-34
Delete 3-56
Delete revision 3-34
Edit 3-27
Export information 3-27
History 3-34
Import information 3-31
Link/unlink 3-20
Move 3-57
Print 3-33
Properties 3-34
Rename 3-57
Restore 3-22
Status 3-34
Tag synchronize 3-57
Upgrade 3-20
Verify 3-64
View configuration 3-61
Control logic editor 12-1
Database utilities 12-14
Function code editor 12-13
Manipulate Cls 12-1
Text/Xref editor 12-3
Control logic template 2-4, 3-20
Create 3-21
Edit 3-21
Properties 3-21
Restore 3-22
Settings 3-20
Upgrade 3-22
Control network 2-3, 3-6
Change address 3-55
Copy 3-56
Create 3-6
Delete 3-56
Import document 3-56
Move 3-57
Properties 3-6
Rename 3-57
Tag synchronize 3-57
Controller 2-4, 3-7
Change address 3-55
Change operating mode 3-9
Compile 3-9
Copy 3-56
Create 3-10
Delete 3-56
Harmony controller firmware 3-12
Harmony firmware 3-12
Harmony I/O device firmware 3-11
INDEX - ii
INDEX - iii
I
ICI connection to remote server 8-3
Import
Harmony controller firmware 3-12
Harmony I/O device firmware 3-12
List 3-48
Import document 3-56
Import information
Control logic document 3-31
Inspect 3-12
Intended user 1-1
L
Label device 3-12
Link/unlink CLD 3-20
List 2-5, 3-43
Assign 3-44
Copy 3-56
Create 3-44
Delete 3-56
Edit 3-44
Export 3-48
Import 3-48
Move 3-57
Properties 3-54
Rename 3-57
Load C files 3-13
Load data files 3-13
Load Harmony firmware 3-13
Log 2-4, 6-1
Compress 6-11
Create 6-3
Custom 6-3
Edit 6-3
Event 6-1
Export 6-11
Save 6-11
Log editing functions 6-11
LSD list 2-5
M
Manipulate Cls 12-1
Miscellaneous procedures 8-1
N
Non-system folder 2-3, 3-5
O
Online configuration 3-14
Open
Display 3-42
Exchange folder 3-5
Project 3-3
Output window 2-3
Overview 1-1
INDEX - iv
P
Print
Control logic document 3-33
Controller 3-16
Display 3-42
Display group 3-40
Problem reports 3-18
Program file
Change revision 3-35
Delete revision 3-35
History 3-35
Project 2-3, 3-1
Architecture 2-3
Auto open 3-1
Compact 3-2
Convert 3-2
Copy 3-56
Create 3-3
Development 2-5
Import document 3-56
Open 3-3
Properties 3-4
Repair 3-4
Run time functions 3-4
Save as 3-5
Properties
Configuration file 3-35
Control logic document 3-34
Control logic template 3-21
Control network 3-6
Controller 3-17
Display 3-42
Display group 3-41
Exchange folder 3-6
Harmony control unit 3-7
Human system interface 3-39
List 3-54
Project 3-4
R
Refresh system architecture 3-4
Rename 3-57
Replace fields 12-20
Replace specifiers 8-1
Report (binding) 3-8
Restore
Control logic document 3-22
Control logic template 3-22
Revision manager 12-22
Revisions 3-34, 3-35
Run-time functions 3-4
Always prompt on connect 3-5
Configure 3-5
Connect 3-5
Disconnect 3-5
Never prompt on connect 3-5
Restart 3-5
S
Save log 6-11
Scan loop 12-44
Shortcut 3-6
Standalone configuration viewer 9-1
Computer interface modules 9-3
Configuration files 9-1
Function blocks and codes 9-2
Status reports 3-18
System architecture window 2-3
System folder 3-5
System folders 2-3
T
Tag
Database 2-4
Edit 4-9
Overview 4-1
Fields 4-1
Synchronize 3-57
Types 4-1
Tag list structures 11-1
Terms 1-1
Text/Xref editor 12-3
Tune function block data 12-44
U
Upgrade
Control logic document 3-20
Control logic template 3-22
V
Verify 3-64
View
Configuration 3-61
Harmony control unit reports 3-7
Properties 3-63
Views 4-3, 8-1
Copy 4-4
Create 4-3
Modify 4-4
Save 4-8
Select 4-8
View list 4-4
Notice
The information in this document is subject to change
without notice and should not be construed as a commitment by ABB. ABB assumes no responsibility for
any errors that may appear in this document.
In no event shall ABB be liable for direct, indirect, special, incidental or consequential damages of any nature
or kind arising from the use of this document, nor shall
ABB be liable for incidental or consequential damages
arising from use of any software or hardware described
in this document.
This document and parts thereof must not be reproduced or copied without written permission from ABB,
and the contents thereof must not be imparted to a third
party nor used for any unauthorized purpose.
The software or hardware described in this document is
furnished under a license and may be used, copied, or
disclosed only in accordance with the terms of such
license.
This product meets the requirements specified in EMC
Directive 89/336/EEC and in Low Voltage Directive 72/
23/EEC.
ABB Ltd.
Business Unit Power Generation
P.O. BOX 8131
8050 Zrich
SWITZERLAND
Phone: +41 (0) 43 317-5380
Fax: +41 (0) 43 317-5382
www.abb.com/powergeneration
2VAA000812R0001