You are on page 1of 60

Composer ™

for Harmony

Introduction and Installation


Composer (Version 5.0)
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. ABB may have one or more patents or pending patent applications
protecting the intellectual property in the ABB product(s) described in this publication.
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 fea-
tures supported by a particular ABB product, the reader should consult the product spec-
ifications for the particular ABB product.

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 hard-
ware described in this document.

This document and parts thereof must not be reproduced or copied without written per-
mission 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.

Copyright © 2007 ABB


All rights reserved.

Release: December 2007


Document number: 3BUA000271R0002

TRADEMARKS
All rights to copyrights, registered trademarks, and trademarks reside with their respec-
tive owners.
Preface

This instruction provides an introduction to, and installation


procedures for, the Composer™ software application. This
instruction reflects the 5.0 software version. Some of the new
features and enhancements added to this version of Composer
are:

• Performance (when opening large projects and control logic


documents) and quality enhancements (over 40 cus-
tomer-reported issues addressed).

• Support for the following workstations:

800xA for Harmony system versions 3.1, 4.0, 4.1, and 5.0.

Conductor NT versions 5.0 and 6.0.

Operate IT™ Process Portal B version 2.0 (SP 1 and SP 2).

Process Control View versions 5.2, 5.3, 5.4, and 5.5

• Additional Verify and View and Monitor functionality.


Alarm and quality indications are now shown on View and
Monitor clients.

• New tools and functions:

External binding tool - Binds input references in one


project to output references in another project which
allows some large projects to be divided into smaller more
efficient projects.

Standalone configuration viewer tool - A separately


licensed tool that does not require Composer software or
projects in order to view CFG files or view and tune config-
urations in a controller.

CLD connection check function.

Synchronize with taglist function.

• A standard set of S800 I/O drawings and the PowerTools


are included on the Composer media.

3BUA000271R0002
Preface (continued)

• Improved import and export support for Process Portal B


workstations.

• Composer is now supported on Windows Server 2003 Ser-


vice Pack 2 and 800xA System Version 5.0 engineering
workstations.

• Online help has been updated to use the HTML help


system.

3BUA000271R0002
Table of Contents

Section 1 Introduction ..................................................................................................1-1


Overview .................................................................................................................. 1-1
New Features ........................................................................................................... 1-1
Composer Documentation ........................................................................................ 1-3
Composer Environment............................................................................................ 1-4
Exchange Window ................................................................................................ 1-4
System Architecture Window ................................................................................ 1-5
Projects.................................................................................................................... 1-5
Control Networks ..................................................................................................... 1-5
Harmony Control Units ............................................................................................ 1-6
Controllers............................................................................................................... 1-6
Control Logic Documents ......................................................................................... 1-6
Tag Database ........................................................................................................... 1-6
Human System Interfaces ........................................................................................ 1-7
Display Groups ........................................................................................................ 1-7
Displays................................................................................................................... 1-8
Logs......................................................................................................................... 1-9
Lists ...................................................................................................................... 1-10
Batch Data Manager .............................................................................................. 1-11
Features and Benefits ............................................................................................ 1-12
Intended User ........................................................................................................ 1-13
How to Use this Instruction.................................................................................... 1-13
Document Conventions .......................................................................................... 1-13
Reference Documents ............................................................................................ 1-14

Section 2 Requirements ...............................................................................................2-1


Introduction............................................................................................................. 2-1
Composer Platforms ................................................................................................. 2-1
Platform Requirements............................................................................................. 2-2
Software Requirements ............................................................................................ 2-3

Section 3 Installation ....................................................................................................3-1


Introduction............................................................................................................. 3-1
Preparations ............................................................................................................ 3-1
Installation .............................................................................................................. 3-2
Upgrade from Previous Version............................................................................. 3-3
Upgrading Projects (From Wintools 2.0) ................................................................ 3-3
Removing Previous Composer Versions................................................................. 3-5
Composer Installation .......................................................................................... 3-6
View and Monitor Server Installation .................................................................. 3-10
Unlicensed Software............................................................................................... 3-11

3BUA000271R0002 iii
Table of Contents (continued)

Section 3 Installation (continued)


Other Installation Options ......................................................................................3-11
Install Configuration Viewer ...................................................................................3-12
Install PowerTools ..................................................................................................3-13
Install PowerTools ADG ..........................................................................................3-13
Switching Between Local and Server-based Licensing .............................................3-14
Switching Between Central License Servers ............................................................3-14

Section 4 Software Licensing ......................................................................................4-1


Introduction .............................................................................................................4-1
Obtaining Ethernet Address .....................................................................................4-2
License Entry Program .............................................................................................4-3
Requirements .......................................................................................................4-3
Install ...................................................................................................................4-3
Uninstall ..............................................................................................................4-3
Running the License Entry Program......................................................................4-3
Selecting a Machine ID .............................................................................................4-4
Requesting Software Keys .........................................................................................4-4
Entering Licenses ....................................................................................................4-6
File Installation.....................................................................................................4-6
Manual Installation ..............................................................................................4-6
Licensing Troubleshooting ........................................................................................4-8
Locating the License File.......................................................................................4-8
Unavailable Machine IDs ......................................................................................4-8
Rainbow SentinelSuperPro Dongle ....................................................................4-8
Ethernet Address ..............................................................................................4-9
Error Codes ..........................................................................................................4-9
License Assignment Editor......................................................................................4-12
Assign Licenses ..................................................................................................4-12
License Diagnostics ............................................................................................4-13

iv 3BUA000271R0002
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 pro-
vide 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.

3BUA000271R0002 v
3BUA000271R0002
Introduction Section 1

Overview
The Composer product provides an integrated visual develop-
ment environment for Symphony™ system configurations. The
Composer environment greatly simplifies the configuration
and maintenance of Symphony systems. This section
describes the Composer environment, project parts, and rec-
ommended procedure for developing projects.

New Features
Performance enhancements - The following enhancements
have added:

• The ability to prelaunch projects gives better response


when opening projects and CLDs for large projects.

• Increased range of logic state descriptor indices (from 256


to +/-32,483) in Process Portal and 800xA for Harmony
workstations.

• Improved import and export functionalities with Operate IT


Process Portal and 800xA for Harmony workstations.

• Printing enhancements including ranges of sheets in a


control logic document.

• Objects can now be pasted in from other projects with or


without tag data. This allows CLDs, controllers, etc. that
generate errors while being copied to instead:

a. Be copied without tag data.

b. The tags should then exported and imported. The more


detailed error messages allow quicker resolution of the
problem.

• The name of logical ICIs is now displayed in the status bar


and dialogs preventing confusion when selecting ICIs.

• Export file names and timestamps are now displayed in the


Composer system list.

3BUA000271R0002 1-1
New Features

• Configurations can now be exported to .CFG files external


to the project and used by the Configuration Viewer and
Verify tools.

Composer is now supported on 800xA for Harmony engineer-


ing workstations.

Support for the following workstations:

• 800xA for Harmony system versions 3.1, 4.0, 4.1, and 5.0.
• Conductor NT versions 5.0 and 6.0.
• Process Portal B version 2.0 (SP 1 and SP 2).
• Process Control View versions 5.2, 5.3, 5.4, and 5.5

Additional Verify tool functionality - Any configuration in the


project or any exported .CFG file external to the projects can
be used and control logic documents can be updated with
specification changes based on comparison to external config-
uration files.

Additional View and Monitor tool functionality - The View and


Monitor tool can now open control logic documents containing
the tag name that is specified. View and Monitor clients now
provide alarm and quality information.

External Binding tool - This new tool allows input references


in a project to be bound to output references in other Com-
poser projects. Separate, more efficient projects can now be
engineered.

Standalone Configuration Viewer tool - This new tool can be


used without having to install Composer.

CLD connection check function - This new function checks


control logic documents for incorrectly connected signals after
conversion from WinTools projects.

Synchronize with taglist function - This new function updates


tag data in Conductor VMS display files (based on tag data in
the project) without having to open or export the display files.

S800 I/O drawings - A standard set of S800 I/O drawing is


included.

PowerTools - The PowerTools have been included on the Com-


poser media and can be installed using the Composer installa-
tion tools.

1-2 3BUA000271R0002
Composer Documentation

Online Help - Updated HTML help is now available.

Composer Documentation
There are ten instructions that pertain to the Composer soft-
ware application:

• Introduction and Installation - Provides introductory Com-


poser information and software installation procedures.

• Primary Interface - Provides information about the Com-


poser software, projects (and their parts), and how to use
Composer to create a project.

• Automation Architect - Explains the parts of a controller


configuration (control logic documents) and how to
configure one. A step-by-step example of control logic con-
figuration is also provided.

• Conductor VMS Display Configuration - Explains the


parts of a Conductor VMS display and how to configure
one. A step-by-step example of display configuration is also
provided.

• Grafx Display Editor - Explains the parts of the Grafx edi-


tors (versions 1.6, 2.3, and 3.2) and how to use them to
configure a display. A step-by-step example of display con-
figuration is also provided.

• Automation Interface - Provides information on how to use


the automation interface (an ActiveX® interface) to access
Composer project information without going through any
other interfaces.

• Batch Data Manager - Provides information about the


Batch Data Manager interactive tool and how to use it to
create, manage, and utilize Batch 90™ and user defined
function (UDF) programs.

• Batch 90 and User Defined Function (UDF) Programming


Language - Explains how the Batch 90 language provides
a means of configuring batch sequence strategies and how
the UDF language provides a means of creating custom
control functions.

3BUA000271R0002 1-3
Composer Environment

• Function Code Application Manual - Lists all the available


function codes and explains the specifications and outputs
of each code.

• View and Monitor - Explains how to publish control logic


documents (CLDs) in SVG format and to populate/create
Web sites on an IIS virtual directory where the CLDs can be
viewed remotely via a browser. Viewing and monitoring is a
separately licensed feature which allows the monitoring of
block output values read from control systems.

A complete set of Composer documentation is included on the


Composer program CD in an electronic format. The electronic
documentation can be installed during the Composer installa-
tion. To obtain printed copies of the instructions, contact a
local ABB representative.

Composer Environment
The base Composer product provides all the functionality nec-
essary to develop and maintain control system configurations.
Contained within the Composer window are the exchange and
system architecture windows (Fig. 1-1). Help is provided to
ensure that explanatory information is readily available.

TC00656A

Figure 1-1. Example Composer Window

Exchange Window
The exchange is a project-wide repository for control logic doc-
umentation and display configuration information. This win-
dow lists the folders that contain the component parts (control

1-4 3BUA000271R0002
Projects

logic templates, function codes, macros, shapes, and borders)


used to create controller configurations (control logic docu-
ments). Also listed are the folders containing the component
parts (symbols) used to create human system interface dis-
plays. There are two types of folders on the exchange. System
folders contain ABB-provided standard items. User folders
contain items stored by the user.

All the appropriate objects in exchange folders can be copied


into control logic documents using the drag and drop method.
It is also possible to cut, copy, and paste objects between dif-
ferent projects.

System Architecture Window


This window functions like the Microsoft® Explorer. The left
side of the window displays a tree structure representing the
Symphony system architecture. This tree structure directly
correlates to the actual control system. The system architec-
ture window has two possible views: document view and data
browser view. In the document view, the right side of the win-
dow displays that portion of the architecture that is contained
by the selected object and any documents attached to the
selected object. These documents can be opened by dou-
ble-clicking the document. The appropriate software will be
launched automatically. In the data browser view, the right
side of the window displays the tag data associated with the
selected object.

Projects
Projects are the largest structure in a Composer control strat-
egy architecture and typically control a whole process or at
least the major part of one. The structure of a project dupli-
cates the actual control system architecture which greatly sim-
plifies control system configuration. Contained within a project
is all the information needed to support the control system.

Control Networks
Control networks are communication highways by which
information is passed. These networks can be used to subdi-
vide complex processes into smaller, more manageable group-
ings. Control networks are the structures that contain all the

3BUA000271R0002 1-5
Harmony Control Units

human system interfaces, Harmony control units, and control-


lers. Control networks reside one level below the project in the
project architecture.

Harmony Control Units


Harmony control units are enclosures that contain controllers
and all the associated hardware (I/O blocks, power supplies,
etc.). They reside one level below the control network to which
they belong.

Controllers
Controllers perform the actual control functions. They are con-
figured using control logic documents. Controllers reside one
level below the node to which they belong.

Control Logic Documents


Control logic documents form the basis of a process control
system. These documents contain function code logic the con-
troller uses to control the process. Control logic documents
reside in the right side of the system architecture window.

Opening a control logic document starts up the automation


architect component of the Composer application. This compo-
nent provides all the functionality needed to edit control logic
documents. Figure 1-2 shows an opened control logic docu-
ment in the automation architect window. Control logic docu-
ments can be opened from the document or data browser view.

Tag Database
During the configuration of control logic documents, tags 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.

1-6 3BUA000271R0002
Human System Interfaces

Human System Interfaces


Human system interfaces provide a human interface to the
entire control system. They can be configured to display any
control system information an operator needs. They can also
be used to monitor system information, modify (tune) certain
configuration information, and control plant equipment.

TC00885A

Figure 1-2. Example Automation Architect Window

Human system interfaces reside one level below the control


network in the project architecture. Operate IT Process Portal
human system interfaces require a configuration server be
added to the project architecture at the control network level.
This server handles all the duties a human system interface of
other types would.

Display Groups
Groupings of Conductor VMS human system interface dis-
plays are called display groups. These groups provide a
convenient way of handling the unique displays for a specific
human system interface. Display groups reside one level below
the human system interface to which they belong.

3BUA000271R0002 1-7
Displays

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. Operate IT Process Portal and Conductor NT displays
(called models) are handled by the Grafx window. Displays
used throughout the whole project reside in a folder in the
exchange. These displays are copied to human system inter-
face display groups using drag and drop or copy and paste
functionality. These displays remain linked to the original dis-
play until they are edited. Changes made to the original dis-
play are reflected in all unedited copies. Conductor VMS
displays reside in the right side of the system architecture win-
dow after selecting the display group to which it belongs.

Opening a display starts up one of the optional display config-


uration components of the Composer application. These com-
ponents are the graphical display configuration (GDC) and the
graphics editor (Grafx) windows. These windows provide all the
functionality needed to edit Conductor VMS displays (GDC
window), Conductor NT (Grafx window) and Operate IT Process
Portal displays (Grafx window). Figure 1-3 shows an example
GDC window and Figure 1-4 shows an example Grafx
window.

TC00959B

Figure 1-3. Example GDC Window

1-8 3BUA000271R0002
Logs

GrafX Issues

• GrafX does not recognize software license ID numbers


when a dongle is used for the machine ID and the dongle's
serial number begins with leading zeros. When attempting
to launch the GrafX editor, GrafX incorrectly responds with
a software is not licensed message and aborts. The
workaround is to use the Ethernet ID associated with the
workstation for the machine ID when registering Composer
software.

• GrafX cannot read the machine ID from a dongle if the


Composer dongle is not the first dongle in the stack
connected to the parallel port. Again, the workaround is to
use the Ethernet ID associated with the workstation for the
machine ID when registering Composer software.

• When Composer is installed on a Conductor NT machine,


there is no automatic detection of the GrafX version
already installed on the machine. If the installer chooses to
load a different version of GrafX, then two versions of
GrafX will exist on the machine. To avoid this potential
problem, do not install GrafX when installing Composer on
a Conductor NT machine.

• If a machine does not currently have Operate IT installed


on it, installing Grafx 3.0 does not automatically install all
of the Operate IT submodels. The user will need to
manually copy these submodels from the Operate IT con-
figuration server to the appropriate Composer directory.
Typically, this is under:

Drive:\Program Files\ABB\Composer\Grafx\lib\mod-
els\FP

• If Grafx 3.0 was installed and comes up with a white back-


ground when invoked from the Operate IT configuration
server, the user should verify that Composer has access to
the Operate IT configuration server machine.

Logs
Custom logs can be configured for Conductor VMS human
system interfaces to collect data. Either time or event trigger-
ing can be used for data collection. The printing of a log can be
triggered by time, event, or data collection. Custom logs reside

3BUA000271R0002 1-9
Lists

in the right side of the system architecture window after select-


ing the human system interface to which it belongs.

Lists
There are six types of lists available to a project. They are:

• Engineering unit descriptor.

TC00783A

Figure 1-4. Example Grafx Window

• Logic state descriptor.


• Alarm comments.
• 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

1 - 10 3BUA000271R0002
Batch Data Manager

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, or 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. Lists reside
one level below the project in the project architecture.

Batch Data Manager


The Batch Data Manager is an interactive tool used for creat-
ing, editing, managing, downloading and debugging batch,
sequential, and user defined function code configurations. The
Batch Data Manager is composed of three product options:

• Batch 90 for phase execution which includes a full-fea-


tured text editor that is used to create and compile Batch
90 programs for downloading to the phase execution
(PHASEX) function code. In this batch execution model,
recipes are created and run using the SymBatch NT batch
manager and the Operate IT Process Portal node.

• Batch tools for batch sequencing which provides the capa-


bility to create and compile Batch 90 programs that are
downloaded to the batch sequence (BSEQ) function code.
Also included are the unit procedure editor and master
recipe editor which are used to create recipes in the batch
execution model.

• User defined function (UDF) codes which includes a


full-featured text editor that is used to create and compile
UDF programs which are downloaded to UDF-specific
function codes. These UDF-specific function codes are
incorporated into control strategies in the same manner as
any other function code.

3BUA000271R0002 1 - 11
Features and Benefits

Features and Benefits


Compatibility with ABB systems - Composer is compatible
with Symphony and INFI 90® OPEN systems.

Multiple user client/server architecture - Projects developed


with Composer are accessible by multiple users from multiple
locations at the same time.

Control logic template linking functionality - Allows users


to define logic that is controlled by a template or can be modi-
fied within a logic document.

Exchange (enhanced library support) - Control logic tem-


plates, macros, and shapes are stored in a central location
called the exchange.

System oriented navigation - Configurations are organized


by system architecture enabling the user to point and click
their way through a configuration.

Expanded file management capabilities - The ability to


provide a single view of the entire system architecture is inte-
grated into Composer.

Improved configuration quality while reducing engineer-


ing time - All applications share a system-wide database that
validates data and provides single point of data entry.

Engineered to operate on the latest platforms - Composer


is specifically designed to function on native 32-bit operating
systems such as Windows 2003 (SP2) and XP (SP2).

Compatibility with existing module and human system


interface configurations - Configurations developed with
previous system tools are easily imported.

Improved ease of use - Windows style of graphical user inter-


face is utilized.

Automation Interface - An ActiveX interface that allows a cli-


ent application read and write access to Composer project
information.

Sequence of events functionality - The configuration of


sequence of events related changes of state of up to 5,000
points (to one millisecond resolution) is now provided.

1 - 12 3BUA000271R0002
Intended User

Operate IT Process Portal support - The creation of Operate


IT Process Portal human system interfaces, configuration serv-
ers, and the importation of tag data are now supported.

Conductor VMS (version 2.0 and later) report point sup-


port - The configuration of report points (points that simulate
analog exception report, digital exception report, and segment
control function codes) and report point lists is provided.

Harmony hardware support - Harmony area controllers


(HAC), Harmony bridge controllers (BRC), and Harmony net-
work communication couplers (HNCC) are now supported.

Batch Data Manager application - Support for Batch 90


and user defined function (UDF) function code configurations
is provided by the Batch Data Manager application. Both
batch sequence (BSEQ) and phase execution (PHASEX) func-
tion codes are supported.

C utility program features - Inclusion of some C utility pro-


gram (CUP) features such as the ability to format the nonvola-
tile memory dedicated to C programs within a controller and
edit.CSP files to the list of currently available CUP features.

Intended User
This instruction can be used by system engineers or techni-
cians for a general overview of the Composer software and as
an installation guide.

This instruction assumes the engineer or technician has a


basic understanding of Windows operating systems.

How to Use this Instruction


Use this introduction section to become familiar with the Com-
poser application and its many features. Use the installation
procedure for a concise step-by-step guide for installing Com-
poser software.

Document Conventions
This document uses standard text conventions to represent
keys, display items and user data inputs:

3BUA000271R0002 1 - 13
Reference Documents

Display item Any item displayed on a screen appears as italic text. Example:

Running
User data input Bold - Identifies any part of a command line that is not
optional or variable and must be entered exactly as shown.

Italic - Identifies a variable parameter entered in a command


line.

[ ] - Indicates an optional parameter; text within the brackets


follows the previously described conventions.

Example:

CUP [port] [baud] [file_name.CSP]

SPECIAL KEYS - Identifies a specific key that is not alphabetic,


numeric or punctuation. Examples:

Press ENTER.
Press ESC V M. (Press and release each key in sequence.)
Press CTRL-ALT-SHIFT-DEL. (Press all keys in sequence with-
out releasing any one key until you have pressed them all.)
File names Name - Indicates a file or directory name. Example:

file1.exe
c:\new
Revision variable A ? indicates a value that may change depending on the ver-
sion of an item. Example:

Part number: 1234567?0


Part number: 1234567??

Reference Documents
Table 1-1 lists documents that may be referenced for addi-
tional information relating to Composer.

Table 1-1. Reference Documents

Number Document Title


3BUA000272R???? Primary Interface, Composer
3BUA000273R???? Automation Architect, Composer
3BUA000274R???? Conductor VMS Display Configuration, Composer

1 - 14 3BUA000271R0002
Reference Documents

Table 1-1. Reference Documents (continued)

Number Document Title


3BUA000275R???? Automation Interface, Composer
3BUA000276R???? Batch Data Manager, Composer
3BUA000277R???? Batch 90 and User Defined Function (UDF)
Programming Language, Composer
3BUA000298R???? View and Monitor, Composer
WBPEEUI210504?? Function Code Application Manual
WBPEEUI340020?? Grafx Display Editor, Composer

3BUA000271R0002 1 - 15
Reference Documents

1 - 16 3BUA000271R0002
Requirements Section 2

Introduction
This section describes the minimum and recommended plat-
form (hardware) and software requirements needed to suc-
cessfully run Composer software.

Composer Platforms
The following subsections describe the platform requirements
that must be met to successfully load and run the client and
server Composer software and install electronic
documentation.

NOTE: Hard disk space requirements include space for applicable project
data. However, these requirements may vary depending on the size and num-
ber of projects saved.

Table 2-1 lists the performance characteristics of Composer


systems.

Table 2-1. Performance Characteristics

Feature Characteristic/Value
Architecture
Structure Client/server
Simultaneously connected clients Up to 10 clients per configuration server
Configuration servers 1 per project or system
Communications servers 1 per Cnet interface device
Onet connection IEEE 802.3 Ethernet™, TCP/IP protocol
Communication module groups INFI-NET® via INICI01 (rev. F.1 or later),
IMCPM021 (rev A.2 or later),
INICI03 (rev. G.0 or later),
INICI12 (rev A.0 or later),
INPCI02 (rev E.0 or later), or
HNCC (rev A.0 or later)

3BUA000271R0002 2-1
Platform Requirements

Table 2-1. Performance Characteristics (continued)

Feature Characteristic/Value
Compatibility
Controller function block configuration MFC, MFP, BRC, HAC, LMM02, AMM03,
COM03/04, CLC03/04, SLC01/02
Controller BDM configuration
BSEQ batch, UDF MFP2, BRC2, and HAC2

PHASEX batch BRC2


HSI configuration options
Conductor VMS option Conductor VMS, OIS4x, SIG4x, PCV4.x, PCV5.x
Conductor NT and Operate IT options Conductor NT, Operate IT Process Portal
Industrial IT System 800xA 800xA for Harmony
NOTE:
1. The CPM02 provides communication only within a single PCU. Not all features of Composer (and later controllers) are avail-
able when using the CPM02.
2. Refer to the appropriate hardware instruction to verify the required firmware revision.

Platform Requirements
The recommended and minimum platform requirements to
run client, configuration server, and View and Monitor Com-
poser software are shown in Table 2-2.

Table 2-2. Platform Requirements

Description Recommended1 Minimum Required1


Processor Pentium® based, 3 GHz Pentium based, 500 MHz
Available hard disk space
To install Composer 1 Gb (client) 500 Mb
2 Gb (config server, View & Monitor)
For temporary files 40 Mb 40 Mb
For projects As required (size can range from 10 As required (size can range
Mb to 500 Mb or more for complex from 10 Mb to 500 Mb or
projects) more for complex projects)
RAM memory 1 Gb 128 Mb
Software media loading CD disk drive or access to one
device

2-2 3BUA000271R0002
Software Requirements

Table 2-2. Platform Requirements (continued)

Description Recommended1 Minimum Required1


Ports
Ethernet card Required for all platforms that communicate with each other or will
use the HNCC device. The card address can also be used as a
machine I.D. for licensing.
Parallel or USB Required for all platforms that use a dongle as a machine I.D. for
licensing.
Serial or SCSI Required when connecting a server or BDM through an INFI-NET to
computer interface: INICI01, INICI12, IMCPM02 - serial; INICI03
- serial or SCSI
Communication module INICI03 (firmware revision G.0 or later)
groups INICI01 (firmware revision F.1 or later)
INICI12 (firmware revision A.0 or later)
IMCPM022 (firmware revision A.2 or later)
INPCI02 (firmware revision E.0 or later)
HNCC (firmware revision A.0 or later)
NOTES:
1. Using workstations that do not meet the recommended system requirements will result in slower performance.
2. The CPM02 is not supported by BDM.

Software Requirements
Table 2-3 lists the software requirements that are needed by
the components of the Composer system.

Table 2-3. Software Requirements of the Composer Components


Environment 1.5.0 or Later
Internet Explorer 6.0

Connection to ICI
Local or Remote
(service pack 2)

(service pack 2)
Windows 2003

Composer 5.0

Java Runtime
Windows XP

SVG Viewer
Information
Server (IIS)
Internet

Composer node X X X X X8 X
1,9 5 7 6
View and Monitor server X X X X X X X
Central licensing server (CLS) X X9 X1 X X7
Publisher X2 X2 X X

3BUA000271R0002 2-3
Software Requirements

Table 2-3. Software Requirements of the Composer Components (continued)

Environment 1.5.0 or Later


Internet Explorer 6.0

Connection to ICI
Local or Remote
(service pack 2)

(service pack 2)
Windows 2003

Composer 5.0

Java Runtime
Windows XP

SVG Viewer
Information
Server (IIS)
Internet
View and Monitor client X X10 X3 X7 X4
10
Central licensing client X X X
NOTES:
1. Before installing CLS Server software on a Windows 2003 Server computer, verify that IIS and ASP.NET have already been
install and enabled.
2. When publishing, the users account must have the correct permissions to access to and interact with the virtual directory of
the IIS server. The correct permission on the Windows account is required in order to access and interact with the CLS computer.
3. The following setting must be made. Select Tools > Internet Options... > Security > Local intranet > Custom Level... and either
enable or prompt the Initialize and script ActiveX controls not marked as safe option.
4. Can be installed from the View and Monitor server when a View and Monitor Web site is first browsed. Administrator privileges
are required to install the SVG Viewer on the View and Monitor client.
5. Composer must be installed because the View and Monitor server uses some Composer software components. It must be
configured to use the server-based licensing option. No SETC or SETS license is required.
6. Installed as part of the Composer installation.
7. Java™ must be installed. Refer to http://www.java.com/en/download for download instructions.
8. Java must be installed Composer nodes containing CLS client software.
9. Requires Windows 2003 Server operating system software.
10. Requires Windows XP or 2003 Server operating system software.

2-4 3BUA000271R0002
Installation Section 3

Introduction
This section describes the steps necessary to install the Com-
poser software application.

NOTE: The Composer software can not be used until the appropriate software
keys are entered into the ABB software licensing software. These software
keys must be requested and received from ABB. Because of this delay, the
Composer software can not be installed and used in one session.

Preparations
Before installing the licensing and Composer software, proper
platform operation should be verified. Areas that should be
checked and verified are:

• Minimum hardware requirements are met.

• Windows XP (service pack 2) or Windows 2003 (service


pack 2) are installed and operating properly.

• If being installed in a networked environment, only TCP/IP


protocol is installed on the Composer platforms.

• All open applications are closed.

• All background applications (like screen savers) are dis-


abled or closed.

• The user installing the software has Administrator


privileges.

• The registration forms for all the Composer features are


present and they contain proper registration and validation
numbers.

If server-based licensing is to be used, the following additional


areas should be checked and verified:

• A computer running the central licensing server software is


available.

3BUA000271R0002 3-1
Installation

• The CLS server computer requires Internet Information


Server (IIS). The actual version depends on Windows oper-
ating system.

NOTES:
1. IIS and ASP.NET must be installed (and set to run automatically) on Win-
dows 2003 Server computers before CLS server software is installed.

2. If the license assignment editor is called up after the server based licens-
ing is installed, two error messages will appear. These are due to the security
settings in Internet Explorer. The Initialize and script activeX controls not
marked as safe option must be enabled to avoid these error messages.

• User credentials (username and password) are available for


a user that can log on to both the CLS server and the target
Composer computers. Alternatively, a new local user can
be created on both computers with the same username
and password and used during installation. For example:

CLS Server ALL CLS Clients


Local user: LCCUSER Local user: LCCUSER
Password: LCC#USER Password: LCC#USER

Installation
The Composer installation consists of three main areas or pro-
cedures. The procedures are described in detail. The areas are:

• Upgrade from previous Composer version.


• Installation of Composer software.
• Software license entry.

NOTE: A user with Administrative rights should be the first person to run Com-
poser (after it is installed) in order to set the default timeout values in the regis-
try for all other users.

3-2 3BUA000271R0002
Installation

NOTE: Installing Composer software on the same console as Conductor NT


has some limitations/constraints. A Composer communication server can not
be installed on the same computer as a Conductor NT Harmony server node.
Composer and Conductor can not simultaneously share a CIU. In order to use
GrafX on a console that has Conductor NT version 2.0 installed, a file must be
created with the following description:
Location: \Composer Installation Directory\Grafx\Bin
filename: XDC.ENV
The XDC.ENV file needs only the single line of text:
OPS_INDEX=1

NOTE: Composer 5.0 supports the upgrading of projects from Composer 3.2
through Composer 4.3.1. Projects used with earlier versions of Composer must
first be converted to at least Composer 3.2 format and then converted to Com-
poser 5.0. If necessary, contact ABB Technical Support for assistance.

Upgrade from Previous Version


This subsection describes the general procedure to upgrade to
the latest version of Composer on those platforms where Com-
poser has been previously installed. The steps to be followed,
in order, are:

1. Backup all Composer project files.

2. Uninstall any previous Composer (and associated pro-


grams) versions, using Windows Add/Remove Program appli-
cations. Refer to Removing Previous Composer Versions in
this section.

3. Restart the operating system.

4. Install the new version of Composer (and associated pro-


grams) using the Composer Installation procedures in this
section.

5. Restore Composer project files if necessary.

Upgrading Projects (From Wintools 2.0)


• The project conversion utility fails to convert a project with
an out of memory message in the convert tab of the output
window. This problem occurs when the conversion utility
software runs out of virtual memory. The amount of virtual
memory required by this utility is dependent upon the size
of the project being converted. If this problem is encoun-

3BUA000271R0002 3-3
Installation

tered, it is recommended that the virtual memory be


increased by increasing the size of the swap file. Product
testing has shown that 200 MB of swap file is sufficient for
most projects.

• If Composer's conversion utility is inconsistent when


rejecting valid tags, engineering unit descriptors, and logic
state descriptors when converting a WinTools project, then
the problem may result from a design constraint of Com-
poser's database engine.

• After a project is converted into Composer, the legacy sys-


tem borders DBORDHA, DBORDHAG, DBORDVA, and
DBORDVAG are not shown in the exchange. Composer
provides a Visual Basic® module for Access that can make
this set of borders visible and editable. After that they can
be swapped with new ABB borders using the Revision
Manager power tool.

The pre-Composer legacy borders BORDHD, BORDVD,


DBORD, DBORD1, DBORDH, and DBORDV are shown in
the exchange as shapes and not borders. The power tool
provides the ability to swap shapes with borders. This will
allow the this set of borders to be swapped with new ABB
borders. The provided file is MakeObsoleteBordersVisi-
ble.mdb in the Composer bin\SystemData directory.

The procedure for making legacy system borders visible is as


follows:

1. Using Access 97, open the project database (the .EBP file).

NOTE: Access 97 must be used to open the project database. Access 2000 (or
later) will not open the database.

NOTE: Do not make any changes to the internal data or structure of Composer
project files unless explicitly instructed to. Permanent loss of data may result.

2. Click on the menu item File > Get External Data\Import.

3. This will open an Import dialog. In this dialog navigate to


the MakeObsoleteBordersVisible.mdb.

4. Select this Access database and click Import.

5. This will open an Import Objects dialog. In this dialog


select the MakeObsoleteBordersVisible object in the Modules

3-4 3BUA000271R0002
Installation

tab and the MakeObsoleteBordersVisible object in the Macros


tab.

6. Click OK. This will add one Modules object and one Macros
object to the project database.

7. Go to the Macros tab, select the new MakeObsoleteBorders-


Visible macro and run it.

8. Use Composer to open the project and verify that there are
four custom borders in the logic palette (DBORDHA, DBOR-
DHAG, DBORDVA, and DBORDVAG).

• When converting a project to Composer, PCV trend lists


will not be converted. To work around this issue, the PCV
trend list should be exported from the WinTools project
and then imported into the Composer project after the con-
version from WinTools is complete (ignoring errors on the
trend convert). In order to successfully import a PCV trend
list, either the console to which the trend list is being
imported must be a PCV console or (if importing into a list)
the project context must be set to PCV.

• When converting a project from WinTools, IREF descriptors


cannot be saved until all CLDs containing OREFs have
been converted. The order cannot be guaranteed during
conversion, and some IREF descriptors may not be saved.
This can be seen when attempting to restore a converted
CLD that has never been opened and modified in
Composer. The missing IREFs will be restored with blank
descriptors.

Removing Previous Composer Versions


Previous versions of Composer must be removed before install-
ing a new version. Composer should be uninstalled using the
Windows Add/Remove Program function. The Add/Remove
function will provide the ability to remove individual compo-
nents or the entire application. The programs displayed will be
dependent upon the version of Composer installed and the
options installed. Names of the programs associated with
Composer that may show in the Add/Remove Programs win-
dow contain key words such as Composer, BDM, Batch Data

3BUA000271R0002 3-5
Installation

Manager, GrafX, license entry program, license entry installa-


tion, SemAPI runtime, etc.

NOTE: During the removal of some programs, the user will be prompted to
keep or remove certain shared files. It is recommended the shared files be
kept.

If Composer is the only ABB application installed, all programs


should be removed. If other ABB applications (i.e., SemAPI,
GrafX Editor, License entry, etc.) are installed, care should be
exercised when removing programs associated with both
applications.

Composer Installation
Install the Composer software by performing the following
steps:

1. Close all open applications and programs.

2. Log on to the computer as a Windows user with adminis-


trator privileges.

NOTE: Answer yes to all overwrite prompts (if prompted) to ensure proper
operation.

3. Insert the Composer CD disk into the CD drive. The main


installation window should appear automatically. If it does,
continue to Step 6. If it does not, continue to Step 4.

4. Select Run from the start menu.

5. In the run window, enter or use the browse button to


specify:

CD drive letter:\autorun.exe

6. Select Install Composer in the main installation window.

7. If IIS is not installed, a window appears that reminds the


installer that IIS is required for the central license server and
view and monitor server. Select Yes to continue with the instal-
lation. Otherwise, select No to cancel installation.

8. Click Next in the welcome window.

9. Read the software licensing agreement, enable the accept


option, and click Next.

3-6 3BUA000271R0002
Installation

10. Enter or verify the correctness of the user name and com-
pany name in Customer Information window and click Next.

11. Enable the Complete or Custom (recommended) option in


the Setup Type window and click Next.

12. Select the destination drive and folder for the Composer
software (default destination is recommended) in the Choose
Destination Location window.

13. If the destination is a new folder, click Yes to confirm the


creation of the new folder.

14. Click Next.

15. Select or deselect the Composer software components to be


installed in the Select Components window and click Next. A
description of each component is provided by highlighting it.
The amount of hard disk space available and the amount of
hard disk space needed to install the selected components are
displayed at the bottom of the window.

NOTE: If Composer is being installed on the computer that will be the View and
Monitor server, select at least the default components.
If Composer is being installed but will not be used on the View and Monitor
server (i.e., there is no SETC or SETS license for the Composer installation on
the View and Monitor server, only core Composer components are being
installed for View and Monitor server to operate correctly), then the Communi-
cation Server component must also be selected because it provides the ICI-
CONF program, which is the only way to configure communications on the
View and Monitor server in this case.
If there is a SETC or SETS license for the Composer installation on the View
and Monitor server, communications can be configured through Composer’s
RunTime > Configure menu selection.

With server-based licensing, Composer clients request license


validation from a license server. This method requires that at
least one computer have the central license server (CLS) soft-
ware installed. The central license server software is also avail-
able from the Composer CD installation menu. For
applications that are to support server-based licensing, soft-
ware licenses are entered only on the license server if the
server-based licensing option is selected. The local license
entry program should also be installed to allow licenses to be
entered for those applications which do not currently support
server-based licensing (GrafX, BDM, etc.). The License Admin-

3BUA000271R0002 3-7
Installation

istration option on the Installation menu is available to give


the option to later switch to local licensing.

The local licensing method is the same as in previous releases


of Composer. The license entry program is installed in the cli-
ent computer, and software licenses must be entered on each
client.

NOTE: View and Monitor servers also require server-based licensing to be


installed (CLS Client at least).

16. If Conductor NT Process Portal Display Editors was


selected to be installed, select the appropriate version of GrafX
(3.0 or 4.0) and click Next.

NOTES:
1. Only one GrafX application at a time can reside on any node.

2. Only GrafX versions 3.0 and 4.0 can operate under Windows 2000 or
later, and only these versions will be presented as choices.

17. Click Install in the Ready to Install the Program window.

The Composer installation process starts now.

18. If Composer Prelaunch Service was selected to be installed,


enter the appropriate user name and password in the Config-
ure a Username and Password window and click OK. If
desired, click Cancel and specify this information during the
configuration of the Composer Prelaunch Service.

NOTE: If the password of the user that configured the Prelaunch Service is
changed, it must also be changed using the Prelaunch configuration utility.

19. If CLS was selected to be installed but it already exist on


the computer, verify that the version number of the installed
CLS matches the version number shown in the window. If the
CLS version numbers match, click Cancel to continue the
installation.

20. If CLS was selected to be installed and it did not already


exist on the computer:

a. Click Next in the Welcome window.

b. Click Yes to accept the license agreement.

c. Choose the destination location or accept the default


location (recommended) and click Next.

3-8 3BUA000271R0002
Installation

d. Select CLS Client or both CLS Client and CLS Server in


the Select Components window and click Next.

e. Select the program folder to contain the CLS icons


(default program folder is recommended) and click Next.

f. If installing a CLS client, enter the name of the work-


station running the CLS server in the Central Licensing
System window and click Next.

g. Enter the user name and password of the user who


installed (or is installing) the CLS server in the ABB Local
Client Component (LCC) Username window and click Next.

h. Click Next in the Start Copying Files window.

i. Click Finish when prompted that the installation is


complete.

j. Click OK when prompted that the License Server Select


program will now be installed.

k. Enter the user name and password of the user who


installed the CLS server (Step g) and click Save.

l. Click Exit to exit the window.

21. If local licensing is to be installed:

a. Click OK when prompted that you will now be


prompted to set the machine ID and enter licenses for
Local Licensing.

b. Enter the appropriate licenses in ABB License Entry


Program window. Refer to Section 4 for detailed informa-
tion about entering licenses.

c. Exit the ABB license entry program.

NOTE: If server-based licensing, CLS client, AND CLS server are installed, no
prompt will be displayed but the appropriate licenses must be entered.

22. If server-based licensing is to be installed:

a. Click OK when prompted that the Licensing Server


Select program, which sets Composer’s license settings,
will now be opened, Server Based Licensing should be
selected and the same user name and password used in

3BUA000271R0002 3-9
Installation

the Central Licensing System Installation should be


entered.

b. Enable the Use Server-based Licensing Option option


in the ABB Licensing Options window.

c. Enter the appropriate node name in the Central


License Server Node field.

d. Enter the appropriate user name and password (same


user name and password used in the Central Licensing
System Installation) in the License Client Launch Settings
area and click Save.

e. Click Exit to exit the window.

23. If Conductor NT Process Portal Display Editors is selected


to be installed, the version of GrafX selected in Step 16 is now
silently installed.

24. If Batch Data Manager/UDF Languages is selected to be


installed, click Yes when prompted to install BDM 6.1.

25. Click Finish when prompted that the installation is


complete.

View and Monitor Server Installation


A View and Monitor server provides the virtual directories to
which Composer publishes web sites. In order for the View and
Monitor server to provide the monitoring functionality, Com-
poser components must be installed on the server so that
access can be gained to Composer projects and the runtime
environment. These components must be installed through the
installation of the Composer software on the View and Monitor
server. Composer does not need to be running on the View and
Monitor server and the SETC and SETS licenses are also not
needed to operate the server (unless the Monitor function is to
be available). Only the SETVM license is required. The CLS Cli-
ent software is required for View and Monitor servers to
acquire SETVM licenses during operation. Refer to the View
and Monitor, Composer instruction for more information on
View and Monitor.

3 - 10 3BUA000271R0002
Unlicensed Software

Unlicensed Software
Trying to run unlicensed Composer software causes a window
to appear. A notification that this software must be properly
licensed before it can be used and a button to start the ABB
software licensing software are in this window. To license the
software, select the button and refer to Section 4 for more
information. A loss of communication between a CLS client
and server will cause a warning (cannot get a license) to be dis-
played periodically until communication is restored.

Other Installation Options


A number of options are presented in the main installation
window.

• Introduction and Installation - Opens the Introduction and


Installation instruction.

• Install Composer - Installs Composer and its components.


Refer to Installation for more information.

• Other Installations - Opens a secondary installation win-


dow providing the following options:

Install Configuration Viewer - Installs the standalone


Configuration Viewer. Refer to Install Configuration
Viewer for more information.

Install Powertools - Installs the required system files, Con-


trol Logic Editor, Revision Manager, and Advanced Trend
PowerTools. Refer to Install PowerTools for more
information.

Install Powertools ADG - Installs the Automatic Drawing


Generator and Directive Conversion Utility. Refer to Install
PowerTools ADG for more information.

Install CLS - Installs the Central Licensing Service. The


Install Composer option installs this software automati-
cally if server-based licensing is chosen.

Install License Entry - Installs the License Entry program.


The Install Composer option installs this software auto-
matically if local licensing is chosen.

3BUA000271R0002 3 - 11
Install Configuration Viewer

Install Adobe Acrobat Reader 8 - Installs Acrobat Reader


so that electronic documentation (PDF format) can be read.

• View Composer Release Notes - Opens the Composer 5.0


release notes.

• License Administration - Opens the ABB Licensing Options


window which allows the type of licensing and correspond-
ing settings to be changed. Refer to Switching Between
Local and Server-based Licensing for more information.

• View ABB License Agreement - Open the ABB license


agreement.

Install Configuration Viewer


The Install Configuration Viewer option install the standalone
Configuration Viewer tool. To install the Configuration Viewer:

1. Select Install Configuration Viewer.

2. Click Next in the welcome window.

3. Read the software licensing agreement, enable the accept


option, and click Next.

4. Enter or verify the correctness of the user name and com-


pany name in the Customer Information window and click Next.

5. Click Install in the Ready to Install the Program window.

6. To install local licensing:

a. Click OK when prompted that you will now be


prompted to set the machine ID and enter licenses for
Local Licensing.

b. Enter the appropriate licenses in ABB License Entry


Program window. Refer to Section 4 for detailed informa-
tion about entering licenses.

c. Exit the ABB license entry program.

7. Click Finish when prompted that the installation is


complete.

3 - 12 3BUA000271R0002
Install PowerTools

Install PowerTools
The Install Powertools option installs the required Windows
system files, Control Logic Editor, Revision Manager, and
Advanced Trend tools. To install PowerTools:

1. Select Install Powertools.

2. Select the destination drive and folder for the PowerTools


software (default destination is recommended) in the Choose
Destination Location window.

3. If the destination is a new folder, click Yes to confirm the


creation of the new folder.

4. Click Next.

5. Select or deselect the PowerTools software components to


be installed in the Select Components window and click Next. A
description of each component is provided by highlighting it.

6. Click Finish when prompted that the installation is


complete.

Install PowerTools ADG


The Install Powertools ADG option installs the Automatic
Drawing Generator and Directive Conversion Utility. To install
Powertools ADG:

1. Select Install Powertools ADG.

2. Select the destination drive and folder for the PowerTools


ADG software (default destination is recommended) in the
Choose Destination Location window.

3. If the destination is a new folder, click Yes to confirm the


creation of the new folder.

4. Click Next.

5. Select or deselect the PowerTools ADG software compo-


nents to be installed in the Select Components window and
click Next. A description of each component is provided by
highlighting it.

3BUA000271R0002 3 - 13
Switching Between Local and Server-based Licensing

6. Select the appropriate restart option (now or later) and


click Finish when prompted that the installation is complete.

Switching Between Local and Server-based Licensing


To switch between local and server-based licensing at any
time:

1. Insert the Composer CD disk into the CD drive. The main


installation window should appear automatically. If it does,
continue to Step 4. If it does not, continue to Step 2.

2. Select Run from the start menu.

3. In the run window, enter or use the browse button to


specify:

CD drive letter:\autorun.exe

4. Select License Administration in the main installation


window.

5. Enable the Use Server-based Licensing Option or Use


Local Licensing Only option in the ABB Licensing Options win-
dow. If server-based licensing is selected:

a. Enter the appropriate node name in the Central


License Server Node field.

b. Enter the appropriate user name and password (same


user name and password used in the Central Licensing
System Installation) in the License Client Launch Settings
area.

6. Click Save and Exit.

Switching Between Central License Servers


To switch between CLSs or to change the user credentials used
for server-based licensing, follow these steps:

1. Select the following:

Start > Programs > ABB > License Server Select

2. Enter the server name or the user credentials in the win-


dow which appears.

3 - 14 3BUA000271R0002
Switching Between Central License Servers

3. Click Save.

4. Click OK.

5. Click Exit.

3BUA000271R0002 3 - 15
Switching Between Central License Servers

3 - 16 3BUA000271R0002
Software Licensing Section 4

Introduction
This section provides information for the proper operation of
the ABB software products and features that require licenses.
Software is licensed by relating a software key for each soft-
ware feature with a unique machine (computer) ID. Software
keys are obtained from the ABB software license administra-
tion system. Follow all steps for obtaining machine IDs,
requesting software keys, installing software keys, and install-
ing and running the license entry program.

NOTE: If central license server nodes are switched via the license server
select program while Composer or other license applications are running,
those applications must be shut down and restarted to get the new settings.

NOTE: With server-based licensing, Composer and other licensed applications


require the use of a set of user credentials (username and password) that can
be validated on the central license server in order for a license to be granted. If
a password is supplied that will expire, the password must also be updated in
the license server select program when the password expires. If this is not
done, licenses will not be supplied, and it is possible to be locked out after a
certain number of failed logon attempts. The password will have to be reset
and then correctly entered in the license server select program before Com-
poser can be used again. An alternative solution is to create standard user
accounts on both the CLS machine and the Composer client machines, all with
the same username and password (e.g., LICENSE_USER). Use that name
and password in the license server select dialog on the Composer client
machines. As long as the name and password match the name and password
of the account on the CLS machine, it will validate and allow licenses to be
granted. To avoid this problem, be sure to set this common user's password on
all machines so that it never expires.

For the software to run, the machine ID used to generate the


software key must be present on the configuration server
node. The machine ID identifies the node where the ABB soft-
ware licensing is handled, and the software periodically checks
that the machine ID is still present. A single machine ID sup-
ports multiple software keys for different features and for dif-
ferent applications.

3BUA000271R0002 4-1
Obtaining Ethernet Address

There are two types of machine IDs that the ABB licensing pro-
gram supports: a removable hardware key or a fixed Ethernet
address of an Ethernet card. Each type has its advantages and
disadvantages. Using the Ethernet address as a machine ID is
generally more convenient. However, if the Ethernet card that
was chosen is ever replaced or permanently removed from the
node, the software license will have to be reapplied for. Refer to
Obtaining Ethernet Address if this is the type of machine ID
that is to be used.

The Rainbow ® SentinelSuperPro™ hardware key or dongle is a


copy protection device that attaches to the parallel port or USB
port of the computer. Some advantages of a dongle are:

• Moving it from node to node. However, the software


licensed to the dongle can only execute on the configura-
tion server node that currently has the dongle attached.

• Other machine IDs may need to be replaced to upgrade the


node software. New software keys must then be requested.
However, there is no need to replace the dongle with
another one (unless it breaks).

NOTE: The dongle must be ordered from ABB, since ABB software can read
only dongles manufactured for ABB.

NOTE: In most cases, ABB software licensing functions support multiple don-
gles which are daisy chained together.

Obtaining Ethernet Address


To obtain the Ethernet card address:

1. Enter ipconfig /all from the DOS command prompt. The


Ethernet address can be obtained by choosing any listed
Ethernet adapter and recording the physical address line item.
For example:

00-60-08-CC-BB-B8

2. Record this machine ID (without the hyphens) on the ABB


licensing registration form and follow the instructions in
Requesting Software Keys to request software licenses from
ABB.

4-2 3BUA000271R0002
License Entry Program

License Entry Program


The license entry program is used to activate the software
features once the necessary software keys have been installed.

Requirements
The license entry program must be installed and run on a node
that has IIS services installed.

Install
The license entry program is normally automatically installed
with the software. To update an earlier version of the license
entry program, perform the standalone installation steps that
follow.

1. Insert the CD disk containing the software licensing


program into the CD drive.

2. Run: <CD drive>:\license\setup.exe.

3. Follow the prompts to complete the license entry program


installation.

Uninstall
This program uses the standard Microsoft uninstall steps:

Select the ABB License Entry program from the list and click
ADD/REMOVE.

Running the License Entry Program


After installation, the license entry program can be invoked by
selecting Start > Programs > ABB > License Entry (CLS client) or
Start > Programs > ABB Industrial IT > 800xA System > Licens-
ing > License Entry (CLS server).

Some software applications will automatically open the license


software at the end of their installation, or on the initial
startup of the software product.

3BUA000271R0002 4-3
Selecting a Machine ID

Selecting a Machine ID
1. Select the Available IDs tab of the license entry program
(Fig. 4-1).

TC03317A

Figure 4-1. Available IDs Tab

2. Click Refresh to update the list of machine IDs. The


choices for machine IDs are:

• Removable Rainbow SentinelSuperPro.


• Physical Ethernet address.

3. Select a machine ID, then click Set Machine ID to make the


selected machine ID the default used in other tabs.

Requesting Software Keys


To request software keys:

1. Obtain the machine ID of the node that the software is


installed on or going to be installed on. Refer to Selecting a
Machine ID to obtain a machine ID.

2. Locate and have available the license numbers found on


the license certificate form shipped with the software.

3. Complete the license key request form provided with the


software. Follow the instructions found on this form.

4-4 3BUA000271R0002
Requesting Software Keys

4. Otherwise, generate and complete a new request form


using the license entry program. To generate a software key
request form:

a. Select the Licenses tab of the license entry program


(Fig. 4-2).

TC02580C

Figure 4-2. Licenses Tab

b. Select the applicable license group for the product or


feature being licensed.

c. Click Request SWKey.

d. Verify that the machine ID is correct. If not, enter a new


machine ID. Click OK to continue.

e. Enter the registration number sent with the software


and click OK.

f. Enter the validation number sent with the software and


click OK.

g. Edit the form as necessary. Either save the form to a


file or print the form.

5. Send the registration form to the ABB software license


administrator using one of the methods described on the regis-
tration form.

6. Wait for the software keys to be returned. The method by


which the software keys will be returned is selected on the

3BUA000271R0002 4-5
Entering Licenses

registration form. The choices are Internet mail, postal mail, or


fax. A mail address or fax number must be included on the
form.

Entering Licenses
To install the software keys:

1. Run the license entry program by selecting Start >


Programs > ABB > License Entry (CLS client) or Start >
Programs > ABB Industrial IT > 800xA System > Licensing >
License Entry (CLS server).

a. Select the Licenses tab (Fig. 4-2).

b. Select the applicable license group for the product or


feature being licensed.

c. Each feature of the software requires a software key to


function properly. If the software key was received as an
e-mail message, follow the instructions in File Installation
to install it. If the software key is to be installed manually,
follow the instructions in Manual Installation.

File Installation
To install the software key from a file:

1. Save the e-mail message to a temporary file as a text file.

2. Click Add From File and select the temporary file saved in
Step 1.

3. Click Open. The program reads the file and gives the num-
ber of licenses found in the file.

4. Click Yes to proceed with the license installation. The steps


prompt to verify each license before it is installed.

Manual Installation
To manually install a software key:

1. Choose a feature and click Edit License. This opens the


Edit License tab.

2. Enter the following license parameters:

4-6 3BUA000271R0002
Entering Licenses

• Version.
• Expiration date.
• Licensed quantity.
• Software key.
• Option/user string.

NOTE: The option string must be entered if it is provided. The option string is
designated as User String when the software key is sent. In addition, the option
string must be entered in the Option/User String field.

The license parameters can be found on the software keys


form received from the software license administration system.
Verify that the parameters match the machine ID shown.
Figure 4-3 shows an example screen with the licensing infor-
mation entered.

1. Click Validate to verify that the information entered


matches the software key. Correct any errors found, including
failing to enter the option string if it was provided.

2. Click Save to save the entered license information.

NOTE: Click Save after entering and validating the information for each feature
of the software. Clicking Validate will only validate the information that was
entered, not save it.

3. Choose another feature, then repeat Step 2.

TC02581C

Figure 4-3. Edit License Tab

3BUA000271R0002 4-7
Licensing Troubleshooting

Licensing Troubleshooting
Licenses are kept in a license file for each license group. Basic
troubleshooting steps are to locate the license file and view its
contents.

NOTE: The most common problem occurs during software key installation if
the license parameter information is validated, but then is not saved. Refer to
Entering Licenses to enter, validate, and save the license parameter
information.

Locating the License File


To locate the license file:

1. Select the Licenses tab of the license entry program.

2. Select the desired license group.

3. The expected license file name is displayed by clicking


Details (Fig. 4-2). Use the Windows Explorer to check if the
specified directory and file exist.

Unavailable Machine IDs


Sometimes an option is not listed as an available machine ID.
The following describes what to do:

Rainbow SentinelSuperPro Dongle


If the Rainbow SentinelSuperPro dongle is not listed as a
machine ID option, verify the following:

1. Verify that the dongle was supplied by ABB. ABB software


can read only ABB dongles.

2. Verify that the dongle is attached to the parallel port or


USB port.

3. Click Refresh on the Available IDs tab to scan for newly


inserted IDs.

4-8 3BUA000271R0002
Licensing Troubleshooting

Verify that the device driver needed to access the dongle is


installed:

1. Select Start > Settings > Control Panel > Administrative


Tools > Computer Management > System Tools >
System Information > Software Environment > Drivers.

2. Verify the Sentinel service is running.

The installation of the Sentinel driver requires logging in as a


member of the Windows administrator group. There are two
methods of installing the driver from the license entry
program:

Method 1 - Run the license entry program and select File >
Load SPRO driver from the menu bar.

Method 2 - From a subdirectory of the license entry program


directory, run ...\SPRO\Win_NT\setupx86.exe.

To verify whether the Sentinel driver is installed or not, select


the Configure Sentinel Driver function. A message will appear
if the driver is not installed.

Ethernet Address
If the Ethernet address is not listed as a machine ID option:

• Verify the TCP/IP protocol was properly configured during


the installation of the product being licensed.

• Verify the Ethernet circuit card is functioning correctly.

Error Codes
Table 4-1 lists and describes license software error messages.

Table 4-1. Licensing Error Codes, Messages, and Descriptions

Code Message Description/Action


0 Success —
-1 Cannot find license Determine the expected location of the license file. Verify
file the file does not exist. Install the product.
-2 License file corrupted Delete the license file, then reinstall the product.

3BUA000271R0002 4-9
Licensing Troubleshooting

Table 4-1. Licensing Error Codes, Messages, and Descriptions (continued)

Code Message Description/Action


-3 No machine IDs None of the valid machine IDs could be found. Purchase
found any of the valid machine ID types, or install the software
on a machine with a valid machine ID type.
-4 Maximum number of Purchase additional licenses.
users reached
-5 No such feature Occurs when checking out a feature that has not been
exists licensed.
-6 No licenses checked Not an error. This message may occur if the software
out attempts to check in a license when it has not checked out
a license yet.
-7 Format of feature line Indicates an invalid license has been found in the license
is invalid file. This may be due to a program other than the license
entry program being used to edit the license file.
Delete the license for the feature, using the license entry
program Licenses tab. Then add the feature.
-8 Bad encryption code Indicates an invalid license has been found in the license
file.
Reenter the software key.
-9 Feature found but A license for the feature was found, but not for this node.
machine ID mismatch Get a license for this computer. Use the license entry
program (Available IDs tab) to view the machine IDs found
on this node.
-10 Feature found but A license for the feature was found, but for a different
wrong version version of the software. Obtain a license for this version of
the product.
-11 Feature found but A license for the feature was found, but for a different
wrong option string option string of the software. Obtain a license for this
option string of the product. Not all products utilize an
option string.
-12 Software expired The license for the feature was a temporary license, which
has since expired. Ensure the date on your node is
correct, or obtain a current license.
-13 Bad date The license entered had an invalid date.

4 - 10 3BUA000271R0002
Licensing Troubleshooting

Table 4-1. Licensing Error Codes, Messages, and Descriptions (continued)

Code Message Description/Action


-14 Duplicate license When adding a new license, an existing license for the
entry same feature, version, number of users and machine ID
was found.
-15 Software key does Occurs with an invalid license entry. The software key
not match entered does not match the features, version, etc. Check
parameters all fields in the license; one or more parameters must be
incorrect.
-16 License entry not When the license entry program deleted a license, the
found specified feature was not found.
-17 Cannot write to Determine the expected location of the license file. Verify
license file the file does not exist or is not read-only. Install the
product.
-18 Too many licenses A program requested more licenses than were available.
requested This error indicates that licenses for the desired feature
are available, but not in the quantity requested. Request
fewer licenses, if possible, or obtain more licenses.
-19 Cannot read license Determine the expected location of the license file. Verify
file the file does not exist or is not read-only. Install the
product.
-20 Start date for feature —
not reached
-21 Machine ID not found A license was found, but for a machine ID that is not
present in this node. Get a license for this node. Use the
license entry program (Available IDs tab) to view the
machine IDs found on this node.
-22 Machine ID type not A request for a specific machine ID type was made, but
found that machine ID type could not be found on this node.
-23 Machine ID Type not
supported

3BUA000271R0002 4 - 11
License Assignment Editor

Table 4-1. Licensing Error Codes, Messages, and Descriptions (continued)

Code Message Description/Action


-24 Could not read Check the Ethernet card.
machine Ethernet
address
-25 Could not open
network device
-28 Error in registry for Ensure the user has administrator privileges on the
license file computer.
Reinstall the product.
-29 Error in registry for
machine ID

License Assignment Editor


Composer utilizes a central licensing mechanism. The CLS
server dynamically distributes the available licenses as they
are needed by to all the nodes in the Composer system. How-
ever, the license assignment editor utility allows licenses to be
permanently assigned to a particular node.

Assign Licenses
To assign a license to a particular node:

1. Select Start > Programs > ABB Industrial IT > 800xA System
> Licensing > License Assignment Editor on the CLS server.

2. Enter the name of the node in the Select a Node or Applica-


tion field. Use the browse button if desired. Refer to Figure 4-4.

3. Click Add. The node name will appear in the Assigned Fea-
tures field.

4. Select the node name in the Assigned Features field.

5. Select the type of license to be assigned in the Available


Licenses field.

6. Enter the number of licenses (of the type selected) that will
be assigned to the node in the Number field.

7. Click Assign.

4 - 12 3BUA000271R0002
License Assignment Editor

8. Click Save. This will cause the licenses to be allocated as


specified.

NOTE: If necessary, licenses will be removed from existing nodes


to meet the specified license allocation.
9. Repeat these steps as required.

License Diagnostics
To display a complete listing of all the nodes in the project (and
all the available information about each node), click Diagnos-
tics. Refer to Figure 4-5.

To create a copy (XML format) of this information:

TC03527B

Figure 4-4. License Assignment Editor

1. Click Export.

2. Select the destination directory. The file name is


LicenseEditorDiagnostics.xml.

3. Click OK.

3BUA000271R0002 4 - 13
TC03528B

Figure 4-5. Diagnostic System Information

3BUA000271R0002
3BUA000271R0002 Printed in Sweden December 2007
Copyright © 2007 by ABB. All Rights Reserved
® Registered Trademark of ABB.
™ Trademark of ABB.

http://www.abb.com

Automation Technology Products Automation Technology Products


Wickliffe, Ohio, USA Västerås, Sweden
www.abb.com/controlsystems www.abb.com/controlsystems

You might also like