AVEVA Enterprise Licensing Guide

© 2019 AVEVA Group plc and its subsidiaries. All rights reserved.

No part of this documentation shall be reproduced, stored in a ret rieval system, or transmitted by any
means, electronic, mechanical, photocopying, rec ording, or otherwise, without the prior written
permission of AVEVA. No liability is assumed with respect to the use of the information contained herein.
Although precaution has been taken in the preparation of this documentation, AVEVA assumes no
responsibility for errors or omissions. The information in this documentation is subject to change without
notice and does not represent a commitment on the part of AVEVA. The soft ware described in this
documentation is furnished under a license agreement. This s oft ware may be used or copied only in
accordance with the terms of such license agreement.
ArchestrA, Aquis, Avantis, Citect, DYNSIM, eDNA, EYESIM, InBatch, InduSoft, InStep, Int elaTrac,
InTouch, OASyS, PIPEPHASE, PRiSM, PRO/II, PROV ISION, ROMeo, SIM4ME, S imCentral, SimSci,
Skelta, SmartGlance, Spiral Software, Termis, WindowMaker, WindowViewer, and Wonderware are
trademarks of AVEVA and/or its subsidiaries. An extensive listing of AVEVA trademarks can be found at:
[Link] All other brands may be trademarks of their respective owners.
Publication date: 2/4/2019
Contact Information
AVEVA Group plc
High Cross
Madingley Road
Cambridge
CB3 0HB. UK
[Link]
For information on how to cont act sales, customer training, and technical support, see
[Link]
 AVEVA Enterprise Licensing Guide

Contents
Chapter 1 Introduction to AVEVA Enterprise Licensing Platform .................................. 7
About this Help ......................................................................................................................... 7
What is AVEVA Enterprise Licensing? ........................................................................................ 7
How Does it Work?.............................................................................................................. 8
About Activating and Acquiring Licenses ............................................................................... 9
Using a Trial Licens e ......................................................................................................... 10

Chapter 2 Deploying AVEVA Enterprise Licensing ........................................................ 11

Licensing Components ............................................................................................................ 11
Organizing License Components into Topologies ...................................................................... 12
Single Node Topology ....................................................................................................... 14
Distributed Topology.......................................................................................................... 14
Disconnected Topology ..................................................................................................... 15
Licensing Topology Models ..................................................................................................... 15
Single Node Topology ....................................................................................................... 16
Multiple Nodes - Self-Hosted License Topology - Basic ....................................................... 16
Multiple Nodes - Self-Hosted License Topology, Local Lic ense Managers ............................. 17
Multiple Nodes - Centralized Licenses Topology ................................................................. 17
Dual Role Multiple Nodes - InTouc h Tag-Based Centralized Licenses Topology .................... 18
Redundancy Topologies .................................................................................................... 19
Multiple Node InTouch Tag-Based Topology - Redundant License Servers ..................... 19
Multiple Node InTouch Tag-B ased Topology - Redundant License Servers and Tag Servers
.................................................................................................................................. 20
Redundant RDS Servers .............................................................................................. 21
Redundant RDS Servers in a Virtualized Environment ................................................... 22
Redundant RDS Servers - Multiple Sessions from One Machine .................................... 22
Implementing Licensing Components ....................................................................................... 23
Installing License Manager and License Server ................................................................... 23
Configuring License Server for the Product ......................................................................... 25
About Licens e Manager Security ........................................................................................ 26
Working with Nodes in Workgroup Net work Configuration .................................................... 27
Working with Back-end Applications in a Work group Environment .................................. 27
AE Workgroup Licensing Utility..................................................................................... 28

Chapter 3 Using AVEVA Enterprise Licensing ............................................................... 31

Accessing License Manager .................................................................................................... 31
Navigating License Manager.................................................................................................... 31
Using the Lic ense Server Summary Page ........................................................................... 32
Using the Details Page ...................................................................................................... 34
Viewing Det ails for a Specific License ................................................................................. 36
Using the Grid Filter .......................................................................................................... 37
Activating Licens es ................................................................................................................. 37
Activating Licens es About Activation and Activation Modes ................................................ 37

3
AVEVA Enterprise Licensing Guide Contents

Setting the Activation Mode................................................................................................ 38

Activating Licens es in Online Mode .................................................................................... 39
Activating Licens es in Offline Mode .................................................................................... 40
Activating Licens es in Offline Mode Using Two Lic ense Managers .................................. 43
Deactivating Licenses in Online Mode ................................................................................ 44
Deactivating Licenses in Offline Mode ................................................................................ 45
Canc eling a Pending Offline Activation/Deactivation ............................................................ 47

Chapter 4 Administering AVEVA Enterprise Licensing ................................................. 49

Administering a License Server................................................................................................ 49
Adding and Removing a License Server ............................................................................. 49
Starting and Stopping a License Server .............................................................................. 51
Renaming a License Server ............................................................................................... 52
License Server Co-located with License Manager.......................................................... 52
License Server Remote from License Manager ............................................................. 53
Renaming Redundant Servers...................................................................................... 53
Resetting the License Server ID ......................................................................................... 55
Syncing Licenses .............................................................................................................. 55
Syncing Licenses in Offline Mode ....................................................................................... 56
Working With License Server Redundancy ......................................................................... 57
About Licens e Server Redundancy ............................................................................... 57
Basic Topology for License Server Redundancy ............................................................ 57
Enabling the License Server Redundancy ..................................................................... 58
Monitoring Pair Status Information ................................................................................ 60
Repairing the Primary Server ....................................................................................... 62
Disabling the License Server Redundancy .................................................................... 63
Recovering from Hardware Failure by Re -Imaging Hardware ............................................... 64
Using Command Line License Administration ...................................................................... 64
Using Command Line Functionality .................................................................................... 64
Managing the Licensing System in a Virtual Environment ..................................................... 65
Managing a License Server on a Virtual Image .............................................................. 65
Managing a Licensed Product Virtual Image.................................................................. 66
Renaming the License Server Node .............................................................................. 67
Working with the Grace Period ..................................................................................... 67
Ending the Grace Period ......................................................................................................... 68
Scenario 1: New Licens es for Server on Cloned Image ........................................................ 68
Scenario 2: Same Licenses for Server on Cloned Image ...................................................... 68
Ending the Grace Period in Offline Mode ............................................................................ 69
Reserving Licenses ................................................................................................................. 69
Reserving and Unreserving Licenses .................................................................................. 73
Monitoring License Usage ....................................................................................................... 73
About Monitoring Licens e Usage ........................................................................................ 74
Viewing License Feature Summary Information ............................................................. 74
Viewing License Usage Det ail Information ..................................................................... 75
About Changing Default Port Settings ...................................................................................... 76
Changing the Default License Server Core Service Port ...................................................... 76
Changing the Default License Server Agent Port ................................................................. 77
Changing License Manager Ports....................................................................................... 78
Opening a Port in Your Firewall .......................................................................................... 79

Chapter 5 Troubleshooting ................................................................................................. 81

Diagnosing Licensing Issues .................................................................................................... 81

4
Contents AVEVA Enterprise Licensing Guide

Diagnosing Licensing Issues using Log Messages .................................................................... 81

License Server Issues and Solutions ........................................................................................ 83
License Activation Issues and Solutions ................................................................................... 84
Acquiring Licenses Issues and Solutions .................................................................................. 86
License Reservations Issues and Solutions .............................................................................. 88
Grace Period Issues and Solutions........................................................................................... 89
Miscellaneous License Management Issues and Solutions ........................................................ 89

Chapter 6 Glossary.............................................................................................................. 91
Index ......................................................................................................................................... 93

5
 AVEVA Enterprise Licensing Guide

C HAPTER 1
Introduction to AVEVA Enterprise Licensing
Platform
In This Chapter
About this Help ............................................................................................................................... 7
What is AVEVA Enterprise Licensing? ............................................................................................. 7

About this Help

The AVEVA Enterprise Licensing Help topics are organized into different categories, grouped by
licensing operations. The categories are:
 Introduction to AV EV A Enterpri se Licensing: this category covers introductory information about
AVEVA Enterprise Licensing.
 Using AV EV A Enterpri se Licensing: this category covers basic licensing functions, such as
navigating the License Manager interface and activating licenses.
 Admini stering AV EVA Enterpri se Licensing: this category covers advanced licensing operations
that may be performed by an administrator.
 Troubleshooting: this category covers different recommended solutions for possible licensing
issues.

What is AVEVA Enterprise Licensing?

The AVEVA Enterprise Licensing system is a common platform that allows you to effectively and
efficiently manage AVEVA Enterprise Software product [Link] licensing system is composed of a
browser-based License Manager and a Lic ense Server that together allow you to share and deliver
licenses for your installed products.
The AVEVA Enterprise Licensing system is supported on the following web browsers:
 Internet Explorer version 10 and later
 Google Chrome versions later than 32
 Mozilla Firefox versions later than 27
 Microsoft Edge

Note: Microsoft Edge does not support single sign-on. Using Microsoft Edge will prompt you to sign in
with your Windows credentials before launching License Manager.

The following describes the components of the AVEVA Enterprise Licensing system.
License Manager
License Manager allows you to quickly access and maintain licenses for certain AVEVA Enterprise
Software products in your different environments by means of it s scalable, flexible design features:

7
AVEVA Enterprise Licensing Guide Introduction to AVEVA Enterprise Licensing Platform

 Browser-based for scalability and ease of use; can be remotely accessed by any of the above
supported web browser.
 Light-weight, standalone software you can install on the s ame node as the License Server computer,
or on any other node based on your deployment needs.
 Manage one or multiple License Servers to best organize and manage the licenses in your unique
environment.
 Access details about your licenses, such as usage information, from the License Manger interface .
License Server
License Server provides all the functionality to acquire, store, maintain, and serve licenses to your
installed AVEVA Enterprise software.
 Licenses are hosted and maintained on the License Server.
 Securely serve any types of soft ware application being licensed, including Windows browsers,
tablets, and mobile devices.
 Provide current license usage information.
Installed Products
Once the AVEVA Enterprise Software product is installed it relies on the licensing system to enable its
functionality. During product installation you decide from whic h License Server you want the product to
get its license. If a License S erver is installe d on the same computer as the product, it will use that one as
the default. If the product is installed on a different computer than the License Server, you can point the
product to License Server computer. All the products installed on the same computer w ould point to the
same License Server.

How Does it Work?

This section describes the licensing workflow. This example assumes that both Licens e Manager and
License Server are installed on the same comput er, and that the computer can connec t to the Internet.
 Purcha se one or more AVEVA Enterpri se Software products: Along with your installation media
or downloads, you will receive one or more entitlement files containing licenses details.
 Start License Manager: It opens in a browser window and accesses the installed License Manager
components.
 Select the License Server: Use the License Manager to select an available server to host the
licenses you want to activate.
 Import the entitlement file: Import the entitlement file (on page 91). Once imported, License
Manager displays the available licenses.
The entitlement file contains information for specific product licenses that is imported into the
License Manager to activate purchased licenses. It is s ent to you in an email upon purchase of your
product licenses. It is in a zipped .xml file format.
 Acti vate licenses: License Manager connects to the AVEVA Enterprise Activation Server over the
Internet to activate the selected licenses on the License Ser ver.
The Activation Server activates licenses on the License Server.
 Manage your license s: Licenses are now available for their res pective product to use. You can
now:
o activate new licenses
o deactivate current licenses
o reserve and unreserve licenses

8
Introduction to AVEVA Enterprise Licensing Platform AVEVA Enterprise Licensing Guide

 Install and Configure the purchased products: Install your purchas ed AVEVA Enterprise
Software products following the individual product installation instructions. The installed products,
when running, will acquire their licenses from the License Server and will release them when no
longer needed.
The following diagram shows the relationships bet ween the licensing components in a single node
system, but the workflow applies for all network topologies.

About Activating and Acquiring Licenses

License Manager and License Server are installed as part of the ins tallation process of your purchased
products. The Activation Server is not installed on your local comput er or network. These components
work together to provide licensing for your installed products.
License Activation (see "Acti vate (a license)" on page 91) is the process of enabling a purchased
license on a License Server for use by a product. The Activation Server takes an Activation ID, validates
it, and provides and an activated license in return.
Acquiring a license (see "Acquire (a license)" on page 91) occurs when an install product is started.
An installed product, when running, ac quires its activated license from the License Server and releases it
when no longer needed.
This section will give you an overview of how license activation works. For bot h activation modes, the
license entitlement file must be copied to the target computer where License Manager components are
installed, or to a location on your network where the target computer can access it.
You can use a trial license for a given product for try-out and testing purpos es.

9
AVEVA Enterprise Licensing Guide Introduction to AVEVA Enterprise Licensing Platform

Note: For detailed information and procedures regarding trial licenses, installation and activation, refer to
the AVEVA Enterprise Licensing Help.

Online Activation
Online activation provides the means to activate licens es when there are no int ernet restrictions in your
environment. This mode is configured by default in the Activation Settings menu.
For online activation to work, make sure that the License Manager has connectivity to both the License
Server, typically via an intranet, and to the Activation Server via the Internet.

Offline Activation
Offline activation provides the means to activate licenses when the Internet connection to the Activation
Server is restricted to certain areas in your environment.
In this mode there are two nodes involved to complet e the activation process:
 A node wit h License Manager components installed and network access to a License Server but no
Internet access to the Activation Server. The Offline Activation mode must be selected in the
Acti vation Settings menu.
 A node with Internet access to the Activation S erver and License Activation Web Page.

Using a Trial License

A trial license allows you to use the associated product for a limited period of time to try out and test the
product. Typically, a trial license is a binary file, for ex ample, "[Link]".
To use a trial license for a given product, place the binary license file at the following path:

%ProgramData%\Schneider Electric\Licensing\TrialLicensePool
You can then use the product directly, without using License Manager to activate the licens e. The
product will run until the indicated expiry date on the trial lic ense file.

Note: Trial licenses are not visible in the License Grid from the License Manager.

10
 AVEVA Enterprise Licensing Guide

C HAPTER 2
Deploying AVEVA Enterprise Licensing
In This Chapter
Licensing Components .................................................................................................................. 11
Organizing License Components into Topologies ............................................................................ 12
Licensing Topology Models ........................................................................................................... 15
Implementing Licensing Components ............................................................................................. 23

Licensing Components
The main components of the AVEVA Enterprise software licensing system are described in the following.
Use the topology concepts and models in this section to design your system, then follow the guidelines
and procedures to install and configure the licensing components.
License Server
The License Server handles all server functions related to managing licenses. The License Server:
 Hosts the licenses that enable the product to operate.
 Cont rols a set of services that handle the activation and deactivation of licenses.
 Provides license usage information.
For more information about managing License Servers, see About Managing a License Server.
License Manager Application and Components
You use the License Manager browser-based application to administer License Servers and their
associated licenses. The easy-to-use License Manager runs within a secured session in an Internet
browser. Using License Manager, you can:
 Activate licenses as new products are included in the topology. License Manager interacts with both
the License Server and the Activation Server to complete the activation. For information, see About
Activation and Activation Modes on page 37.
 Get detailed information on how the licenses are used by the products. For information, see About
Monitoring License Usage on page 74.
The License Manager components include the web services required to handle the interaction between
the License Server and the Activation Server. The License Manager components must be installed on at
least one node or c omput er that has Internet access to the Activation Server in order to activate licenses.
You can run the License Manager application remotely from the node where the Licens e Manager
components are installed.
Access License Manager by opening the following URL in your browser:
http:\\<nodename>\SELicenseManager
where <nodename> is the name of the node where the License Manager is installed.
Activation Server
The Activation Server is an Internet-based server that:

11
AVEVA Enterprise Licensing Guide Deploying AVEVA Enterprise Licensing

 Creates entitlements.
 Processes license activation and deactivation requests.
 Associates licenses with their corresponding License Servers.
 Keeps track of activated licenses.
The Activation Server is only accessed by the License Manager for license activation and deactivation
purposes. The Activation Server is hosted in the cloud by AVEVA Enterprise Software and is not
deployed to your net work topology.

Note: There are no permanent connections between the installed license components and the Activation
Server.

Visual Elements Used in Topology Diagrams

The following visual elements appear throughout the topology diagrams in this section to represent
licensing components.

Symbol Description

License Manager.

License Server.

Installed product(s).

Activation Server - hosted by

AVEVA in the cloud.
License activation is provided by a
cloud-based server in all topologies.
License Manager, remote or local
browser user interface.

Organizing License Components into Topologies

AVEVA Enterprise Licensing is scalable and flexible. You can set up single -node or multiple-node
systems. The information, guidelines and topology models in this section are provided to assist in
designing and then implementing a topology that matches your working environment.
You can create a topology of two general types:
 Single node topology
 Distributed topology
A third type is actually a subset of these - the disconnected topology. This is any topology where an
internet connection is not available. Each of these general types of topologies are described in the
following topics. The topology models topics then go into greater det ail of the different topologies you can
can use to deploy your system. See AVEVA Enterprise Licensing Topology Models.
If y ou are implementing a distributed topology, we recommend c reating a net work diagram as a first step,
to visually model the system before installing License Manager and License Server.

12
Deploying AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

The Lic ense Server and License Manager are delivered with the AVEVA Enterprise soft ware products as
independent components to allow you to deploy them to the nodes where they fit your requirements.

In this sample topology, a single node system, the product machine has both Lic ense Server and
License Manager components.
The components of the product interact with the License Server. The product component acquires and
releases activated licenses in the License Server to enable product functionality and client connectivity.
Guidelines for Designing and Implementing Your Licensing System
1. When centralizing licenses in a License Server:
a. If you have multiple licenses for t he same product with the same functionality hosted in the same
License Server, reservations are not needed.
b. If one or more licenses for the same product have unique functionality, then res ervations are
needed to ensure that those unique licenses are acquired by the proper node(s).
For example, if you host five InTouch 5K Run-Time licenses in a License Server an d you have
five InTouch nodes, no reservations are required. Any node can acquire any license.
If you host four InTouch 5K Run-Time licenses and one InTouc h 60K Run-Time license and you
have five InTouch nodes, then you must reserve the 60K Run-Time license for the node that
must acquire it to ensure only that node can use it.
2. The System Platform installation allows you to install the License Server, the License Manager or
both. Thes e can be installed in separate machines or all in a single node.
Consider the best location to install them based on your topology and system needs.
3. If you chose to centralize your licenses in one License Server, always leverage the License Server
Redundancy capability. License Server redundancy capability is available at no additional cost.
4. When working with virtualized environments, be sure to deactivate all licens es in a License Server
before cloning a VM. If t his is not done, the cloned License Server will go into Grace P eriod mode of
15 days, after which it will cease serving licenses.

13
AVEVA Enterprise Licensing Guide Deploying AVEVA Enterprise Licensing

Single Node Topology

The Single Node Topology is a single computer with the purchas ed product (in this case, the Product
Server components), Licens e Manager, and License Server installed, with an available Internet access
to the Activation Server (on page 91).

In this configuration, the communic ation between the product server components, License Server and
License Manager is local.
If the node has Internet access to the Activation server the licenses can be activated/deactivated in
"Online" mode. If this node does not have access to the Internet then a separate node with wit h Internet
access to the License Activation Web Page and Activation Server needs to be set up to complete the
activation process. See Activating Licenses in Offline Mode on page 40 for details.

Distributed Topology
The licensing components can be installed on separat e nodes as long as there is reliable network
connectivity bet ween them. Distributing the licensing component s across nodes may help optimize
resource us age. This topology is best suited for systems where the License Server manages licenses for
multiple products.
In the following example, the License Manager components are installed on one comput er with Internet
access to the Activation Server (on page 91), the License Server is installed on a second comput er, and
product components are installed on separate computers, each with network access to a License S erver.

If the node where the Lic ense Manager components are installed has internet access to the Activation
Server, you can activate/deactivat e the licenses using the "online" mode. For more information, see
Activating Licens es in Online Mode on page 39.

14
Deploying AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

If this node does not have access to the Internet, then you must set up a separate node with Internet
access to the License Activation Web P age and Activation Server to complete the activation process. For
more information, see Activating Licenses in Offline Mode on page 40.

Disconnected Topology
One computer must have Internet access to the License Activation Web Page and Activation Server in
order to complete the activation. However, your environment might not support this and you will have to
work around the disconnect.
A disconnected topology can have the following characteristics:
 The License Manager node has net work access to the License Server.
 A firewall or any constraints exist between the License Manager components and the Activation
Server.
In this scenario, you must set up a separate node with Internet access to the License Activation Web
Page and Activation Server and then complete the activation proc ess in "offline" mode. For more
information, see Activating Licenses in Offline Mode on page 40.

Licensing Topology Models

Use the models provided in this section to design and deploy an AVEVA Enterprise Licensing platform
that most closely matches your own enterprise's topologies and requirements.

15
AVEVA Enterprise Licensing Guide Deploying AVEVA Enterprise Licensing

Single Node Topology

In a single node "all in one" topology, the License Server, License Manager, product software, license(s)
and web browser are hosted on the same machine. The Activation Server is hosted by AVEVA in the
Cloud.

Note: The License Server never connects directly to the Activation Server. Only the License Manager
connects directly to the Activation Server. License activation is to a cloud-based server in all topologies.

Advantages
Simple configuration for a small, single node system. Can easily be scaled to add more nodes.
Limitations
None for a small, single node system.

Multiple Nodes - Self-Hosted License Topology - Basic

This topology and the Multiple Node - Self-Hosted License Topology - Local License Manager (see
"Multiple Nodes - Self-Hosted License Topology, Local License Managers " on page 17)s are simple and
work well in a small system of roughly five nodes, including InTouch tag-based architectures. As your
system expands its total number of nodes, license management may be more efficient using one of the
Multiple Nodes with Centralized Licensing topologies.
You can use the License Manager web browser interface to manage multiple nodes hosting separate
License Servers. Each node could have its own License Server, License Manager with web browser
interface, and could locally host its own license server.

16
Deploying AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

Advantages
A single License Manager can be used to connect to multiple License Servers.
Limitations
If the machine with the License Manager is damaged, License Manager would need to be instal led in
another mac hine.

Multiple Nodes - Self-Hosted License Topology, Local License

Managers
The AVEVA Enterprise Licensing platform can enable each node to host its own License S erver, License
Manager, and the license(s) for the product(s) running at each node, and is commonly used in InTouch
tag-based systems. This topology does not leverage the centralized management capabilities of the
AVEVA Enterprise Licensing, and does not take advantage of License Server Redundancy features.

Advantages
In this configuration, a single License Manager can point to an individual License Server. Nodes can be
segregated according to function or separate installed products.
Limitations
In addition to making limited us e of the AVEVA Enterprise Lic ensing capabi lities, this topology provides
no centralized hosting of licenses. If a machine is damaged, its license goes with it.

Multiple Nodes - Centralized Licenses Topology

A License Manager can be installed on a machine separate from a License Server, and can connect to
multiple License Servers. This type of topology provides more flexibility and convenience by allowing a
single Licens e Manager browser interface to manage multiple Lic ense Servers.

Note: License Server redundancy is always recomme nded for cent ralized license management.

17
AVEVA Enterprise Licensing Guide Deploying AVEVA Enterprise Licensing

Advantages
The License Manager and the License Server can be installed on different machines.
Licenses can be centrally hosted and managed in a single License Server.
Limitations
If the single License Manager machine fails, License Server access and management is int errupted until
a new License Manager is installed and configured, but no licenses, all hosted on individual License
Servers, are compromised.

Dual Role Multiple Nodes - InTouch Tag-Based Centralized Licenses

Topology
A topology featuring multiple nodes with centralized licenses can perform dual roles by hosting a Tag
Server on the License Server node.

Advantages
Combining a Licens e Manager, License Server, and Tag Server on the same node can provide greater
convenience and manageability to an InTouch tag -based system.
Limitations
Adding a redundant server to the topology is highly recommended. A machine failure of the server node
can result in bot h interruption of access to hosted licenses. License management would also be
interrupted pending re-installing Licens e Manager on a new machine.

18
Deploying AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

Redundancy Topologies
License Server redundancy is highly recommended when centralizing your licenses. In all redundancy
topologies, a paired set of License Servers keeps licenses, reservations and status of licenses
synchronized. A synchronized copy of all licenses is kept on the backup License Server, as well as a
synchronized list of acquired licens es and the nodes that acquired them.
If the primary License Server becomes unavailable, products can acquire their licenses from the backup
server.
The License Manager user interfac e allows enabling redundancy, and specifying the name of a backup
License Server node to create a pair. For information and procedures about implementing redundancy,
see Work ing With License Server Redundanc y on page 57.

Important: You must configure the primary and backup License Server node names at each node that
hosts the software products. This identifies the primary and backup servers in the redundant pair. For this
reason, it is recommended that you set up your License Server pair before installing your software
products.

Multiple Node InTouch Tag-Based Topology - Redundant License Servers

In an InTouc h tag server-based architecture, a tag server node is a natural fit to also host a License
Server.
If all licenses are identical, there is no need for reservations. If any license is different, reserve the license
to guarantee a specific machine ac quires the correct license.

19
AVEVA Enterprise Licensing Guide Deploying AVEVA Enterprise Licensing

We recommend installing and configuring a redundant License Server, as described here, to safeguard
your system and provide stable availability to your licenses.

Note: A best practice is to install a License Manager on the redundant License Server machin e. If the
primary machine fails, you can manage the licenses stored and synchronized on the redundant, backup,
server.

Multiple Node InTouch Tag-Based Topology - Redundant License Servers and

Tag Servers
In an InTouc h tag server-based architecture, a tag server node and its backup are a nat ural fit to also
host a License Server and its backup. In this topology model, two redundant InTouch tag servers have
License Servers installed and configured as a redundant pair. Nodes with software products installed
acquire their licenses from the primary License Server. In the event of a machine failure, licenses are
acquired from the backup server.

Advantages
Redundancy provides stable availability.

20
Deploying AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

Capit al expenditures can be mitigated by using two machines for dual purposes rather than purchasing
separate License Server machines.
Limitations
None.

Redundant RDS Servers

The Remote Desktop Services (RDS ) Windows component allows you to take control of a remote
computer or virtual machine over a network connection. (RDS was known as Term inal Services in
Windows Server 2008 and earlier.) A remote client machine that supports Remote Desktop Protocol
(RDP) can access the Windows software and the entire desktop of the computer running RDS. This is
sometimes known as a thin client.
In a redundant RDS servers model, you activate the primary client licenses in the primary RDS server
and activate the failover client licenses (FLB ) in the backup RDS server. A copy of these licenses is
always synchronized and exists on the backup Lic ense Server. When failover occurs and the clients
point to the backup License Server, the failover licenses will be available from the backup License
Server.
Supervisory Client FLB Licenses are required for the backup RDS Server.

Note: You can us e both ReadWrite and ReadOnly RDS licenses in the same Lic ense Server.

Advantages
RDS ReadOnly licenses can coexist with ReadWrite Licenses in the same License Server.
The redundancy in this model is provided by redundant RDS [Link] prevent overuse of licenses and
potential unavailability at failover, there is no separate redundanc y of License Servers.
Limitations
Licenses must be deactivated before cloning VMs, otherwise a Grace Period is triggered.

21
AVEVA Enterprise Licensing Guide Deploying AVEVA Enterprise Licensing

Redundant RDS Servers in a Virtualized Environment

Redundant RDS servers behave on virt ual machines the same way they behave on physical machines.
Refer to your VM soft ware vendor's documentation to set up your virtual environment.
The same guidelines, advantages, and limitations apply to both hardware and virtual machines. For
more information, see Redundant RDS Servers on page 21.

Redundant RDS Servers - Multiple Sessions from One Machine

In this topology model with three client machines, there would be nine primary licenses and nine failover
licenses (FLB).
In this redundant RDS servers model, as with other redundant RDS server models, you activate bot h the
primary client licenses and the failover client licenses (FLB) in the primary License Server. A copy of
these licenses is always synchronized and exists on the backup License Server. When failove r occurs
and the clients point to the backup License Server, the failover licenses will be available from the backup
License Server.
Supervisory Client FLB Licenses are required for the backup RDS Server.

Note: You can us e both ReadWrite and ReadOnly RDS licenses in the same Lic ense Server.

22
Deploying AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

Advantages
Multiple RDS sessions can be run on each client machine, with licenses served from the License Server
hosted on the primary RDS server, and managed by the License Manager hosted on the same RDS
server.
RDS ReadOnly licenses can coexist with ReadWrite Licenses in the same License Server.
The redundancy in this model is provided by redundant RDS [Link] prevent overuse of licenses and
potential unavailability at failover, there is no separate redundanc y of License Servers.
Limitations
Licenses must be deactivated before cloning VMs, otherwise a Grace Period is triggered.

Implementing Licensing Components

The AVEVA Enterprise Licensing framework is very light weight and requires only a few steps to
implement after you organize a topology to support your system requirements.
1. Start by:
Installing License Manager and License Server on page 23
2. Work with the default settings, or customize your basic setup by:
Configuring License Server for the Product on page 25
3. Then you can proceed to:
Accessing License Manager on page 31 and
Navigating License Manager on page 31

Installing License Manager and License Server

License Manager and License Server are part of the installation proc ess of your purchased products or
you can install it standalone. Both appear in the feature installation selection window during the
installation process. You can use the standalone installation to install only License Manager, License
Server, or both without installing the product itself. This capability allows you to model your system
topology according to your specific needs. See Organizing License Components into Topologies on
page 12 for more information.

23
AVEVA Enterprise Licensing Guide Deploying AVEVA Enterprise Licensing

Using the standalone installation example, you would see the following screen during installation:

You can select to install either License Server, License Manager, or bot h.
You can start License Manager when the installation completes. License Manager can be installed
independent of License Server. When the License Manager install completes you can access it one of
the following ways:
 You can open the Windows Start menu and search for Licens e Manager in the program search text
box, then click the resulting browser link for License Manager.
 You can access a Licens e Manager installed on a local or remote node by opening your browser and
going to the following URL:

[Link]
where <nodename> is the name of the node, local or remote, where License Manager is installed.
 If you have configured license server redundancy, you can manage the paired servers by accessing
the License Manager on the primary node with the following URL:

[Link]
where <primarynodename> is the name of the node where the primary license server is installed.
 If the primary node is unavailable, access the License Manager on the backup node by going to the
following URL:

[Link]
where <backupnodename> is the name of the node where the backup license server is installed.

24
Deploying AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

Note: You can uninstall License Manager in the same manner you would uninstall any Windows -based
application. If you have a license activated when you attempt to uninstall License Manager, you will see
an informational message to deactivate any activated licenses.

Configuring License Server for the Product

After completing the installation of your product, you need to define the location of the License Server
that will host the licenses for the product.
Using the Configurator
A configuration tool is available at the end of the product installation process by clicking a Configure
button.

Note: You can access the Configurator at any time post-installation to complete or modify your
configuration by going to the Windows Start menu and clicking Configurator.

By default, the installation process identifies the local computer as the License Server n ame, and
provides the default server port.

Important: Before running the Configurator, make sure that ports 55555 and 59200 are open. Port
55555 is the default port, the only port being configured, but both ports must be open.

 You can point to a different License Server on your network, if necessary.

 You can specify a different port, if necessary.

25
AVEVA Enterprise Licensing Guide Deploying AVEVA Enterprise Licensing

 You can t est your connection to the License Server by selecting Te st Connection. P ress Configure
to save all your changes.

For more information, see Installing License Manager and License Server on page 23.
For more information on configuring licens e server redundancy, see Enabling the License Server
Redundancy on page 58.

About License Manager Security

Security Requirements
The License Manager application can only be accessed by a user who is:
 An admin or a member of the SELicMgr security group on the local comput er on which the License
Manager is installed.
 An admin or a member of the SELicMgr group on the domain in which t he License Manager
computer resides.
The name of the logged-in user appears on the application window top bar.
Enabling Browser Logon
License Manager us es Windows authentication to securely validate logon permissions for users
accessing the application.
In order to enable the logon feat ure in your browser, refer to your browser documentation.

26
Deploying AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

Working with Nodes in Workgroup Network Configuration

A work group net work configuration can be implemented for sm aller net works where it is not necessary to
use an Active Directory domain controller to centralize net work identification, roles and authorization.
In a work group network configuration, the credentials used to log in to a License Manager client node
must be part of the SELicMgr or Administrator Security Identity groups configured on the License
Manager Service node. If the account credentials are not part of either group, the License Manager
Service will request new credentials that are part of the defined groups.
The basic process for how a local License Manager client node is either authenticated to access a
remot e License Manager Service node or requested for new credentials is described in the below
diagram.

See About License Manager Security on page 26 for additional security information and requirements.

Working with Back-end Applications in a Workgroup Environment

Back-end applications must access a local or remote License Server node to ac quire licenses. When a
work group topology is implemented and the License Server is installed on a remot e node, special
configuration arrangements are required.
The possible scenarios and applicable authentication processes are described below.
Scenario 1 (Recommended): License Manager, License Server and Installed Products on Single
Node
Use of a workgroup configuration may not be as secure as an Active Directory domain controller. For
security reasons, the recommended configuration is to have License Manager and License Server
installed on each node that will have installed products that need to be licensed. Each node must belong
to either the SELicMgr or Administrator Security Identity group.
Licenses should then be activat ed and administered only for the products installed on each node.

27
AVEVA Enterprise Licensing Guide Deploying AVEVA Enterprise Licensing

Scenario 2: Back-End or Clients Running on a Separate Node than the License Server
In this scenario, the License Server is installed on one node, and the products that need to acquire
licenses are installed on another node and are running as User accounts. User accounts present their
local identity to the remote node. The remote node will then examine the loc al user repository for the
exact same user name and password from the requesting account.
If a match is found, the account that the back-end or client application is running as is authenticated.
Otherwise it is not authenticated. This means that the account that the back -end or client application is
running as must be replicat ed on the License S erver node.

AE Workgroup Licensing Utility

AE Workgroup Licensing Utility configures licensing nodes that are in workgroup environment, so that
node-to-node communication can be established bet ween licensing components (License server and
License Manger). The AE Workgroup Licensing Utility allows you to add a license server to a remote
license manager in work group environment.
Using this utility, you have to create a new user account or use an existing user account. You must use
the same user account on each node that requires communication with licensing components of other
nodes in workgroup environment.
The AE Workgroup Licensing Utility is available under:
C:\Program Files (x86)\Common Files\ Arche strA\Licensing Framework\License Utilitie s
You can either run the AE Workgroup Licensing Utility in UI mode or in silent mode.
To run AE Workgroup Licensing Utility in UI mode
1. Right -click [Link] file, and select Run a s Admini strator.
The AE Workgroup Licensing Utility window appears.

2. Read the instructions and click Proceed.

3. In the Create/Select User to configure section, in the User field, enter a new user name or select
an existing user from the dropdown list.
4. In the Pa ssword field, enter the password for the user account entered/selected.

28
Deploying AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

Note: For a new user name,a Confirm Password field appears. Enter the same password.

5. Click Configure. A progress bar appears.

6. Once the workgroup is configured successfully, click Finish.
To run AE Workgroup Licensing Utility by silent mode
1. Run Command Prompt as Administrator.
2. To configure the Workgroup, use the following command:
"<[Link] file path>"/silent=true /username=<required user name
for the SE Licensing> /password=<the corresponding password of the user>
where, "/silent" indicates silent execution.
3. Press Enter.
A message saying, “Workgroup configured successfully” appears.
4. To get help information, use one of the following command:
"[Link] file path" /?
"[Link] file path" /h
"[Link] file path" /H
"[Link] file path" /Help
For example: "C:\Program Files\Common Files\ArchestrA\Licensing Framework\Licensing
Utilities\[Link]"/?

29
AVEVA Enterprise Licensing Guide Deploying AVEVA Enterprise Licensing

To verify whether the node is configured or not

 Under Computer Management, in the Users folder, check for the new user that you have created.
 Under Component Service, in Services(Local), check if the License Manager is logged on as the
user that you have creat ed/selected.
 Under C:\ProgramData\Schneider Electric\Licensing\License Manager, right-click Data folder
and select Properties. Under Security tab, in Group or user names section, check if the user
created by you is present.

You can use this tool to create the same user in all nodes. Once the nodes are configured, you will be
able to add the license server in licens e server manager.

30
 AVEVA Enterprise Licensing Guide

C HAPTER 3
Using AVEVA Enterprise Licensing
In This Chapter
Accessing License Manager .......................................................................................................... 31
Navigating License Manager ......................................................................................................... 31
Activating Licens es ....................................................................................................................... 37

Accessing License Manager

License Manager is a brows er-based application that manages your License Server(s).
You can access License Manager several ways:
 You can open the Windows Start menu and search for AVEVA Enterprise License Manager in the
program search text box, then click the resulting browser link for AVEVA Enterprise License
Manager.
 You can access a Licens e Manager installed on a local or remote node by opening your browser and
going to the following URL:

[Link]
where <nodename> is the name of the node, local or remote, where License Manager is installed.
 If you have configured License Server redundancy with a License Manager, you can manage the
paired servers by accessing the License Manager on the primary node with the following URL:

[Link]
where <primarynodename> is the name of the node where the primary license server is installed.
 If the primary node is unavailable, access the License Manager on the backup node by going to the
following URL:

[Link]
where <backupnodename> is the name of the node where the backup license server is installed.

Important: If you configure your license server with a port number other than the default port 80, you
need to include the port number in the browser URL to access License Manager. Use this URL:
[Link]

For more information on changing default port numbers, see Changing License Manager Ports on page
78.

Navigating License Manager

License Manager has two primary work areas: the License Server Summary Page, and the Details
Page. All License Manager functionality is available from one of thes e two pages.
Using License Manager, you can add or remove License Servers and you can start or stop the
connected server. You can also pair two License Servers to enable server redundancy.

31
AVEVA Enterprise Licensing Guide Using AVEVA Enterprise Licensing

 Adding a License Server makes the License Manager the manager for that server.
 Removing a License Server disassociates it from the local License Manager, but does not uninstall
the server from the computer where it is installed.
 Starting a License S erver enables the services associated with managing the licenses hosted on that
server.
 Stopping a License Server disables the services associated with managing the licenses hosted on
that server.
 Pairing two License Servers in the same License Manager enables License Server redundancy. For
information see Work ing With License Server Redundanc y on page 57.
 License information is updat ed bet ween the Lic ense Server and the Activation Server. For more
information, see Syncing Licenses on page 55.
It is recommended to manage multiple License Servers with a single License Manager. See Organizing
License Components into Topologies on page 12 for detailed information on the recommended
topologies applicable to various environments.

Using the License Server Summary Page

Using the License Server Summary Page
The License Server Summary page provides information about the License S ervers being managed by a
given Licens e Manager.

32
Using AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

Area Description

1 Click the Menu icon to open the Main Menu. The menus slides in from the left side,
both on the Summary and Details Pages.

2 Click the tile of a server to open that server on the Details Page.
Each tile shows:
 The display name of the server
 The display names of both servers if you configured a redundant pair
 Whether the server is running or stopped
 The availability status of the redundant pair, if configured
 If configured, which server in the pair is unavailable
 How many activated licenses the server currently hosts
3 A stopped License Server's tile will a ppear with a red bar to the left of the tile.
The icon in the upper right corner of the tile indicates the License Server is in
connected state. This icon disappears if a License Server is paired.
See Starting and Stopping a Licens e Server on page 51 for more information.
4 Click the Add Server icon to add a server to this License Manager.
See Adding and Removing a Licens e Server on page 49 for more information.
5 The Offline Activation button shows activation mode and status.
6 The Cloud icon indicates whether License Manager has a connection with the
Activation Server. The red "x" in this example indicates no connection. This is not a
live status, but an indication of the configured Activation Settings.

33
AVEVA Enterprise Licensing Guide Using AVEVA Enterprise Licensing

Using the Details Page

Using the Details Page
The Details Page shows det ailed information about the selected License Server (or both servers if a
redundant pair is configured), its status and the specific licenses activated and in us e hosted by the
selected License Server. The Details Page provides the tools you need to monit or license usage, to
control the selected License Server, to set up license server redundancy, and to activate and deactivate
licenses.

34
Using AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

Area Description

1 Click the Menu icon to open the Main Menu. The menu slides in from the left side,
both on the Summary and Details Pages.

2 Action Bar: Cont ains available tools specific to the active License Manager page.
3 License Server display name and description (if any). If you configure a redundant
pair, bot h server names are displayed here.
4 Logged-on user name and icon. Click icon to access License Manager help.

5 Back Arrow: Returns to the License Server Summary page.

6 Add License, Deactivate, and Details buttons:

 Add License displays the License Activation pane.
 Deactivate is enabled when one or more active licenses in the grid are selected.
 Details is enabled when one active license in the grid is selected.
7 Information grid tabs display the respective information grids.
 License Summary page
 Feature Summary
 Usage Details
 Reservation

35
AVEVA Enterprise Licensing Guide Using AVEVA Enterprise Licensing

8 License Server Detail information, including:

 The unique ID associated to the Lic ense Server. For a redundant pair, the
unique IDs of both servers are displayed here.
 The Status of the License Server. For a redundant pair, there is an additional
Pair Status column. For details on status information, see Monitoring P air Status
Information on page 60.
9 The License Summary grid, displays information about each activated license.
 Component Name
 Part Number
 Serial Number
 Expiry Date
 Status
 Comment: An optional comment can be added for each license.
You can control the grid display by using the Row s Per Page and Page Number
controls in the grid footer row.
10 Grid filter: Enter search text to filter active licenses on any grid display.

Viewing Details for a Specific License

To view details for a specific license
1. On the License Det ails page, select a license in the License Summary grid.
2. Click the Details button just above the License Summary grid. The License Det ails pane appears.

The License Det ails pane displays information about the selected license, including a License
Activities log containing license creation, activation, and activation ID. The fields in the License
Details pane are not editable.

Note: Click Next or Previous to view details for other activated licenses. Alternatively, you can click on
any activated license in the License Summary grid to view license details.

3. Click Close to hide the License Det ails pane.

36
Using AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

Using the Grid Filter

Use the grid filter to foc us the displayed licenses according to your specific search terms.

The grid filter is available on all grid displays:

 Details page
 Reservation tab
 Feature Summary tab
 Usage Details tab
 Reservations page
You can filter on a term in any grid column, across all grid pages.
Examples:
 Enter a user name on a Reservation grid to display all licenses reserved for the named user.
 Enter a device name on a Reservation grid to display all licenses res erved for the named device.
 Enter a date to display all licenses that expire on that date.
 Enter a product name to display all licenses associated with the named product.

Activating Licenses
About Activation and Activation Modes
After you import your license entitlement file (on page 91), select the activation mode that best suits your
topology. There are t wo modes available to process the licens e activation: online mode and offline mode.
The activation mode you can use in a particular system depends on the connectivity of the License
Manager components to the License Server and Activation Server.
 Use online activation when the License Manager node has network connectivity to the License
Server A ND Internet connectivity to the Activation Server.

37
AVEVA Enterprise Licensing Guide Using AVEVA Enterprise Licensing

 Use offline activation when the License Manager node has network connectivity to the License
Server but does NOT have Internet connectivity to the Activation S erver. In this case, a second node
with Internet access to the Activation Server is required to complete the activation process using the
License Activation Web Page.

Note: Optionally, you can use another installed Lic ense Manager in place of the License Activation
Web Page. See Activating Licenses in Offline Mode Using Two License Managers on page 43 for
details.

The following diagram illustrates a topology in which you would use offline mode. In this topology, the
License Manager is installed on Node 1, which has network connectivity to the License S erver. Node
2 has Int ernet connectivity to the Activation Server and the License Activation Web Page. In this
diagram, you can see the four basic steps for offline activation.

For both online and offline modes, use the License Manager or a second node with the licensing
components installed to import an entitlement file and activate the licenses it contains.
During activation, the licens es in the entitlement file will be associated with the License Server and will
become available to products that can access the License Server.

Setting the Activation Mode

The activation mode you select depends on the network topology where the license components are
deployed. For more information, see About Activation and Activation Modes on page 37.
Online activation is selected by default. Icons in the Action bar reflect the activation mode currently in
use.
You can't change the activation mode if offline activation has been previously selected and activation or
deactivation is pending. Once the offline activation or deactivation is complete you can then change the
mode.

38
Using AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

To set the activation mode

1. Open License Manager and click the Menu icon.

The Menu appears from the left side. Click Activation Settings. The Activation Settings dialog
appears.

2. Select either Online Activation or Offline Activation.

3. For online activation, select Proce ss Acti vation/Deactivation requests from other License
Managers only if the node where the License Manager components are installed has Internet
access to the Activation Server and you want to use it to proc ess activation requests for OTHER
License Managers with no Internet access to the Activation Server.
If you selected Offline Activation or Proce ss Activation/Deactivation requests from other License
Managers, the Offline Activation button appears in the Action bar. This button might appear yellow,
indicating that offline activation or deactivation actions are pending.

Activating Licenses in Online Mode

For online activation to work, make sure that:
 You have access to the entitlement file provided.
 The License Manager components node has connectivity to both the License Server and to the
Activation Server over the Internet.
To activate licenses in online mode
1. If you have more than one License Server connected to your License Manager, click the tile of the
server that will host the license(s) you want to activate.
2. Click the Add License button in the grid area.

39
AVEVA Enterprise Licensing Guide Using AVEVA Enterprise Licensing

The License Activation panel appears.

3. In the License Activation panel, click the Browse license file button to browse to your entitlement
file to import it.
If you have already imported entitlements, use the checkbox to select the entitlement that contains
the licenses you want to activate.

Note: Under Activated column, if it displayed as Yes, hold down CTRL and click the respective
check box to select the license. All entitlements are shown by default. You can narrow the view of
entitlements by selecting the entitlement that contains the license you want to activate.

4. Under the selected entitlement, select the license(s) to activate.

5. Click the Activate button.
The License Activation panel will close, and the selected licens es will show "Activated" status in
the License Summary Grid.

The activated licenses can now be consumed by your installed products as needed.

Activating Licenses in Offline Mode

Offline Activation provides the means to activate licenses when the Internet connection to the Activation
Server is restricted to certain areas in your environment.

40
Using AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

Before you begin, click the Activation Settings menu option and select Offline Activation:

Note: Optionally, you can use a second License Manager with Internet connectivity to the Activation
Server in place of the License Activation Web Page. See Activating Licenses in Offline Mode Using Two
License Managers on page 43 for details.

To activate a license in offline mode

1. Select the licenses to activate.
a. Open License Manager.
b. If you have more than one License Server connected to your License Manager, click the tile of
the server that will host the license(s) you want to activate.
c. Click the Add License button in the grid area.

The License Activation panel appears.

d. In the License Activation panel, click the Browse license file button to browse to your
entitlement file to import it.
If you have already imported entitlements, use the checkbox to select the licenses to activate.

41
AVEVA Enterprise Licensing Guide Using AVEVA Enterprise Licensing

Note: Under Activated column, if it displayed as Ye s, press ctrl + click on the res pective check
box to select the license.

e. Under the selected entitlement, use the checkbox to select the licenses to activate.
f. Click the Activate button.
The License Activation panel will close, returning you to the Details page. The selected
licenses will show Pending Activation Reque st status in the license grid, and the Offline
Acti vation button in the Action Bar turns yellow.
Pending Activation Requests can be canceled until offline activation is requested. See Canceling
a Pending Offline Activation/Deactivation on page 47 for details.
2. Request offline activation.
a. From the Server Details Page, click the yellow Offline Activation button. The Offline
Acti vation dialog box opens.
b. Click the Reque st Activation / Deactivation button. The activation request will create a file with
a ".sync" file extension to send the activation request.
The file name can be changed, but not the file extension.

c. Save the file to a convenient location where you can easily retrieve it from another computer on
your net work.
The selected licenses will now show Pending Activation in the Status column on the license
grid.

Note: You can set up your browser to automatically save the file to a specific location. Refer to
your browser settings documentation.

3. Process offline activation using the License Activation Web Page on the node with Internet
connectivity.

Note: A second License Manager installed on a node with Internet connectivity can substitute for the
Activation Web Page in this step. See Activating Licenses in Offline Mode Using Two License
Managers on page 43 for details.

a. On the node with Internet connectivity, point your web browser to the Global Customer Support
(see Global Customer Support - [Link] [Link]/) website.
b. Select the License Activation tile from the Knowledge & Support Center options:

The License Activation Web Page appears.

42
Using AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

c. Browse to the .sync file created in step 2. b. and upload it in the File to upload field.
d. Enter the text code and press Upload File.
The process request will create a file with a ".sync" file extension. The file name can be changed,
but not the file extension.
e. Save the file to a loc ation where you can easily retrieve it from another computer on your
network.
4. Receive offline activation on the Lic ense Manager node.
a. From the Server Details Page, click the yellow Offline Activation button. The Offline
Acti vation dialog box opens.

b. Click the Receive Activation / Deactivation button. You will be prompted to locate the file.
Navigate to the location where you saved the file. Select the file and click Open.
The selected license is shown as Activated in the License Summary grid. The activat ed
licenses can now be consumed as needed by your installed products.

Activating Licenses in Offline Mode Using Two License Managers

The procedure for activating licenses in offline mode using two License Managers is similar to activating
licenses in offline mode using the License Activation Web Page. For this activation method, you need
two License Managers:
 A License Manager with network connectivity to the License Server but no Internet connectivity to
the Activation Server (License Manager #1 in the following procedure)
 A License Manager with Internet connectivity to the Activation Server (License Manager #2 in the
following procedure)
Before you begin, configure the following settings for your two License Managers using the Activation
Settings menu option:

43
AVEVA Enterprise Licensing Guide Using AVEVA Enterprise Licensing

 In the offline License Manager, select the Offline Acti vation option.

 In the online License Manager, leave the Online Activation option selected and also check the
Process Activation/Deactivation requests from other License Managers option. The Offline
Acti vation button appears in the Action Bar.
To activate a license in offline mode
1. In License Manager #1, generate and save your activation request file.
See Activating Licenses in Offline Mode on page 40 for the detailed proc edure.
2. Process offline activation using License Manager #2.
a. Click the yellow Offline Activation button and select Proce ss Activation/ Deactivation.
You will be prompted to locate the file generated in Step 1.
b. Select the file and click Open.
Save the activation response file.
3. Receive offline activation in License Manager #2.
a. Click the yellow Offline Activation button and select Receive Activation/Deactivation.
You will be prompted to locate the file generated in Step 2.
b. Select the file and click Open.
Your license will now be shown as Activated in the license grid.

Deactivating Licenses in Online Mode

If you want to remove an activated license from a License Server you need to deactivat e it first. Online
deactivation applies to the same topologies as Activating Licenses in Online Mode on page 39.
To deactivate a license in online mode
1. Select the license(s) you want to deactivat e in the license grid.

44
Using AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

Select a single row, or use the check boxes to select multiple rows. The Deactivate button becomes
enabled.

2. Click the Deactivate button.

The selected licenses are removed from the grid and are no longer available for the products to use.
You can activate these licenses on the same server or a different server at a later time.

Deactivating Licenses in Offline Mode

Offline deactivation follows the same basic workflow and applies to the same topologies as Activating
Licenses in Offline Mode on page 40.
The work flow described here is based on t wo nodes: one with License Manager installed and net work
connectivity to the License Server, and one wit h Internet connectivity.

Note: The procedure for deactivating licenses in offline mode using two License Managers is similar to
the procedure described below. License Manager #2 would substitute for the License Activation Web
Page.

To deactivate a license in offline mode

1. Select the license(s) you want to deactivat e in the license grid.
The Deactivate button becomes enabled. Click the Deactivate button.

The selected license status changes to Pending Deactivation Request. The Offline Activation
button turns yellow to indicate pending requests.
You can cancel pending activation or pending activation request at this point by clicking the Cancel
Pending Actions button. For how-to information, see Canceling a Pending Offline
Activation/Deactivation on page 47.

45
AVEVA Enterprise Licensing Guide Using AVEVA Enterprise Licensing

2. Request offline deactivation from the License Manager node.

a. From License Manager, click the yellow Offline Activation button. The Offline Activation
dialog box opens.
b. Click the Request Activation / Deactivation button. The deactivation request will create a file
with a ".sync" file extension to send the deactivation request.

c. Save the file to a convenient location where you can easily retrieve it from the node with Internet
connectivity.
The selected licenses will now show Pending Deactivation in the license grid.
3. Process offline deactivation using the License Activation Web Page.
a. Point your web browser to the Global Customer Support (see Global Customer Support -
[Link] [Link]/).
b. Select the License Activation tile from the Knowledge & Support Center options:

The License Activation Web Page appears.

c. Browse to your saved .sync file created in step 2.b. and upload it in the File to upload field.
d. Enter the text code and press Upload File.
The process request will create a file with a ".sync" file extension. The file name can be changed,
but not the file extension.
e. Save the file to a loc ation where you can easily retrieve it from another computer on your
network.
4. Receive offline deactivation on the License Manager node.
a. From the Lic ense Manager node, click the yellow Offline Activation button. The Offline
Acti vation dialog box opens.

46
Using AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

b. Click the Receive Activation / Deactivation button. Navigate to the location where you saved
the file. Select the file and click Open.
The selected licenses are removed from the grid and are no longer available for the products to
use. You can activat e these licenses on the same server or a different server at a later time.

Canceling a Pending Offline Activation/Deactivation

If you are using offline activation mode, you can cancel a pending activation or deactivation.
To cancel a request
1. If you have a pending activation/deactivation, marked in the license grid with "Pending
Activation/Deactivation" in the status column, click to select the pending requests in the grid area.

2. Click the Cancel Pending Actions button that appears above the license grid, and then confirm
your action.
All licenses showing the status "Pending Activation/Deactivation request" or "Pending
Activation/Deactivation" will be canceled if you click the Cancel Pending Actions button.

47
 AVEVA Enterprise Licensing Guide

C HAPTER 4
Administering AVEVA Enterprise Licensing
In This Chapter
Administering a License Server ..................................................................................................... 49
Reserving Licenses ..................................................................................................................... 69
Monitoring License Usage ............................................................................................................. 73
About Changing Default Port Settings ............................................................................................ 76

Administering a License Server

There are a number of administrative operations available to enhance management of your license
server.

Adding and Removing a License Server

Add or remove a License Server from the Server Summary Page.
To add a License Server
1. Click the Menu button and select Servers from the menu. The License Server Summary page
appears.

2. On the Action Bar, click Add Server. The Add Server panel appears.

3. Enter the License Server information.

49
AVEVA Enterprise Licensing Guide Administering AVEVA Enterprise Licensing

a. Enter the name of the computer on which the License Server is installed.
b. Enter the name of the License Server as you want it displayed. By default, the c omputer name
and the display name are the same.
c. Enter an optional description for the Licens e Server, then click Apply. License Manager returns
to the Details page and displays the details of the License Server you have just added.
You can start working with the new License Server. You can go back to the License Servers Summary
page at any time by clicking the Back Arrow on the Details page.
For more information about using License Manager's features, see Navigating License Manager on page
31.

To remove a License Server

1. On the License Manager Summary Page, click the tile of the License Server you want to manage.
The Details page will open, and will dis play detailed information about that server.
2. Click the Remove button on the Action Bar above the License S erver name. After you confirm
removal, the License Server Summary Page will display.
3. Select the License Server you want to view on the Details page.

50
Administering AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

Starting and Stopping a License Server

You can start and stop a License Server from the Action Bar on the Server Details page. Stopping a
License Server will effectively suspend active licenses, including those in us e by products you might be
running.

Warning: Stopping a License Server could disrupt product operation. You should only stop a License
Server for maintenance or troubleshooting purposes.

To stop a License Server

1. On the Server Details page, click the Manage button on the Action Bar.
The Manage License Server slide out panel will appear. Click the Stop button below the
Maintenance bar.

The server Status will change to "Stopped" in the Server Details information.

51
AVEVA Enterprise Licensing Guide Administering AVEVA Enterprise Licensing

Click the left arrow to go to the License Servers page. The stopped server tile will have a red bar and
show a "Stopped" status.

To start a License Server

1. On the Server Summary Page, select the stopped server tile. Click the Manage button in the Action
Bar.
The Stop button appears as Start.
2. Click Start.
The server Status will return to "Running" in the Server Details information.
3. Click the left arrow to go to the Server Summary Page. The server tile display Running status.

Renaming a License Server

You can rename a license server, typically as part of managing computers on your net work. There are
several important points to keep in mind when renaming a license server:
 By default, the license server name dis played in the License Manager is the same as the computer
name.
 You can change the license server display name inside License Manager without changing the
computer (machine) name or the License Server ID.
 The License Server ID is a unique identifier used by other components of the licensing plat form,
including License Manager and the aut hentication server. A portion of the Lic ense Server ID is the
host computer name. The License Server ID consists of the comput er name plus a unique GUID
(Globally Unique Identifier).

Important: As a highly rec ommended best practice, deactivate all licenses on the server before you
rename the server. Reactivate the licenses after renaming the server.

If you do rename a License Server without first deactivating all licenses on the server, use the
procedures outlined in the following scenarios to complet e renaming your license server and reactivate
your licenses.

License Server Co-located with License Manager

If the License Manager and the License Server exist on the same computer, and you have renam ed the
computer, you will see a message when starting Licens e Manager that the computer has been renamed,
and that you need to take additional steps to restore access to your licenses.

52
Administering AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

To reactivate licenses after renaming a server co-located with the License Manager
1. Deactivate all licenses on the server.
The server ID automatically resets after you have deactivated all licenses on that server.
2. Reactivate all licenses on the renamed server.
For information about how to deactivate and activate licenses, see Activating Lic enses on page 37.

License Server Remote from License Manager

If you rename a License Server installed on a comput er separat e from the computer on which License
Manager is installed, that server will appear disconnected in License Manager.
To reactivate licenses after renaming a server remote from License Manager
1. Add a server to License Manager. See Adding and Removing a License Server on page 49 for steps
to do this.
2. Use the new computer name as the name of the server.
License Manager will detect the computer a nd server, and will be able to access the server. A
message will appear that the server has been renamed, and that you need to deactivate and
reactivate your licenses on that server.
3. Deactivate all licenses on the server.
The server ID will reset after you have deactivated all licenses on that server.
4. Reactivate all licenses on the renamed server.
For information about how to deactivate and activate licenses, see Activating Lic enses on page 37.

Renaming Redundant Servers

Renaming servers that are part of redundant pairs follows the same basic rules and procedures as
non-redundant servers. As a best practice, you should deactivate licenses before renaming servers. If
you rename a server in a redundant pair without first deactivating licenses, use the steps provided in the
following topics to recover and reactivate your licenses.

Primary Server Co-located with License Manager

If the License Manager and the primary License Server o f a redundant pair exist on the same computer,
and you have renamed the comput er, you will see a message when starting License Manager that the
computer has been renamed, and that you need to take additional steps to restore access to your
licenses. In this scenario, it is assumed that the backup computer is remote from the primary.
To reactivate licenses after renaming a redundant primary server co-located with the
License Manager
1. Deactivate all licenses on the server pair.
The server ID automatically resets after you have deactivated all licenses on that server.
2. Unpair the redundant pair. For information about pairing and unpairing redundant servers, see
Work ing With License Server Redundanc y on page 57.
3. Reset the server ID of the backup comput er. For more information, see Resetting the License Server
ID on page 55.
4. Re-pair the redundant pair with the new License Server ID.

53
AVEVA Enterprise Licensing Guide Administering AVEVA Enterprise Licensing

5. Reactivate all licenses on the renamed server.

For information about how to deactivate and activate licenses, see Activating Lic enses on page 37.

Primary Server Remote from License Manager

If you rename the primary License Server in a redundant pair installed on a computer separate from the
computer on which License Manager is installed, that server will appear disconnected in License
Manager.
To reactivate licenses after renaming the primary server in a redundant pair remote
from License Manager
1. Add a server to License Manager. See Adding and Removing a License Server on page 49 for steps
to do this.
2. Deactivate all licenses on the server pair.
The server ID automatically resets after you have deactivated all licenses on that server.
3. Unpair the redundant pair. For information about pairing and unpairing redundant servers, see
Work ing With License Server Redundanc y on page 57.
4. Reset the server ID of the backup comput er. For more information, see Resetting the License Server
ID on page 55.
5. Re-pair the redundant pair with the new License Server ID.
6. Reactivate all licenses on the renamed server.
For information about how to deactivate and activate licenses, see Activating Lic enses on page 37.

Renaming Only the Backup Server

If you rename the backup server in a redundant pair without first deactivating all licenses on the pair, the
backup server will appear in License Manager to have been shut down. This scenario assumes that the
License Manager is not installed on the backup node, an atypical configuration.
To restore licenses on a backup server
1. In License Manager, add the backup server using the new server name.
See Adding and Removing a Licens e Server on page 49 for steps to do this. License Manager will
detect the new server name.
2. Deactivate licenses on the redundant pair. For information about how to deactivate and activate
licenses, see Activating Licenses on page 37.
3. Unpair the redundant pair.
For information about pairing and unpairing redundant servers, see Work ing With License Server
Redundancy on page 57. The backup server will automatically reset the server ID. It will not
preserver the original server ID.
4. Re-pair the computers as primary and backup servers.
5. Reactivate the licens es.

54
Administering AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

License Manager Installed on Both Primary and Backup Servers

Typically, a License Manager is not installed on both the primary and backup nodes of redundant
License Servers, and this configuration is not recommended. However, this scenario can occur if a
computer is configured with both License Manager and License Server, then cloned to create a computer
to be used as a backup. This scenario also can occur when setting up redundant License Managers
along with the redundant License Servers.
If y ou rename a backup License Server in a redundant pair co-located with a License Manager, you need
to start the License Manager on the backup server node so it will sync with the primary computer.

Resetting the License Server ID

You can reset your License Server ID. Doing so allows you to create a new ID that will be used for fut ure
activation with the Activation Server.
For example, if a Lic ense Server has ever had activat ed licenses on it, it cannot be used as the backup
server for a redundant pair. Resetting the ID will enable it to then be used as the backup. See About
License Server Redundanc y on page 57 for details.
The License Server ID can be reset if the following conditions apply:
 No licenses are activat ed on the server
 The server is not in the grace period
 The server is not paired wit h another server
To reset the License Server ID:
1. Click the Manage button in the Action Bar.
The Manage Server slide out panel appears.
2. Click Maintenance and then click Reset.

You will be prompted to confirm the License Server Reset. Upon click of Yes, the License Server ID
will reset.

Syncing Licenses
The sync action regenerates the activated licenses in the License Server with the activated licenses in
the Activation Server. For example, you may need to perform a sync action in the following scenarios:

55
AVEVA Enterprise Licensing Guide Administering AVEVA Enterprise Licensing

 You have set up a redundant pair with a primary server that had activated licenses prior to pairing
and is managed by an offline License Manager.
See About License Server Redundanc y on page 57 for detailed information.
 You are restoring an older image of a License Server that has fewer licenses.
See Rec overing from Hardware Failure by Re-Imaging Hardware on page 64 for detailed
information.
To sync licenses:
1. Click your server tile on the Server Summary page.
2. Click the Sync button in the Action Bar.
When the synchronization operation has completed, a notification will pop up stating t hat the License
Server is synchroniz ed with Activation Server successfully.

Syncing Licenses in Offline Mode

You can sync licenses in offline mode. In this mode there are two nodes involved to complete the
process:
 A node wit h License Manager components installed and network access to a License Server but no
Internet access to the Activation Server. The Offline Activation mode must be selected in the
Acti vation Settings menu. See Setting the Activation Mode on page 38 for det ails.
 A node with Internet access to the Activation S erver and License Activation Web Page.
To sync licenses in offline mode:
1. Request offline synchronization.
a. Click your server tile on the Server Summary page.
b. Click the Sync button in the Action Bar.
The synchronization request will creat e a file with a ".sync" file extension to send the request.
c. Save the file to a loc ation where you can easily retrieve it from another node on your net work.
2. Process offline synchronization using the License Activation Web Page on the node wit h Int ernet
connectivity.
a. Point your web browser to the Global Customer Support (see Global Customer Support -
[Link] [Link]/) website.
b. Select the License Activation tile from the Knowledge & Support Center options:

The License Activation Web Page appears.

c. Browse to the .sync file created in step 1. b. and upload it in the File to upload field.
d. Enter the text code and press Upload file.
The process request will creat e a file with a ".sync" file extension.
e. Save the file to a loc ation where you can easily retrieve it from another node on your net work.
3. Receive offline synchronization on the License Manager node.

56
Administering AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

a. From the Server Details page, click the yellow Offline Activation button. The Offline
Acti vation dialog box opens.

b. Click Receive ACtivation/Deactivation. You will be prompted to locat e the file. Locate the file
and click Open.
When the synchronization operation has completed, a notification will pop up stating that the
License Server is synchronized with the Activation Server successfully.

Working With License Server Redundancy

About License Server Redundancy
License server redundancy enables you to configure a pair of license servers to work in a synchronized
manner to provide high availability of activated licenses.
When you configure a redundant pair, all actions associated with licenses, such as activation,
acquisition, and reservations are kept in sync between both servers. If a license server fails, based on
known conditions, the second server continues to operate with minimal impact on the operation of the
licensed products. See Monitoring Pair Status Information on page 60 for conditions that will cause a
license server to fail.
The servers in the pair are commonly referred to as the primary server and the backup server. All dat a on
the primary server is synced to the backup server. If the primary server fails, all its data is available on the
backup server.
Requirements for Primary and Backup Servers
Cert ain License Server conditions must be met before license activation can succeed on a redundant
pair. The primary server can have activated licenses at the time of pairing. However, the server you use
as the backup cannot have activated licenses or any pre vious license activations. If licenses are
currently or have previously been activated on the backup server prior to pairing, the License S erver ID
must be reset for the backup server before licenses can be successfully activated on the pair. See
Resetting the License Server ID on page 55 for detailed instructions.
You can configure a redundant pair wit h a primary server with or without licenses on it. When the primary
server is hosting activated licenses and is managed by an offline License Manager, you must click the
Sync button after pairing the servers. This will synchronize the existing licenses with the backup server
and complete the pairing.

Note: The Pair Status in the Server Details Page will display as Pair not synced until you perform the
sync action.

Basic Topology for License Server Redundancy

Setting up a redundant pair requires two nodes where the License Server and License Manager
components are installed. For more information about installing licensing components, see Installing
License Manager and License Server on page 23for more information.

57
AVEVA Enterprise Licensing Guide Administering AVEVA Enterprise Licensing

A basic configuration of redundant license servers is shown in the following diagram. For detailed
topology models, see Redundanc y Topologies on page 19.

For details about configuring licens e server redundancy, see Enabling the License Server Redundancy
on page 58.
For information about renaming redundant license servers, see Renaming a License Server on page 52.

Note: Any license server can only be part of one redundant pair.

Enabling the License Server Redundancy

To enable a license server redundancy
1. Launch License Manager by pointing your web brows er URL to the primary node (Node 1 in the
diagram above).
The primary license server will be automatically added to the primary Licens e Manager upon launch.
2. Add the backup license server to the primary License Manager.
See Adding and Removing a Licens e Server on page 49 for more information.
3. Select the tile of the primary license server to access the Server Details Page.

Note: The selected server will be the primary server.

a. Select the Manage button from the Action Bar.

The Manage License Server slide out panel appears.

58
Administering AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

b. Select Enable Backup.

c. Select your second server from the list box and click Apply.

Note: The redundant server should not have activated any license before. If it has activated any
license, you need to deactivate all the licenses and reset the server ID under Manage option.
The Activation Server should not have the backup server ID.

The Server Details Page will now display your primary and backup servers and their pair status
information.

In the Server Summary Page, the redundant pair appears as a single tile displaying the names of
both servers in the pair.

Note: Once you have activated licenses on the pair, you cannot undo the pairing until all licenses
have been deactivated. Onc e paired, point your browser to the License Manager on the backup
license server node. The redundant pair will aut omatically be added to the backup License Manager
upon launch.

4. Enable licensing redundancy for your licensed product by running the Configurator t ool on the node
where the product is installed.
a. Open the Configurator from Start, All Programs.
b. Designate the primary server name and select Enable Backup.

59
AVEVA Enterprise Licensing Guide Administering AVEVA Enterprise Licensing

Note: The backup server associated with the primary server is automatically populated based on the
configuration in License Manager. This configuration applies to all products installed on the node.

c. Click Test Connection.

d. Click Configure.

Monitoring Pair Status Information

The pair status information displayed in the Server Details Page provides you with identifying information
and the connection statuses of both servers in the pair. If both servers are running and can be accessed
over the net work they are hosted on, the pair status information displays as follows in the Server Details
Page:

60
Administering AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

There are a number of conditions that will trigger a change in the Pair Status. The conditions and
corresponding status changes are listed below. In these examples, the condition occurs on the backup
server.
 The backup server node shuts down
o Backup server status changes to: Di sconnected
o Pair status changes to: Backup not available
 The backup server loses network connection or is stopped
o Backup server status changes to: Stopped
o Pair status changes to: Backup not available
 The backup server is uninstalled
o Backup server status changes to: Backup not available
o Pair status changes to: Backup not available
 The pair is not synced
o Both server statuses remain as Running
o Pair status changes to: Pair not synced
See About License Server Redundanc y on page 57 for details on this scenario.
For example, if the backup server was stopped, the statuses would appear as follows:

The pair status information is also reflected on the server tile in the Server Summary Page. If both
servers in the pair are connected and running, the tile displays Paired and Available. If the pair is not
available, the server tile will reflect whichever server is unavailable.
The following images show how the pair status is displayed in the s erver tile.

61
AVEVA Enterprise Licensing Guide Administering AVEVA Enterprise Licensing

Pair A vailable Server Tile Pair Not A vailable Server Tile

Repairing the Primary Server

In the License Server redundant pair, if the primary license server is not accessible or is offline, you can
repair the primary license server with a new license server.
To Repair the Primary License Server:
1. Install the License server in a new machine which has the same machine name as the primary server
which is not accessible.
2. In the License Manager window, click Refresh to refresh the window.
The two servers are unpaired. The disconnected primary machine will be marked as "ERROR" in the
paired servers tile. You need to manually add the primary server again using Add Server option. For
more information on how to add a license server refer to Adding and Removing a License Server on
page 49 section.
3. Select the paired servers tile. In the License Server Summary page, click the backup license server
tile and click Manage.

62
Administering AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

The Manage License Server slide out panel appears.

4. Click Redundancy Repair.

5. In the Server field, select the primary license server name and clic k Repair.
A confirmation belly bar appears asking for the confirmation to repair the primary server.
6. Click Yes, if you want to continue.
Both the license servers are paired and appear in a single tile.

Disabling the License Server Redundancy

Prerequisites to disable the license server redundancy are:
 At least one of the paired servers should be available.
 The available server should not have any activated licens es.
To disable license server redundancy from a server
1. Select the tile of the primary license server to access the Server Details Page.
2. Select the Manage button from the Action Bar.
3. The Manage License Server slide out panel appears.
4. Uncheck Enable Backup check box and click Apply.

Note: If one of the server is no longer available and there are any activated licenses in that server, a
message prompting to contact technical support for further assistance appears. Deactivate the
license with technical support assistance, perform sync operation (see Syncing Licens es on page
55) to remove licenses from License Manager and then disable the redundancy as mentioned in the
above steps.

5. Disable licensing redundancy for your licensed product by running the Configurator tool on the
node where the product is installed.
a. Open the Configurator from Start, All Programs.
b. Clear the Enable Backup check box.

63
AVEVA Enterprise Licensing Guide Administering AVEVA Enterprise Licensing

c. Click Configure.

Recovering from Hardware Failure by Re-Imaging Hardware

If you encounter hardware failure on the node hosting your License Server and choose to re -image your
machine, the License Server will enter a grace period. The grace period allows you to continue
performing normal licensing functions on the re -imaged License Server without interruption. You have
the duration of the grace period mode to rectify the grace period mode before the License Server stops
allowing licenses to be acquired.
If you had activated licens es on your License S erver at the time of the hardware failure, you can continue
using them after you end the grace period if you follow the steps below.

Note: If the image you restored was not concurrent with the License Server at the time of hardware
failure, you may have to perform a sync action so that the Licens e Server reflects the most current
licenses. See Syncing Licenses on page 55 for more information about syncing licenses.

To end the grace period and keep licenses on a re-imaged license server
1. Click the Manage button in the Action Bar.
The Manage License Server slide out panel will appear.
2. Cont act technical support to request the Exit Grace Period code.
3. Enter the Exit Grace Period code in the text box.
The Apply button next to the End Grace Period and Keep Activated Licenses option will be enabled.
4. Click Apply.
The re-imaged License Server will no longer be in the grace period and will continue to operate in its
normal state.
For details on ending the grace period in a virtual environment, see Work ing with the Grac e Period on
page 67.

Using Command Line License Administration

The AVEVA Enterprise License Administration command tool emulates in command line format some of
the functions of the licensing subsystem's license administration tool. The command line tool enables
you to add a local or remote license server to your License Manager, import an entitlement, and activate
all licenses on that entitlement using the command prompt tool rather than the application interface.

Important: You must have at least local administrative privileges within your local hosting process or
remot e to use command line activation. This tool can only be used on a node where the full Licens e
Manager directory has been installed, and only supports online activation.

Using Command Line Functionality

The syntax for using the command line tool is organiz ed around three basic operations:
1. The "import" action allows entitlements to be imported and licenses in the entitlements to be
optionally activated against a license server node.
2. The "addserver" action allows one or more license servers to be added to a License Manager
instance.
3. The "deactivate" action allows the us er to deactivate licens es associated with a particular license
server.
Do the following:
1. Open the command prompt from Start, Run.

64
Administering AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

The Run dialog box appears. Enter "cmd" in the listbox.

2. Change the directory to the License Administration command tool install location: C: \ Program
Files(x86)\ Common Files\ ArchestrA\ Licensing Framework\ Licens e Manager\ LMWebA pp\
bin\SELicManagerCmd.

Note: You can access command line help at any time by entering any of the following into the
command prompt: -h, -H, or ?. For example: C:\ Program Files (x86)\ Common Files\ ArchestrA\
Licensing Framework\ License Manager\ LMWebApp\ bin\ SELicManagerCmd ?

3. Enter the following syntax to complete the "addserver" operation:

SELicManagerCmd addserver -n <nodename>, where <nodename> is the name of the node with
the license server directory installed. For example:

C:\Program Files (x86)\Common Files\ArchestrA\Licensing Framework\License

Manager\[Link]\bin\SELicManagerCmd addserver -n RM-NGLMv3
A "Success" status will appear beneath each line of syntax to indicate the action was successful.
4. Enter the following syntax to complete the "import entitlement" and "activat e" operations:
SELicManagerCmd import -e <folder pat h> -n<nodename> -a, where <folder path> is the folder
location of the entitlement you want to import. For example:

C:\Program Files (x86)\Common Files\ArchestrA\Licensing Framework\License

Manager\[Link]\bin\SELicManagerCmd import -e C:Users\Documents\ License
[Link] -n RM-NGLMv3 -a

Note: If you do not want to activate your licenses after the import operation, remove -a from the
end of the command syntax. If you choose not to use the -a switch you must activate your
licenses through the UI or run the command again with the -a switch.

There is no separate "activate" command. The "import, activate" command can be run to activate
licenses. This will not import the entitlement again.
Deactivation
To complete the "deactivation" operation enter the following syntax :
SELicManagerCmd deactivate -n <nodename>, where <nodename> is the name of the node with
the License Manager directory installed. For example:

C:\Program Files\<install directory> SELicManagerCmd deactivate -n RM-NGLMv3

Managing the Licensing System in a Virtual Environment

The AVEVA Enterprise licensing functionality is the same in bot h hardware and virtual environments. It is
important to deactivate all activated licenses before moving or copying an image of a virtual or hardware
node. When a license is activated it is associated to a uniquely identified license server. When the above
actions are performed on the virtual image hostin g the license server, the unique identification may
change and impact the activated license.
When the license server unique identification changes, the server enters a grac e period (on page 92).
The grace period allows you to continue performing normal licensing functions on the license server
hosted on the cloned or copied image without interruption. The grace period lasts fifteen days. You have
the duration of the grace period to update the licenses on the c loned or copied image.

Managing a License Server on a Virtual Image

Below are the recommended steps to manage the virtual image hosting a licens e server.

65
AVEVA Enterprise Licensing Guide Administering AVEVA Enterprise Licensing

Action Initial State Planned Change Recommended

Procedure

Moving a virtual A virtual image hosting a Move the virtual image Deactivate all
image hosting the license server with to a different host licenses before
license server activated licenses moving the image.
Activate licenses
again aft er moving.
Moving the hosted A hardware node hosting Move the hardware Deactivate all
server from a a license server with image to a virtual licenses before
hardware node to a activated licenses environment moving the image.
virtual image Activate licenses
again aft er moving.
Cloning a virtual A virtual image hosting a Create template of the Deactivate all
image hosting the license server with base image for cloning licenses on base
license server activated licenses and distribution to image. Clone the
other loc ations image. Activate
licenses again on the
cloned image.
Reverting to a A virtual image hosting a Revert virtual image to Do not shut down
Snapshot of a Virtual license server with snapshot product. Revert image
Image activated licenses to snapshot.
Snapshot will become
current image and
product will continue
running with acquired
licenses.
Press the Sync
button to refresh all
current licenses on
the License Server.

Managing a Licensed Product Virtual Image

Scenario Start State Planned Change Procedure

Moving a Virtual Licensed products with Move licensed Shut down each
Image wit h acquired licenses on a products to another product to release
Licensed Products virtual image host acquired licenses.
whos e License After the image is
Server is Hosted moved to a new host
on Another Node and the product
restarted, licenses will
be acquired.

If the license server

has changed,
configure moved
products to the new
server.

66
Administering AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

Moving Licensed Licensed products with Move licensed Shut down each
Products from a acquired licenses on a products to a virtual product to release
Hardware hardware image image licenses. After the
Environment to a image is moved to a
Virtual Image virtual host and the
product restarted, its
licenses will be
acquired.
Cloning a Virtual Licensed products with Create template of the Shut down the product
Image wit h acquired licenses on a base image for to releas e licenses.
Licensed Products virtual image cloning and Clone the image.
distribution to other Install and configure
locations product and acquire
licenses on the cloned
image.
Reverting a Licensed products with Revert image to a Do not shut down
Snapshot of a acquired licenses on a snapshot product. Revert image
Virtual Image with virtual image to snapshot. Snapshot
Licensed Products will become current
image and product will
continue running with
acquired licenses.

Only the licenses

available before the
snapshot was created
will be available after
reverting the snapshot.

Renaming the License Server Node

Make sure all licens es are deactivated before renaming the node where the License Server is installed.
If you rename the node while licens es are activated on the License Server, the licenses become invalid
and cannot be acquired. Additionally, the licenses cannot be reactivated unless you contact technical
support to recover your licenses.

Working with the Grace Period

When you clone or copy a virtual image hosting a license server, the server will enter a grace period (on
page 92). The grace period allows you to continue performing normal licensing functions for a limited time
on the virtual image of the cloned or copied license server wit hout interruption. The grace period lasts
fift een days. You have the duration of the grace period mode to rectify the grace period mode before the
server stops allowing licenses to be acquired.
The following status will appear in the tile of the server that has entered the grace period:

67
AVEVA Enterprise Licensing Guide Administering AVEVA Enterprise Licensing

The grace period notification will also appear in the Server Details page beside the Activation Server
Connection icon. You will see this icon:

Click this icon to see a list of any license servers in the grace period. The list will also display the
expiration dat e and time of each server's grace period. You can navigate to each server from this list.
Once your license server enters the grace period you will have fifteen days to exit the grace period and
update your licens es, otherwise the server will stop functioning and will not allow licens es to be acquired.

Ending the Grace Period

There are two options for ending the grace period. Your selection will depend upon whether you want to
use the licenses from the server on the base image for the server on the cloned image, or whether you
want to activate new licenses for the server on the cloned image.
The procedures for both cases are described in the following scenarios.

Scenario 1: New Licenses for Server on Cloned Image

You have cloned the image hosting your license server. The server on the cloned image has entered the
grace period. You want to leave the server on the base image intact with its licenses and activate new
licenses on the server hosted on the cloned image.
To end the grace period do the following:
1. Click the Manage button in the Action Bar.
The Manage License Server slide out panel will appear.
2. Click Apply next to the End Grace Period and Remove Activated Lic enses option.

Note: This will clear all licenses from the server hosted on the cloned image. All licenses on the original
image will remain functional. This action is not recoverable.

The license server hosted on the cloned image will no longer be in the grace period and will continue
to operate in its normal state.

Scenario 2: Same Licenses for Server on Cloned Image

You have cloned the image hosting your license server. The server on the cloned image has entered the
grace period. You want to continue using your licenses with the server on the cloned image. This
requires that the server on the base image be deleted. Yo u cannot operate wit h the same licenses on two
nodes.
To end the grace period do the following:
1. Click the Manage button in the Action Bar.
The Manage License Server slide out panel will appear.
2. Cont act technical support to request the Exit Grace Period code.

Important: Delete the license server on the base image before contacting Technical Support.

3. Enter the Exit Grace Period code in the text box.

The Apply button next to the End Grace Period and Keep Activated Licenses option will be enabled.
4. Click Apply.

68
Administering AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

The license server hosted on the cloned image will no longer be in the grace period and will continue
to operate in its normal state.

Note: If you have a redundant pair and one or both servers is in grace period, only the End Grace Period
and Keep Activated Licenses option will appear in the Manager License Server panel. The same Exit
Grace Period code will end either or both grace periods.

Ending the Grace Period in Offline Mode

You can end the grace period in offline mode. In offline mode the server hosted on the cloned image
must communicate with the Activation Server to exit the grace period. The procedure for ending the
grace period in offline mode is therefore the same as activating licenses in offline mode.
The following procedure applies to Scenario 2.
You have cloned the image hosting your license server. The server hosted on the cloned image has
entered the grace period and is in offline mode. You want to continue using y our original licenses on the
server hosted on the cloned image.
To exit the grace period in offline mode do the following:
1. Cont act technical support to request the Exit Grace Period code.

Important: Delete the server on the base image before contacting Technical Support.

2. On the server hosted on the cloned image, enter the Exit Grace Period code in the text box.
The Apply button next to the End Grace Period and Keep Activated Licenses will be enabled.
3. Click the Apply button.
Reset Grace Period will appear as a pending activation in the license grid.
4. Follow the procedure for activating licenses in offline mode.
For details see Activating Licenses in Offline Mode on page 40.
5. Upon click of Receive Activation/Deactivation, the server hosted on the cloned image will exit the
grace period.
The license server hosted on the cloned image will no longer be in the grace period and will continue
to operate in its normal state.

Note: Upgrading certain versions of AVEVA Enterprise Licensing can result in a grace period. End this
grace period by syncing licenses in the license server. For information on how to sync licenses refer to
Syncing Licenses on page 55section.
If the license server is in a Grace Period prior to upgrade, it will remain in Grace Period following
upgrade. To end the Grace Period aft er upgrading, you will need to contact Technical Support to obt ain a
Grace Period exit code. To avoid this scenario, end the Grace Period before upgrading to a newer
License Server version.

Reserving Licenses
The AVEVA Enterprise Licensing model supports concurrent and reserved licenses. By default, all
licenses are managed as concurrent licenses. In the concurrent license model, devices and us ers
acquire licenses on a first-come-first-served basis.
The reserved license model ensures that specific devices or users are assigned a license. Only one
reservation can be placed on a license at a time. However, if a single licens e contains multiple parts,
such as more than one client, each part can be reserved individually. Once all conc urrent licenses are
acquired, any new users or devices will be denied a license unless it has been reserved to them or
concurrent licenses bec ome available.

69
AVEVA Enterprise Licensing Guide Administering AVEVA Enterprise Licensing

Important: Reserving a license that is currently acquired by a device ot her than the devic e assigned in
the reservation does not releas e the license from the device. The reservation takes eff ect the next time
the license is releas ed and the assigned devic e acquires the license.

There are two types of license reservation:

 Device reservation
Reserving a specific product license to a device guarantees that a user accessing that device can use
the reserved license as long as the user is authorized by the licensed product.
Licenses can be reserved to any type of device, depending upon the configuration and functionality of
the product.
Servers or back end type applications can only be reserved to devices as they typically run as a
background service, and will always use the computer name on which this back end runs. Clients or
connection licenses can also be reserved to devices, but the expected device identification might vary
with the product. Refer to your specific product documentation for more information.
 User reservation
Reserving a license for a specific user guarantees that the user can use the reserved license as long as
the user is authorized by the licensed product.
User reservation is the main use case for res erving connection licenses. Reserving licenses to a user is
helpful when the same user needs access to the application from different devices at different times, and
be guaranteed to have a license available when needed.
For some products, a license will be reserved to a user automatically when the product acquires the
license. No manual reservation procedure is necessary in these cases.

Note: The device and user identifiers entered when reserving licenses must match the device and user
identifiers known to the relevant computer or domain.

There are two places where you can manage license reservations:
 From the selected license server via the Re servation tab on the Details page.

70
Administering AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

 From the Re servations page, accessed using the slide-out menu on the left of the interface. This
allows you to reserve licens es from any configured license server.

71
AVEVA Enterprise Licensing Guide Administering AVEVA Enterprise Licensing

Area Description

1 Click the Menu icon to open the Main Menu. The menu slides in from the left side.

2 Apply and Cancel buttons. Click Apply to save your changes in the res ervations
grid. Click Cancel to discard all changes.
3 The reservations grid displays information about each license and its reservation
status for all licenses on all servers.
 License Server name (Reservations page only - all servers)
 Feature
 Reservation Type
 Version (feature)
 Type of reservation (device or user), if the license is reserved
 Device or us er to which a license has been reserved
 Quantity of license
 Expiration date of the license
 Comment: You can add an optional comment for each reserved license.
Features from all running license servers are listed in the grid, along with reservation
information, as applicable.
You can sort on any column to order the displayed details.
If t he grid extends to more t han one page, you can reserve licenses only for the page
displayed. You cannot navigate away from a page wit h an incomplete reservation.

72
Administering AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

Reserving and Unreserving Licenses

To reserve a license
1. Starting from the Details page:
a. To reserve a license on the selected License Server, click the Reservation tab. The
Reservation grid appears.
b. To reserve licenses on any configured License Server, click the Menu and select Reservations.
The Re servations page appears.
2. Select the row containing the licens e you want to reserve.
a. Select Device or User in the Type list box.
b. Enter the device name in the Device/User list box, or select from the list if already populated.
For device names, a list typically will be populat ed based on your system configuration, but you
can also manually enter the device based on the expected device identification. The device
identification might vary depending on the specific product. Refer t o your product documentation
for more information.
For users, manually ent er the name as prescribed by the application you are using. The following
characters are not permitted as part of the user name: * + = [ ] ' ; , \ / { } |: < > ? and [space].

3. Enter an optional comment in the Comment column.

4. Click Apply to save your reservation. You can edit multiple rows before clicking Appl y.
Use the Re servations page (all active servers) or the Re servation grid (selected server only) to
unreserve licens es that previously have been reserved. When you unres erve a license, it becomes
available as a concurrent license which can then be reserved to other devices or users.
To unreserve a license
1. Navigate to the Reservations page (all active servers) or to the Reservation grid (selected server).
2. Select the row containing the licens e you want to unreserve.
3. Select the Type list box. From the list, select Unreserve.
4. Click Apply. The Type list box, the Device/User text box, and the Comment text box will clear. The
license can now be reserved for another devic e or user.

Monitoring License Usage

After a licens e is activat ed, it can be acquired by products.
An activated license typically is acquired from the moment you start up the licensed product and is in-use
as long as the product is running. When you exit or shut down the product, depending on the product
itself, the license is released and returned to the License Server, where it remains available for future
use.

Note: This behavior may vary on a product-by -product basis.

Video Tut orial: Usage Views

Double-click to view full screen.

73
AVEVA Enterprise Licensing Guide Administering AVEVA Enterprise Licensing

About Monitoring License Usage

You can view Feature Summary and Usage Details information by clicking the respective tabs on the
License Manager details page. The Feature Summary shows the license usage, as well as other basic
information for active licenses. The Usage Details shows det ail information for acquired licens es.

Viewing License Feature Summary Information

To view a summary of license usage
 In the main License Manager window, just above the license grid, click the Feature Summary tab.
The Feature View grid will display. Click a column heading to sort the list by that column.
o The Feature column displays the feature names of all activated licenses.
o The License Type column displays the type of license feature.
o The Version column dis plays the license feature version number.
o The Quantity column displays the total number of licens es available for the specific feature.
o The Re servation column displays the res ervations for each license feature.

74
Administering AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

o The In Use column indicates the license has been acquired by a product.

Note: If you see a symbol in the Quantity column, it means that an unlimited number of features are
available to be acquired for that particular license. The quantity column would display the feature count
like this: 2/ .

Viewing License Usage Detail Information

To view license usage details
 Click the View Details link to see detailed information about the license usage.
The Usage Details page will display. Click a column heading to sort the list by that column.
o The Feature column displays the name of the feature.
o The Type column displays the type of license feature.
o The Version column dis plays the license feature version number.
o The In Use/Total column displays the number of licenses in use against the total number of
available licenses for that feature.
o The Device column displays the name of the device on which the license is in use.
o The User column displays the name of the us er who has acquired the license

75
AVEVA Enterprise Licensing Guide Administering AVEVA Enterprise Licensing

o The Expected return column displays the expected date and time the license will be released
and returned to the server for re-use.

About Changing Default Port Settings

The License Manager components and the License Server rely on several Windows servic es, each of
which requires correct firewall configuration to access the Internet and your net work:
 License Server Core Service
 License Server Agent Service
License Manager us es the same ports as the two License Server Windows services, and must also be
configured with access to the internet and to your net work.
Depending on your particular environment, you may need to change the default port settings.

Caution! Be very careful when changing port settings. Doing so may impact product operation. The
topics in this section detail how to go about changing the settings.

Changing the Default License Server Core Service Port

The License Server Core Service is one of two Microsoft Windows services used by the License
Server. The default port is 55555, but may require configuration if one of the following is true:
 Your firewall blocks port 55555 explicitly or implicitly
 Port 55555 is already in use on your system
Port 55555 is one of a range of ports used as temporary, local "scratch" ports when Internet clients, such
as web browsers, email, and browser-bas ed applications such as AVEVA Enterpris e License Manager
and License Server connect to the service ports of remote Internet servers.
The License Server Core Servic e port is controlled by the [Link] file installed as part of License
Server. The License Server Core Service must be registered and running on your comput er. You can
verify this with Windows Task Manager, Services tab.
To change the License Server Core Service port
1. On the computer where License Server is installed, use a file edit or such as Not epad or any
commercially available XML editor to open propertie [Link] from the installed location:
o 32-bit operating system path: C:\Program Files\Common Files\ArchestrA\Licensing
Framework\License Server\ [Link]

76
Administering AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

o 64-bit operating system path: C:\Program Files(x86)\ Common Files\ArchestrA\Licensing

Framework\License Server\ [Link]
2. Update <listen-http-port-value> with the desired port number.

3. Restart the License Server Core Service.

4. Open the new port in your firewall.
You might need to cons ult your company Information Tec hnology department for enterprise firewall
configuration.
For how-to information, see Opening a Port in Your Firewall on page 79.
5. Open the product Configurator and provide the configured port number. For how -to information,
see Configuring License Server for the Product on page 25.

Changing the Default License Server Agent Port

The License Server Agent Service is one of two Microsoft Windows services used by the Licens e
Server. The default port is 59200, but may require configuration if one of the following is true:
 Your firewall blocks port 59200 explicitly or implicitly
 Port 59200 is already in use on your system
Port 59200 is one of a range of ports used as temporary, local "scratch" ports when Internet clients, such
as web browsers, email, and browser-bas ed applications such as AVEVA Enterpris e License Manager
and License Server connect to the service ports of remote Internet servers.
The License Server Agent Service port is controlled by the [Link] file
installed as part of License Server. The License Server Agent Service must be registered and run ning on
your computer. You can verify this with Windows Task Manager, Services tab.
To change the License Server Agent Port
1. On the computer where License Server is installed, use Notepad or another text editor to open the
[Link] file from the installed location:
o 32-bit operating system path: C:\Program Files\Common Files\ArchestrA\Licensing
Framework\License Server\ [Link]. [Link]
o 64-bit operating system path: C:\Program Files(x86)\ Common Files\ArchestrA\Licensing
Framework\License Server\ [Link]. [Link]

77
AVEVA Enterprise Licensing Guide Administering AVEVA Enterprise Licensing

2. Change the port number as necessary, then save and close the file. See the following illustration for
the relevant text to edit.

3. If your products are installed on a different computer than the License Server, open
[Link] in a text editor from the computer with installed products.
It is located here:
o C:\ProgramData\Schneider Electric\Licensing\[Link]
4. Change the port number as necessary. See the following illustration for the relevant text to edit.

5. Restart the License Server Agent Service.

6. Open the new port in your firewall. For how-to information, see Opening a Port in Your Firewall on
page 79.

Changing License Manager Ports

License Manager represents the client side of the client/server licensing system, and needs to use the
same ports for communication as those configured for License Server. License Manager ports are
controlled by the [Link] file and also by the [Link] file. The default ports, detailed
in the following steps, are 55555, 59200, and 80.
 Port 55555 and port 59200 belong to a wide range of ports used as temporary, local "scratch" ports
when Internet clients, such as web browsers, email, and browser-based applications such as
AVEVA Enterprise License Manager and License Server connect to the service ports of remot e
Internet servers.
 License Manager is configured to leverage port 80 as a shared port, assuming that the default was
taken when the server was configured or set up.

78
Administering AVEVA Enterprise Licensing AVEVA Enterprise Licensing Guide

To configure License Manager ports

1. On the computer where License Manager is installed use a text editor such as Not epad or any
commercially available XML editor to open [Link] from the installed location:
o C:\ProgramData\Schneider Electric\Licensing\License Manager\Dat a\[Link]
2. Update the port numbers in the Port [Link] file, then save and close the file.
a. Update <LicenseS erverPort> with the same number configured for License Server. The default
is port 55555.
b. Update <LicenseS erverAgentPort> with the same number configured for License Server. The
default is port 59200.
c. Update <LicenseManagerPort> with your custom port number. The default is port 80.

3. Open the [Link] file from the installed location:

o C:\ProgramData\Schneider Electric\Licensing\[Link]
4. Update the port numbers in the [Link] file, then save and close the file.

Opening a Port in Your Firewall

When you define new ports for the License Server and Licens e Manager, you must ensure that those
ports are open in your firewall.
 Cons ult your company Information Tec hnology department for enterprise firewall configuration.
 For more detailed procedural information, see Microsoft's operating system online documentation.

79
 AVEVA Enterprise Licensing Guide

C HAPTER 5
Troubleshooting
In This Chapter
Diagnosing Licensing Issues ......................................................................................................... 81
Diagnosing Licensing Issues using Log Messages .......................................................................... 81
License Server Issues and Solutions .............................................................................................. 83
License Activation Issues and Solutions ......................................................................................... 84
Acquiring Licenses Issues and Solutions ........................................................................................ 86
License Reservations Issues and Solutions .................................................................................... 88
Grace Period Issues and Solutions ................................................................................................ 89
Miscellaneous License Management Issues and Solutions .............................................................. 89

Diagnosing Licensing Issues

Use the information provided in the following sections to identify an issue you might be experiencing and
to implement the recommended solution. If the solution does not res olve the issue, or if the information
provided does not answer your specific question, contact Tec hnical Support.

Diagnosing Licensing Issues using Log Messages

Use the Log Viewer as a diagnostic tool to gather more information about an issue. You can view logged
messages sent to the Logger, to determine whether all processes are functioning properly. Logger is a
background process that stores messages in the system log file.

To start the Log Viewer

1. Click Start, point to Programs, and then point to Wonderware.
2. Click Arche strA System Management Console . The Arche strA System Management Console
appears with the Log Viewer listed in the left pane.
3. Double-click Log Viewer to expand its groups. The Local group is listed beneath the Default
Group.
For more information about the Log Viewer, refer to the Log Viewer Help.

The Log Flag Editor lists all the ArchestrA components installed on the node you selected. Use the Log
Flag Editor to assign a flag value to each category of the selected messages issued by a license
manager component. By switching flags on or off, you can control which categories of messages are
saved to the Logger.

To Open the Log Flag Editor

1. Expand the ArchestrA Log Viewer list to show ArchestrA nodes.
2. Select the node from the list that you want to enable with logging flags.
3. On the Action menu, click Log Flags.

81
AVEVA Enterprise Licensing Guide Troubleshooting

To set log flags for a single component

1. Select the required component from the Component List view or select Global.
The Log Flags view shows the log flags for the component you selected. If you select Global, all the
flags are displayed.
2. In the Log Flags view, select the check boxes of the log flags you want to enable.
3. On the File menu, click Apply. All component messages from the selected categories are logged.
The following table describes different components of License server, License API, and Licens e
Manager:

Product Components Log Flag Type of Information Logged

Logs any error condition related to

the initialization and running of the
License Server and its
SELicServerInfo dependencies. Thes e log flags
LicServer also track issues related to grace
SELicServer period entry usually as a result of
copying or cloning a License
License
Server running in a virt ual
Server
machine environment.
Logs information related to the
publishing of licensing information
LicServer to asset management clients and
[Link]
SamService information related to cont rolling of
the License Service from License
Manager.

LicAPILoader
LicAPIConnection Logs exception messages from
LicAPI software due to input or
SELicensing environment.
Logs informational messages
during execution of Licensing
operations.
For example:
 Not configured to License
LicAPI Server
LicAPILoader
LicAPIConnection  Trusted storage is not
LicAPI available
 There are no acquired
Licenses available
 Licenses released
successfully
Info-Licensing  License reserved successfully

Logs custom messages during

LicAPI
SELicAcquire License Acquisition process.

82
Troubleshooting AVEVA Enterprise Licensing Guide

Logs total time taken for Lic ense

LicAPI
SELicTiming Acquisition proc ess.
Informational messages from
Licensing operations like
capability response created,
LicServAP I posted during activation,
[Link] messages about updating pair
[Link] status, updating grace period
LMWeb
[Link] SELicensing status.

Opening a Log File

1. From the Action menu, click Open Log File.
2. Browse to locat e the log file, and click Open.
3. The saved log messages appear in the message window.

For more information on the Log Flag Editor, refer to the ArchestrA Log Flag Editor Us er Guide.

License Server Issues and Solutions

The following table provides common License Server-related issues and solutions.

Operation Problem Description Solutions

Server - adding Adding a secondary License Solution 1:

Server fails. Possible causes:
Reconfigure the License Manager web service
 License Server to use the local admin account. Using the local
components are not system account across workgroups does not
installed on the specified provide sufficient security.
node.
Solution 2:
 The license server port is 1. Uninstall License Server/Licens e
not open. Manager.
 The license server name is 2. Clean up license related folders from
incorrect. C:\ProgramFilesx86 and C:\Program Data.
 The server is not 3. Reboot and reinstall License
accessible. Server/License Manager.

Note: You might need to delete certain

Registry keys. If the preceding solutions are
insufficient, contact Global Customer Support.

83
AVEVA Enterprise Licensing Guide Troubleshooting

Operation Problem Description Solutions

Server - adding, When adding a new License Remove this License Server from the other
redundant Server for setting up License Manager before adding it to this
Redundancy, an error License Manager.
message informs you that the
Note: If adding a second server for the purpose
License Server is already
of setting up redundancy, that server cannot
managed by anot her Lic ense
have had an activated license. If a license has
Manager. (License Manager
ever been activated on the server, the Server
versions 3.1 and earlier.)
ID must be reset.
Refer to Tech Note 2907, Licensing - Best
Practices
[Link] [Link]-electric.c
om/Pages/OK [Link]?docId=TN2907&
actp=LIST.
Server - adding, Difficulty setting up AVEVA See AVEVA Enterprise Licensing Help,
redundant Enterprise Licensing Working with Lic ense Server Redundancy.
redundancy.
Refer to Tech Note 2907, Licensing - Best
Practices
[Link] [Link]-electric.c
om/Pages/OK [Link]?docId=TN2907&
actp=LIST.
Server - Communication failure Upgrade to System Platform 2017 Update 1 or
communication between Wonderware products contact Technical Support to install hotfix
with and a License Server resulting L00146946.
in product shutdown.
For more information, refer to Tech Alert
TA274, "Communication failure bet ween
AVEVA products and a License Server can
result in product shutdown"
[Link] [Link]/Page
s/[Link]?docId=TA274&actp=LIST.
Server - The license server is not listed Disable P roxy in your web browser.
communication in the License Manager. Using
with the Configurator to configure
the server returns firewall
errors.
Server - Remote node unable to Intelligence S oft ware (formerly known as
communication connect to license server on Wonderware Int elligence), Alarm Advisor and
with default port 55555 Recipe Manager Plus were the first products to
use AVEVA Enterprise Licensing. Your
product installation might be using version 1.0
in which the License Server ID does not
contain the License Server computer name as
part of the ID

License Activation Issues and Solutions

The following table provides common License Activation -related issues and solutions.

84
Troubleshooting AVEVA Enterprise Licensing Guide

Operation Problem Description Solutions

Activation Unable to communicate Check that the following conditions are met:
with Activation Server
1. Able to do offline activation from same computer.
during online activation.
2. Network is available on the computer running
License Manager.
3. Make sure the following website is not blocked:
[Link]
[Link]/deviceservices
4. Local or enterprise firewall is correctly
configured:
The following ports need to be opened :
o Web Manager: 80
o Core Service: 55555
o Agent: 59200
o License Manager to Activation server: 443
Activation Successfully activated a See Renaming a Lic ense Server on page 52.
license, then deleted, or
formatted, or renamed the
License Server prior to
deactivating the license.
The license can no longer
be activat ed.
Activation Licenses disappeared Cont act Technical Support to release the licenses.
from License Manager Reset the License Server ID in License Manager.
even though they were Activate licenses.
successfully activat ed.
Activation How do I activate See the License Manager online help, Activating
licenses? Licenses on page 37 section.
Also, refer to Tech Note TN 1395 - Licensing -
Activate License Using ONLINE Activation.
[Link] [Link]/Pa
ges/OK [Link]?docId=TN1395
Also, Refer to Tech Note TN 1396 - Licensing -
Activate License Using OFFLINE Activation.
[Link] [Link]/Pa
ges/OK [Link]?docId=TN1396
Activation Not able to activate For License Manager versions 3.2 and later, hold
license after it was down the Control key and click the left mouse button
released by Technical to select and activate a license that the Licens e
Support. Manager thinks is already acti vated.
For versions 3.1 and earlier, contact Technical
Support to modify the DB file. After modifying the DB
file, you can browse to the XML file from License
Manager and activate the license.

85
AVEVA Enterprise Licensing Guide Troubleshooting

Operation Problem Description Solutions

Activation Error "[Link] Deactivate pending licenses and reactivat e using

The FNE Server offline mode.
encountered an error".
Activation Failed to activate Use Windows Task Manager to start the License
licenses. Manager Web Service, License Server Agent
Service, and License Server Core Service. Make
sure License Server is running in License Manager.
Activation - How many entitlement IDs Each XML file has one entitlement ID. One
entitlement can a license file have? entitlement ID can have many activations.
file
Activation - Not able to sync file when Cont act Technical Support to obsolete the License
offline using Offline Activation. Server. Reset the License S erver ID using License
Manager. Activat e the license again.

Acquiring Licenses Issues and Solutions

The following table provides common issues and solutions related to acquiring licenses.

Operation Problem Description Solutions

Acquire license - The License Manager takes a This issue can occur if the computer on
lag time long time to acquire license which License Manager is installed is not
even with reservation. connected to the internet, which blocks
certificate validation necessary to
enhance security and reliability.
Workaround 1 (preferred):
This method changes the default timeout
for the certificat e check.
1. Open the Local Security Policy
settings (enter "Local Security Policy"
in the Start menu searc h bar).
2. Select Public Key Policies.
3. Under Object Type, right-click on
Certificate Path Validation
Settings and select Properties.
4. In the Properties dialog, select the
Network Retrieval tab.
5. Select Define these policy settings
check box.
6. Set the both the settings under
Default retrieval timeout settings
to 1 second, or to the value you
prefer. Typic ally, both URL ret rieval
and path validation cumulative
retrieval require only milliseconds to
complete.

86
Troubleshooting AVEVA Enterprise Licensing Guide

Operation Problem Description Solutions

7. Click Apply and then OK.

Workaround 2:
This method disables checks for revoked
certificates.
1. From the Control Panel or Internet
Explorer, open Internet Options.
2. Select the Advanced tab and scroll
down to Security.
3. Uncheck the, Check for publi sher's
certificate revocation check box.
4. Click Apply and then OK.
Workaround 3:
This method installs the certificates that
the operating system is attempting to
validate onto the local machine.
Once installed locally, the operating
system will no longer need to access the
network to retrieve them.
1. Locate any DLL or E XE file from
AVEVA Enterprise Software.
2. Right -click on the file and select
Properties.
3. Select the Digital Signature tab.
4. Select the AVEVA Enterprise
certificate from the list and click
Details.
5. Select View Certificate.
6. On the dialog that appears, select
Install Certificate and follow the
prompts to install the certificate on
the local machine.
7. Locate the file Flxcore. dll and repeat
steps 2 through 6 for it.
By default, this file is located in:
C:\Program Files (x86)\ Common
Files\ArchestrA\Licensing
Framework\License AP I2
Referenc e: System Platform 2017
Update 1 ReadMe file, Known Issues
#933752.
Acquire license - After renaming a License See Renaming a License Server on page
changed or Server, not able to acquire 52.
renamed product licenses.

87
AVEVA Enterprise Licensing Guide Troubleshooting

Operation Problem Description Solutions

Acquire - release InTouch run-time license is Cont act Technical Support and get the
license activated on a node and the 30-day demo license.
devic e becomes unusable.
The license was not released  Install Licens e Server and LIcense
by that device. How do I Manager on the new InTouc h
run-time node and activate the
recover the InTouch run-time
node? 30-day demo license.
 Point the new InTouch run-time node
Configurator to use the License
Server which has the demo license.
Acquire - release How do I force a device to Use the Configurator to temporarily point
license release the license? the client machine to a different License
Server. This will release all licenses in
use by that machine. Then point the
Configurator back to original Licens e
Server.
Acquire - release How do I correctly release a Close all the application. For ex ample,
license license? close WindowMaker, WindowViewer, or
the IDE using an orderly shutdown
procedure.

License Reservations Issues and Solutions

The following table provides common issues and solutions related to reserving licenses.

Operation Problem Description Solutions

Reservations When should I use We recommend license reservation when there are
Reservations? different licenses for a single product.
Example - reservations unnecessary: On a license
server with one Historian license (or sub license)
and one InTouch license, there is no need to
reserve because only Historian can us e the
Historian license and only InTouch can use the
InTouch license.
Example - reservations recommended: if you have
an InTouch read only, InTouch read/ write and
InTouch runtime on the same server, then you
need to reserve each to the node that should use
them.
Reservations How do I make sure that Reserve the run-time license to the Application
an Application Server Server run-time node.
run-time license is taken
If this does not resolve the issue, deactivate the
by a device instead of the
DEV license when not in use. This will force the
DEV license?
run-time node to acquire the run-time license or
reserve the dev license to a non existent node so
that it cannot be acquired.

88
Troubleshooting AVEVA Enterprise Licensing Guide

Grace Period Issues and Solutions

The following table provides common issues and solutions related to the license grace period.

Operation Problem Description Solutions

Grace period Server entered Grace period. Cont act Technical Support for the Grace Period
Need Grace Period E XIT Exit code.
code.
Grace period A License Server is in a The following operations will cause a grace period
grace period. Why? detection:
 Move – Moving a VM from one environment to
another typically invalidates the original.
 Clone or copy a License Server.
 VHD export – Exporting a Virtual Hard Drive
(VHD) from one system to another, then using
it to set up a new VM.

Miscellaneous License Management Issues and Solutions

The following table provides information about miscellaneous license issues and solutions.

Operation Problem Description Solutions

Logging Where are the license log Log files are typically located at:
files located?
C:\ProgramData\Schneider
Electric\Licensing\License S erver
Logging - How do I use the SMC log Turn on following log flags under the Global
flags related to licensing? component. This will ensure that all product
SMC log flags
licensing component flags are on.
A vailable Log Flags:
 SELicensing
 SELicAcquire
 SELicTiming
 Info-Licensing
 Licensing
 LicensingDet ailed
 LicensingConnection
 LicensingB ackend

89
AVEVA Enterprise Licensing Guide Troubleshooting

Operation Problem Description Solutions

License expiration Why does my permanent When a newer version of same license is
license have an expiration ordered, the older licens e will have an
date? expiration dat e. This is designed to give you
six months to upgrade to the new version.
You can identify this by viewing the license
Details page in License Manager. Sort on the
serial number column. You will see two
similar serial number with different extension
numbers.
For example:
T17082203-0
T17082203-1
In the example, T17082203-0 will have an
expiration dat e 6 months from the date
T17082203-1 was creat ed. T17082203-1 will
be a permanent license.
Permissions - Who has permission to Any user who is a member of the SELicMgr
License Manager modify License Manager? group or Admin group on both License
Server and License Manager nodes has the
necessary permissions to modify License
Manager.
Permissions - For InTouch OMI, how can This feat ure is not available. An
application I restrict a user to launch enhancement request (L00147301) has
an app only in read-only been logged for this issue.
mode?
A workaround is to restrict user access to
graphics or to set up Navigation security for
ViewApps so that users are restricted to
certain windows.

90
 AVEVA Enterprise Licensing Guide

C HAPTER 6
Glossary
In This Chapter
Acquire (a license) ........................................................................................................................ 91
Activate (a license) ....................................................................................................................... 91
Activation ID ................................................................................................................................. 91
Activation Mode ............................................................................................................................ 91
Activation Server .......................................................................................................................... 91
Entitlement File............................................................................................................................. 91
Entitlement ID............................................................................................................................... 91
Grace Period ................................................................................................................................ 92
License Manager .......................................................................................................................... 92
License Manager Brows er ............................................................................................................. 92
License Server ............................................................................................................................. 92
Port.............................................................................................................................................. 92
Request File ................................................................................................................................. 92
Response File .............................................................................................................................. 92
Serial Number .............................................................................................................................. 92

Acquire (a license)
An installed product, when running, ac quires its activated license from the License Server and releases it
when no longer needed.
Activate (a license)
To retrieve a valid license from the Activation Server. The Activation Server takes an Activation ID and
provides an activated license in return.
Activation ID
An Alphanumeric code that is provided to the Activation Server in order to activate the license.
Activation Mode
The setting which determines which workflow is followed in order to activate licens es. The Activation
mode is either Online or Offline.
Activation Server
An internet-based server that Interacts with the License Manager to activate and deactivat e licenses on
the License Server. The Activation Server processes requests received by the License Manager and
responds with the activation information for the corresponding license server. You do not need to install
or maint ain the Activation Server.
Entitlement File
A file containing information about specific product licenses, used to transport and activat e purchased
licenses.
Entitlement ID
A unique identifier that groups all licenses from a single order together.

91
AVEVA Enterprise Licensing Guide Glossary

Grace Period
The grace period allows you to continue performing normal licensing functions on the virtual imag e of the
cloned, copied or restore image of a Licens e Server without interruption. The grace period lasts fift een
days. You have the duration of the grace period to update the licenses on the cloned or copied image.
License Manager
The License Manager is a web based application that allows you to manage and maint ain licenses on
each License Server at run time. It is a standalone utility that can be installed on the Licens e Server
computer or any other computer. The License Manager serves as a bridge between disconnected
License Server and the Activation Server and can be remotely accessed by any web browser.
License Manager Browser
The License Manager is a web based user interface that can be remotely accessed by any web browser.
License Server
Cont ains the licenses for your system and stores license usage data that can be accessed by the
License Manager. Soft ware application licenses are served by the License Server and can serve on any
type of client (Windows, brows er, tablets or mobile).
Port
Network communication channel by which different licensing components communicate with one
another.
Request File
A file (*.sync) which contains activation information that is generated through the Licens e Manager, in
order to acquire a license from the Activation Server.
Response File
A file (*.rec v) that is generated by the Activation Server containing license rights for activation through
the License Manager.
Serial Number
A unique number identifying a specific license.

92
 AVEVA Enterprise Licensing Guide

Index
No index entries found.

93