2PAA111691-600 C en System 800xa 6.0 Licensing Information
2PAA111691-600 C en System 800xa 6.0 Licensing Information
2PAA111691-600 C en System 800xa 6.0 Licensing Information
TRADEMARKS
All rights to copyrights, registered trademarks, and trademarks reside with their respective owners.
Section 1 - Overview
ABB 800xA License Model ............................................................................................12
Design Mode ........................................................................................................13
Production Mode ..................................................................................................13
License Types.......................................................................................................14
Production System License .................................................................14
Engineering License............................................................................14
Channel License ..................................................................................15
Internal License ...................................................................................15
Demo license ......................................................................................15
CLS Server and Client .....................................................................................................15
800xA Single Node .........................................................................................................16
Section 2 - Workflow
2PAA111691-600 C 5
Table of Contents
6 2PAA111691-600 C
Table of Contents
Revision History
Index
2PAA111691-600 C 7
Table of Contents
8 2PAA111691-600 C
About this User Manual
Any security measures described in this user manual, for example, for user
access, password security, network security, firewalls, virus protection, and so on,
represent possible steps that a user of an 800xA System may want to consider
based on a risk assessment for a particular application and installation. This risk
assessment, as well as the proper implementation, configuration, installation,
operation, administration, and maintenance of all relevant security related
equipment, software, and procedures, are the responsibility of the user of the
800xA System.
This user manual describes:
• The licensing mechanism used in the 800xA System.
• How to obtain the machine ID and obtain the Licenses.
• How to assign the licenses and view the status.
• Troubleshooting information.
Unless otherwise noted, the versions of all 800xA Base System and Functional Area
software described in this user manual are the latest release of 800xA 6.0.
2PAA111691-600 C 9
Warning, Caution, Information, and Tip Icons About this User Manual
Warning icon indicates the presence of a hazard which could result in personal
injury.
Caution icon indicates important information or warning related to the concept
discussed in the text. It might indicate the presence of a hazard which could
result in corruption of software or damage to equipment/property.
Information icon alerts the reader to pertinent facts and conditions.
Tip icon indicates advice on, for example, how to design your project or how to
use a certain function.
Although Warning hazards are related to personal injury, and Caution hazards are
associated with equipment or property damage, it should be understood that
operation of damaged equipment could, under certain operational conditions, result
in degraded process performance leading to personal injury or death. Therefore,
fully comply with all Warning and Caution notices.
Terminology
A complete and comprehensive list of terms is included in[1] in Table 4. The listing
includes terms and definitions that apply to the 800xA System where the usage is
different from commonly accepted industry standard definitions and definitions
given in standard dictionaries such as Webster’s Dictionary of Computer Terms.
10 2PAA111691-600 C
Section 1 Overview
The 800xA System licensing is the means to scale a system to fit the actual needs.
By offering the system as a base system with options, with scaled tags, logs, etc., the
system can be cost wise optimized for each use case. When needed, expansions can
be purchased and the system grows with the customer's needs.
It is important to recognize that installation is separate from licensing. Installation is
never prevented due to lack of licensing.
The system is identified to the license function by means of either a license dongle
which is purchased separately, or by the MAC address of one of the computers in
the installation.
The licensed rights are available in the license file, which is retrieved from ABB and
installed in the system. The license file contains license features that determine the
options and the amounts that are granted.
There are four basic types of licensed features:
• System feature - for system-wide functions available across many or all nodes
of the system. They are indicated one per system in the price list.
An example of this type is the connect options.
• System feature with scaling - for system-wide features. The scaling of no. of
tags, procedures, logs, and so on. are examples of this type of feature.
• Client feature - for client-specific functions applying to a single client node in
the system. Examples of this type are: Operator Workplace, Engineering
Workplace, and Batch Client.
2PAA111691-600 C 11
ABB 800xA License Model Section 1 Overview
• Hardware feature - this feature determines which hardware units are granted
for use. Each hardware unit, I/O, communication, and CPUs, comes with a
license. As hardware units are purchased, license features become available in
the license file.
At upgrade, the current usage of hardware has to be reported back to ABB so that
the appropriate licenses can be registered into the license file. A tool is available for
that purpose, which must be run on the system to be upgraded. It is important to run
the tool on a system with all Hardware modules installed.
800xA Central Licensing System (CLS) software follows the System 800xA life
cycle and it is part of System 800xA media. In system, CLS can be configured as
follows:
• Server.
• Client.
• 800xA Single Node (Stand-alone).
The Central Licensing System (CLS) also has a Central Licensing System extension
that adds the following aspects to the 800xA System.
• License Usage aspect.
• Library License Definition aspect.
• System Release Info aspect.
12 2PAA111691-600 C
Section 1 Overview Design Mode
The user has to set the license to Production Mode before using the system for
any plant operations.
The new licensing model is applicable to all systems including the systems that
are upgraded from previous versions. The procedure to get the license file for an
upgraded system is same as before and also refer to Control Hardware Report
Tool.
Design Mode
Design Mode license is used during the first phase of system design and system
engineering. This is the phase where the bulk of project engineering is made. In this
phase any feature can be used to its full extent. There is no enforcement of
individual licenses, which means users can build and test their applications without
being annoyed by license messages. A License Usage Report keeps track of current
license usage in the system.
In this mode, any operator related activities like using Operator Workplace, Opening
Faceplates and so on will be treated as license violations. Any attempts to perform
an operator related activity will lead to a violation message in the form of a semi-
transparent text appears as Design Mode, Licensed for Engineering only.
When time limited license is used, the license expires after completion off 18
months.
The 18 months of design mode is based on License file creation date.
Production Mode
In production mode the system is connected to a process. Licenses are actively
monitored with the purpose to validate the usage against what has been ordered.
Enforcement of individual license features is active, and the user is informed about
the possible license violations. Users are allowed to test all functions and there is no
license violation message displayed in system for first 90 days.
The initial 90 days of production mode is based on License file creation date.
In this mode, system events are generated whenever there is a license violation.
2PAA111691-600 C 13
License Types Section 1 Overview
License Types
There are different license types available as end-user license and additional license
types:
End-user License Types:
• Production system license.
• Engineering license.
Additional License Types:
• Channel license.
• Internal license.
• Demo license.
Engineering License
This license type is intended for customers who want an engineering system as
complement to the production system. This license type can never be configured so
that it controls a plant that is it remains in the design mode forever.
This license is purchased by referring to the production license, and it is function
wise a replica of the production system. If a customer has several production
systems the customer can use a replica of the largest system or have individual
engineering license replicas for each system.
This license type is also used by users who develop their own add-on to an 800xA
system, such as own aspect systems or libraries. In those cases additional
development licenses are required.
This license is a time limited license.
14 2PAA111691-600 C
Section 1 Overview CLS Server and Client
Channel License
This license type is intended for application engineering by channel partners and
ABB channels. System is in design mode. This license is time limited to 18
months.
This license is a time limited license.
Internal License
This license type is intended for demo systems, training, and education systems that
are permanently installed in demo rooms and training facilities. It is also used for
ABB internal development (R&D). System is in production mode. This license is
time limited to 18 months.
This license is a time limited license.
Demo license
This license type is intended for system demonstrations and previews. System is in
design mode. This license is time limited to 3 months.
This license is a time limited license.
2PAA111691-600 C 15
800xA Single Node Section 1 Overview
16 2PAA111691-600 C
Section 2 Workflow
The workflow for the Central Licensing System is shown in Figure 1. Clicking on a
box with blue text will take you to the associated procedure.
There are two branches in the workflow. One for obtaining the license key before
beginning the installation, and one for obtaining the license key after beginning
installation. It is highly recommended that you obtain the license key before
beginning the installation and integrate it into System Installer during the planning
phase. Obtaining the license key after beginning the installation will require halting
System Installer while you wait to fill out and send the License Request Form to the
ABB license and Automation Sentinel Administration System (SoFa), and then
receive the license keys from SoFa.
Refer to Appendix A, Diagnostic Information if problems occur with the Central
Licensing System.
2PAA111691-600 C 17
Section 2 Workflow
18 2PAA111691-600 C
Section 3 Manage the License
Licenses are obtained from the ABB license and Automation Sentinel
Administration System (SoFa). This topic describes how to obtain the machine ID
and request the License. The License must be loaded on the node where the Central
Licensing Server software is installed when they are received from ABB (typically
the Primary Aspect Server node).
2PAA111691-600 C 19
Read the Machine ID from a Dongle Section 3 Manage the License
20 2PAA111691-600 C
Section 3 Manage the License Read the Machine ID Using the License Entry Tool
2PAA111691-600 C 21
Request the License Section 3 Manage the License
22 2PAA111691-600 C
Section 4 Load the License
This topic is valid if you have received the License after installing the 800xA
T
System.
All License for 800xA System software must be installed before using the
applications. Install the License before attempting any post installation
procedures, as some procedures may require the License to be in place.
2. Select:
File > Load/Replace Licenses...
in the License Entry Tool as shown in Figure 3.
2PAA111691-600 C 23
Loading the License Section 4 Load the License
3. The Open dialog box appears. Browse the license file (.sla), which contains the
License and click Open.
4. If a License is already installed in the system, the “Overwrite existing license
data for 800xA” message (Figure 4) appears. If required, click Yes to load the
current License.
TC05710A
24 2PAA111691-600 C
Section 4 Load the License Loading the License
5. View the installed License in the License Entry Tool based on License Group.
Figure 5 shows the License installed for the 800xA basic system functions.
6. Select:
File > Exit
to exit the License Entry Tool when completed.
License file can also be loaded by using View and Load License file option.
Using this option user can view the available license features and SFA_ID in the
license file before loading.
For loading the extension license file, use Load/Replace Licenses or View and
Load license file option; if the extension license file has different SFA_ID in
comparison with previously loaded license file.
2PAA111691-600 C 25
Loading the License Section 4 Load the License
26 2PAA111691-600 C
Section 5 Assign the Licenses
This topic is not necessary if the license assignment was integrated with System
Installer during the planning phase (unless you want to manually change the
license assignment at a later time).
The Central Licensing System dynamically distributes the available licenses as they
are needed to all the nodes in the 800xA System. However, the License Assignment
Editor allows licenses to be permanently assigned to a particular node.
To assign a license to a particular node:
1. From the License Server node, select:
ABB Start Menu > ABB Industrial IT 800xA > System > Licensing>
License Assignment Editor
For more information on ABB Start Menu, refer to [10] in Table 4.
2. This launches the License Assignment Editor as shown in Figure 6. Enter the
name of the node in the Select a Node or Application box.
3. Click Add. The node name will appear in the Assigned Features box.
4. Select the node name in the Assigned Features box.
5. Select the type of license to be assigned in the Available Licenses area.
6. Enter the number of licenses (of the type selected) that will be assigned to the
node in the Number box.
7. Click Assign.
8. Click Save. This will cause the licenses to be allocated as specified.
If necessary, licenses will be removed from existing nodes to meet the specified
license allocation.
2PAA111691-600 C 27
Backup and Restore Section 5 Assign the Licenses
28 2PAA111691-600 C
Section 6 License Usage Report
The License Usage report provides license usage details for hardware and software
features in the system.
2PAA111691-600 C 29
Permanent License Type Section 6 License Usage Report
30 2PAA111691-600 C
Section 6 License Usage Report Software License Usage Report
2PAA111691-600 C 31
Software License Usage Report Section 6 License Usage Report
License Usage Report also displays the following data as in the Table 1:
Export option is used to generate license usage report in .xml format and provides
license details for hardware and software features in the system. The .xml file is
used to get License file from the ABB license and Automation Sentinel
Administration System (SoFa).
32 2PAA111691-600 C
Section 7 Control Hardware Report Tool
The license model enforces licensing for the 800xA Hardware components
including controllers and communication interfaces that has changed beginning
with System 800xA Version 6.0. Each installed 800xA Hardware components
requires a separate Hardware license.
ABB requires data from the existing system in order to generate hardware license
for each hardware component. The data is collected by running the ABB Control
Hardware Tool (2PAA114472*) in the existing system. This tool is available in ABB
SolutionsBank.
Run Control Hardware Report Tool as a Pre-Upgrade Procedure in the source
system to get the 800xA Hardware component details.
Verify 800xA System is up and running. Ensure all the required control projects
are online.
1. Download the Control Hardware Report Tool from ABB SolutionsBank.
2. Copy the ABBControlHWReport.exe into the local drive of the engineering
client node.
3. Double-click the ABBControlHWReport.exe to run the tool.
The hardware data will be collected in a .bin file. The output .bin file will be located
in the location where ABBControlHWReport.exe is launched. The .bin file is used
to get License file from the ABB license and Automation Sentinel Administration
System (SoFa).
Control Hardware Report Tool must be used only for AC 800M hardware to
collect hardware data.
2PAA111691-600 C 33
Section 7 Control Hardware Report Tool
34 2PAA111691-600 C
Appendix A Diagnostic Information
This topic provides diagnostic information for the Central Licensing System.
2PAA111691-600 C 35
License Status Viewer Appendix A Diagnostic Information
The License Status Viewer (Figure 10) is an application that can be used to diagnose
licensing problems. The License Status Viewer is installed with the License Client
and is therefore available on every node running the 800xA System software.
License Status Viewer provides details on License Violations and Temporary
Licenses if available in system.
36 2PAA111691-600 C
Appendix A Diagnostic Information License Status Viewer
Select:
ABB Start Menu > ABB Industrial IT 800xA > System > Licensing >
License Status Viewer
For more information on ABB Start Menu, refer to [10] in Table 4.
2PAA111691-600 C 37
CLS Relocation Appendix A Diagnostic Information
License Violations
If license violation messages (Applications are running Without Valid
Licenses) appear, use the License Status Viewer to determine which licenses are
in violation.
To save this list to a text file:
1. Open License Status Viewer.
2. Select:
File > Save
3. Enter a file name and browse to the directory in which to save the file.
4. Click Save to save the file.
Temporary Licenses
If temporary license messages appear, (Applications are running with
Temporary Licenses. This computer is unable to communicate
with the License Server.) use the License Status Viewer to determine the
connection status of the CLS server. The CLS connection status is listed at the
bottom of the License Status Viewer. A typical problem is that the License Client is
not pointing to the node running the License Server. If this occurs, refer to CLS
Relocation.
CLS Relocation
This section provides description to relocate the existing CLS Server usually hosted
on the Primary Aspect Server to another server preferably Secondary Aspect Server,
if the existing CLS Server is not available.
New CLS Server should be installed and configured manually incase it is not
already done. Follow manual procedures mentioned in the subsequent chapters to
install and relocate the CLS Server.
CLS Installation
Microsoft Internet Information Services (IIS) components must be enabled on
License Server node before setting up a License Server by installing the CLS Server
component.
38 2PAA111691-600 C
Appendix A Diagnostic Information Internet Information Services
2PAA111691-600 C 39
Internet Information Services Appendix A Diagnostic Information
40 2PAA111691-600 C
Appendix A Diagnostic Information Internet Information Services
5. Select the Installation Type and click Next as shown in Figure 11.
2PAA111691-600 C 41
Internet Information Services Appendix A Diagnostic Information
6. Select a Server or a Virtual Hard Disk on which to install roles and features and
click Next as shown in Figure 12.
42 2PAA111691-600 C
Appendix A Diagnostic Information Internet Information Services
8. Select the Web Server (IIS) (refer to Figure 14 and Figure 15) and/or
Application Server (refer to Figure 13)check boxes (depending on the current
configuration) and click Next to install the features.
2PAA111691-600 C 43
Internet Information Services Appendix A Diagnostic Information
44 2PAA111691-600 C
Appendix A Diagnostic Information License Server Setup
2PAA111691-600 C 45
Relocate the License Server Node Appendix A Diagnostic Information
a. Select Components dialog box: Select the Server option. All required
client components are also installed as part of the server installation.
b. Username and Password dialog box: Enter the username and password
for the 800xA Service account user (refer to [3] in Table 4). Use the
domain\user syntax to specify a domain account.
Follow the steps below to relocate or correct the Licence Server node.
1. Open License Status Viewer.
2. Select:
Tools > Change CLS Machine
3. The Central License Server Machine Selection dialog box appears (Figure 16).
Enter or browse for the node running the License Server.
46 2PAA111691-600 C
Appendix A Diagnostic Information Locate the License File
Dongles
If the desired USB port 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 USB port.
3. Select:
Machine Ids > Available IDs
in the License Entry Tool to scan for newly inserted IDs.
MAC Address
If the MAC 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 network adapter is functioning correctly.
2PAA111691-600 C 47
Common Error Messages Appendix A Diagnostic Information
48 2PAA111691-600 C
Appendix A Diagnostic Information Temporary Licence Error Message
8004AB89/4AB89 The Client is not in the same Possible causes are either the use of one
System as the active SFA. CLS server for more than one 800xA
system or nodes not added in the system
after recreation of system or client node
point to the CLS system that is not part of
corresponding 800xA system.
4ABCA A Hardware Key (Machine ID) Possible causes are either the dongle
has failed. You have %d hours removed from the node or it has stopped
remaining to correct the responding.
problem before licenses Use the License Entry Tool, on the IDs
become invalid. tab view the machine IDs of the computer.
8004AB8C A Hardware Key has stopped
responding. Replace hardware
key to correct.
NOTES:
%d indicates representation of an integer value corresponding to the total no of hours left over. By default it shows 48
hours and it decreases by one for every one hour.
2PAA111691-600 C 49
System Events for License Violations Appendix A Diagnostic Information
50 2PAA111691-600 C
Appendix B Related Documentation
Refer to [2] in Table 4 for a complete list of all product documentation applicable to
the 800xA System that are included on the Release Notes/Documentation media
provided with the system or available from ABB SolutionsBank. This document is
provided in PDF format and is also included on the Release Notes/Documentation
media. It is updated with each release and a new file is provided. Specific
documents referred to in this user manual are presented in Table 4.
The asterisk (*) appended to each document number is a wildcard character used
in place of the document revision. The wildcard allows searches in ABB
SolutionsBank to be independent of revision. All revisions of the document will
be displayed in the search result.
2PAA111691-600 C 51
Appendix B Related Documentation
52 2PAA111691-600 C
Revision History
The revision index of this User Manual is not related to the 800xA 6.0 System
Revision.
The following table lists the revision history of this User Manual.
Revision
Description Date
Index
A Published for 800xA System Version 6.0 December 2014
B Published for 800xA System Version 6.0.1 October 2015
C Published for 800xA System Version 6.0.3 September 2016
2PAA111691-600 C 53
54 2PAA111691-600 C
Index
C
CLS installation
Standalone option 16
I
IIS 38 to 39
Installation
CLS standalone option 16
Prerequisites
IIS 38 to 39
M
MAC address 21
Machine ID 19
S
Software keys 22
2PAA111691-600 C 55
Index
56 2PAA111691-600 C
Contact us
2PAA111691-600 C
www.abb.com/800xA
www.abb.com/controlsystems All rights reserved.