AVEVA Enterprise Licensing

Getting Started Guide

© 2018 AVEVA Group Plc. All rights reserved.
The Schneider Electric industrial software business and AVEVA have
merged to trade as AVEVA Group plc, a UK listed company. The
Schneider Electric and Life is On trademarks are owned by
Schneider Electric and are being licensed to AVEVA by Schneider
Electric.
No part of this documentation shall be reproduced, stored in a
retrieval system, or transmitted by any means, electronic,
mechanical, photocopying, recording, or otherwise, without the
prior written permission of AVEVA. No liability is assumed with
respect to the use of the information contained herein.
Trademarks
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 software described in this documentation is
furnished under a license agreement. This software may be used or
copied only in accordance with the terms of such license
agreement.
ArchestrA, Avantis, DYNSIM, eDNA, EYESIM, InBatch, InduSoft,
InStep, IntelaTrac, InTouch, PIPEPHASE, PRiSM, PRO/II, PROVISION,
ROMeo, SIM4ME, SimCentral, SimSci, Skelta, SmartGlance, Spiral
Software, WindowMaker, WindowViewer, and Wonderware are
trademarks of AVEVA and/or its subsidiaries. An extensive listing of
AVEVA trademarks can be found at: http://sw.aveva.com/legal. All
other brands may be trademarks of their respective owners.

Publication Date: October 2018

 Contents 1

Contents

What is AVEVA Enterprise Licensing? .......................3

How Does it Work? ................................................................... 4
AVEVA Enterprise Licensing Components............................. 6
Key Terms and Concepts.......................................................... 8

Working with License Servers ................................13

Planning License Manager and Server Topologies............... 13
Adding a License Server......................................................... 15
Pointing to the License Server............................................... 16
Working With License Server Redundancy .......................... 17
Monitoring License Server Health......................................... 18

Activating and Acquiring Licenses .........................21

Online Activation.................................................................... 21
Offline Activation.................................................................... 22
License Reservation................................................................ 23

AVEVA Enterprise Licensing FAQs...........................25

2 Contents
 3

What is AVEVA
Enterprise Licensing?

The AVEVA Enterprise Licensing platform is a common

platform that allows you to effectively and efficiently
manage AVEVA Software product licenses. This licensing
system was introduced to allow centralized license
management, remove the need for dongles, and increase
license security by use of Activated licenses. It is composed
of a browser-based License Manager and a License Server
that together allow you to share and deliver licenses for
your installed products. It supports flexible topologies for
any size of system. This guide applies to Activated licensing
for InTouch, InTouch Web Client, Application Server,
Historian Server, Historian Clients, OI Server, Alarm
Adviser, and Recipe Manager Plus.
This document provides a summary of the licensing process
related to the 2017 Update 1 and Update 2 release and
provides licensing related recommendations for different
topologies. For more information about licensing topologies
refer to Working with License Servers on page 13 and the
“About Licensing Topologies” section of the AVEVA
Enterprise Licensing Online help and PDF located on the
System Platform DVD.
The AVEVA Enterprise License Manager 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
4 What is AVEVA Enterprise Licensing?

How Does it Work?

This section describes the licensing workflow. This example
assumes that both License Manager and License Server are
installed on the same computer, and that the computer can
connect to the Internet.
1 Purchase one or more AVEVA Software products: Along
with your installation media or downloads, you will
receive one or more entitlement files containing licenses
details.
2 Start License Manager: It opens in a browser window
and accesses the installed License Manager
components.
3 Select the License Server: Use the License Manager to
select an available server to host the licenses you want
to activate. You can also add a new license server. For
more information refer Working with License Servers
on page 13
4 Import the Entitlement file: 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 sent to you
in an e-mail upon purchase of your product licenses. It
is in a zipped .xml file format.
5 Activate licenses: License Manager connects to the
AVEVA Activation Server over the Internet to activate
the selected licenses on the License Server.
The Activation Server activates licenses on the License
Server. For more information refer to Activating and
Acquiring Licenses on page 21.
6 Manage your licenses: Licenses are now available for
their respective product to use. You can now:
• activate new licenses
• deactivate current licenses
• reserve and unreserve licenses
 How Does it Work? 5

7 Install and Configure the purchased products: Install

your purchased AVEVA 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.
6 What is AVEVA Enterprise Licensing?

AVEVA Enterprise Licensing Components

AVEVA Enterprise licensing includes the following
components:
License Manager.
The License Manager allows you to quickly access and
maintain licenses for certain AVEVA Enterprise Software
products in your different environments by means of its
scalable, flexible design features:
• 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 same 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 software application being
licensed, including Windows browsers, tablets, and
mobile devices.
• Provide current license usage information.
 AVEVA Enterprise Licensing Components 7

Activation Server.
Activation server is a cloud-based Internet accessible
server to which the License Manager connects for license
activation. The License Manager connects to the AVEVA
Activation Server in the Cloud only temporarily during the
activation process.
Additional functional components and concepts are
described under the key terms and concepts section.
8 What is AVEVA Enterprise Licensing?

Key Terms and Concepts

The following table describes the key terms and concepts of
AVEVA Enterprise Licensing.

Term Description

License Server Node Computer or VM where the

License Server software is
installed and running.

License Manager Node Computer or VM where the

License Manager software is
installed and running.

Entitlement File An XML file that contains the

Activation IDs which enable
specific product software
functionality.

Entitlement ID A unique identifier that groups all

licenses from a single order
together. This unique identifier is
also the file name of the
Entitlement file.
Example: DEV10200-int-2017A

Activation ID A code that enables the activation

of a specific product license.

License Activation License Activation is the process

of enabling a purchased license on
a particular License Server for
consumption by a product.
Activation process can be done
Online (typical) or Offline (a
standalone License Server node
that does not have access to the
Internet).
 Key Terms and Concepts 9

Term Description

License Reservation Licenses can be reserved for a

particular device, or left
unreserved. The reserved license
model ensures that specific
devices are assigned a license and
can be acquired only by that
device. An available unreserved
license can be acquired by any
device without a reservation.
Once all unreserved licenses are
acquired, any new license
requests will be denied.

Online Activation Online activation provides a

workflow to activate your licenses
when a system has access to the
Internet and it can reach the
AVEVA Activation Server. Online
Activation is the default mode.

Offline Activation Offline activation provides a

workflow to activate licenses
when a system does not have
access to the Internet and thus to
the AVEVA Activation Server.

Request File A License Manager generated file

(*.sync) containing activation
information used in the Off-Line
Activation mode for the Activation
Server to activate a license.

Response File An Activation Server generated

file (*.recv) containing license
rights for activation used in the
Off-Line Activation mode in order
to complete the activation process.

Borrowed Time If a node does not or cannot

communicate with the Licenses
Server to renew the license, then
it will expire after certain time.
This time duration is called
borrowed time.
10 What is AVEVA Enterprise Licensing?

Term Description

Grace Period On the virtual image, if you try to

clone or copy image of a License
Server, the licenser server will
enter a grace period. The grace
period allows you to continue
performing normal licensing
functions for15 days. After the 15
day Grace Period, the License
Server will no longer serve
licenses. You will need to update
the licenses on the cloned or
copied image within this time.

Redundancy You can configure your system for

high availability (HA) and
disaster recovery (DA) using the
license server redundancy
features. For more details on how
to setup redundancy, see
“Working With License Server
Redundancy” section in AVEVA
Licensing online help.

Virtualization You can configure your licensing

platform using commercially
available virtual machines as part
of your topology. For more details
on how to set up a virtualized
environment, see “Managing the
Licensing System in a Virtual
Environment” section in the
AVEVA Licensing online help.
 Working with License
Servers

Planning License Manager and Server

Topologies
AVEVA Enterprise Licensing is scalable and flexible. You
can set up single-node or multiple-node (distributed)
systems. Deploying the licensing framework is a matter of
determining and implementing a topology that matches
your working environment. If you are implementing a
distributed topology, we recommend creating a network
diagram as a first step, to visually model the system before
installing License Manager and License Server. There are
many possible topologies for systems of different sizes and
complexity. See AVEVA Enterprise Licensing online help
and PDF guide for deployment guidance.
14 Working with License Servers

Single Node Topology

The Single Node Topology is a single computer with the
purchased product, License Manager, and License Server
installed.

In this configuration, the communication between the

product server components, License Server and License
Manager is local.
Distributed Topology
The licensing components can be installed on separate
nodes as long as there is reliable network connectivity
between them. Distributing the licensing components
across nodes may help optimize resource usage. This
topology is best suited for systems where the License
Server manages licenses for multiple products.
 Adding a License Server 15

In the following example, the License Manager components

are installed on one computer with Internet access to the
Activation Server, the License Server is installed on a
second computer, and product components are installed on
separate computers, each with network access to a License
Server.

Adding a License Server

• Installation and Launch of License Manger: First using
the System Platform 2017 Update 3 DVD, run the
Setup.exe install program. One of the options is to
install the License Manager application and License
Server software. After installation, launch the License
Manager.
16 Working with License Servers

• 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 these 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.
For more information refer to the “Using AVEVA
Enterprise Licensing” chapter of AVEVA Enterprise
Licensing Help.
You can add or remove a License Server from the Server
Summary Page of the Licence Manager. A License Server
can be located on the SCADA network as a centralized
License Server serving and managing all licenses across
the network or the License Server can be the same node
running the product software.
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.
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 computer name and the
display name are the same.
c Enter an optional description for the License Server,
then click Apply. License Manager returns to the
Details page and displays the details of the License
Server you have just added.

Pointing to the License Server

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. You can use the configurator
on a product node to point to a License Server.
 Working With License Server Redundancy 17

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 enter or edit the License Server details by
going to the Windows Start menu and clicking
Configurator.

By default, the installation process identifies the local

computer as the License Server name 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.
You can test your connection to the License Server by
selecting Test Connection. Press Configure to save all
your changes.

Working With 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.
For more information see AVEVA Enterprise Licensing
Guide.
18 Working with License Servers

Monitoring License Server Health

Monitoring License System Health
Sentinel System Monitor (Sentinel) is an application that
monitors and manages the health, performance and
availability of your AVEVA system. Included with the
System Platform install is a Sentinel basic mode which
monitors the connectivity of the licensed nodes on the
control network to one or more License Servers. In
addition, the basic mode also enables full functionality of
Sentinel on one node so users can see how it works.
Full functionality of Sentinel monitors and manages the
performance and availability of your AVEVA system,
including the core software, the engineered software
application(s), node connectivity to the License Server, and
the related hardware and network infrastructure.
Sentinel detects messages and reports on system
performance issues/errors/trends, and monitors key system
attributes, and then generates alerts when those attributes
exceed defined tolerance ranges.
When an attribute is out of tolerance, the customer support
team (internal, systems integrator, and/or Technical
Support) is notified of the upset condition, and can respond
proactively in order to prevent production interruption or
downtime. The goal is to ensure that the performance of
your solution meets and exceeds your expectations. Full
functionality Sentinel is available for purchase separately.
 Monitoring License Server Health 19

Set up for Sentinel running in basic mode:

1 Carefully select a reliable machine to host Sentinel, and
it is recommended that the Sentinel machine is a
different machine that your License Server machine(s).
For example, in a System Platform environment, install
the Sentinel Manager on the GR node (recommended).
2 Following installation of Sentinel, in the configurator
under Sentinel Manager, input your SMTP server
information.
3 On other System Platform or InTouch nodes, install the
product software as usual. Following installation of the
product software, in the configurator under Sentinel
Agent Install Manager, input the host name or IP
address of the Sentinel Manager server.
4 Monitoring of license acquisition will begin immediately
following these steps.
20 Working with License Servers
 Activating and
Acquiring Licenses

License Activation 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 an activated license in return.
A license is created and delivered as an XML file
(Entitlement File). The XML file contains one to many
Activation IDs, one ID for each license purchased. You can
activate the XML file by connecting the local License Server
to the Activation Server in the Cloud by using the License
Manager application installed on their local License Server.
Acquiring a license occurs when an installed product is
started. An installed product, when running, acquires its
activated license from the License Server and releases it
when no longer needed. Once a license is acquired by a
product software, the license cannot be used by another
product until the license is released back to the License
Server. The release of the license occurs when the product
goes through a proper shutdown.

Online Activation
Online activation provides a workflow to activate your
licenses when a system has access to the Internet and it can
reach the AVEVA Activation Server. Online Activation is
the default mode.
The License is locked to the License Server when the
activation process takes place. During this Activation
process, the local License Server is typically connected to
22 Activating and Acquiring Licenses

the Internet, however, after Activation is complete,

connection of License Server to the Activation Server in the
Cloud is no longer necessary.
Online Activation Procedure:
1 Once you have installed the License Server and License
Manager components, start the License Manager
application and connect to a chosen License Server.
2 Import the Entitlement XML File containing the license
Activation IDs.
3 Activate licenses.
4 Install the AVEVA product software.
For more information on online activation, see “Activating
Licenses in Online Mode” section in AVEVA Enterprise
Licensing help.

Offline Activation
Offline activation provides a workflow to activate licenses
when a system does not have access to the Internet and
thus to the AVEVA Activation Server.
Offline Activation Procedure .
1 Once you have installed the License Server and License
Manager components, start the License Manager
connecting to a chosen License Server.
2 Import the Entitlement XML File containing the license
Activation IDs.
3 Set the License Manager to Offline Activation mode.
4 Press the Request Activation button. A Request File
(*.sync) will be created.
5 Using a computer that has Internet access, visit the
AVEVA License Activation Web page via our Global
Customer Support site.
6 Upload your Request File (*.sync).
 License Reservation 23

7 You will receive a Response File (*.recv) that you will be

able to use in the License Manager to complete the
activation process.
8 Using the License Manager, press the Receive
Activation button and navigate to the Response File
received and upload it. The selected license will now be
activated.
For more information on offline activation see “Activating
Licenses in Offline Mode” section in the AVEVA Enterprise
Licensing help.

License Reservation
Once a license is activated, using the License Manager,
licenses can be 'reserved' to a particular device or left
unreserved (floating) to be acquired by a software product
on the network.
If you have multiple of the same license, for the same
product hosted in the same License Server, reservations
are not needed. However, if one or more licenses have
unique functionality, then reservations are needed to
ensure that those unique licenses are acquired by the
proper device.
24 Activating and Acquiring Licenses
 AVEVA Enterprise
Licensing FAQs

What is Borrowed Time?

If a node does not or cannot communicate with the Licenses
Server to renew the license, then it will expire after certain
time. This time duration is called borrowed time.
There are two types of licenses: A backend type license and
a client type license. A backend license which is acquired by
our server products have a borrowed time of 14 days. A
client type license which is acquired by our client products
have borrowed time of 20 minutes. This means that if the
node does not or cannot communicate with the license
server to renew the license then it will expire in 14 days or
20 minutes respectively. It will become unusable on the
node and the License Server will automatically release it,
allowing to be acquired by another node.
Give an example for server products.
Window Maker, InTouch Run Time Standalone Window
Viewer, InTouch Web Server, Application Server, IDE,
Historian Server
Give an example for client products
SupvClient OMI, Historian Client, InSight
How does the License System handle network outages?
When a license is acquired, a 'borrowed time' counter starts
counting down. This 'borrowed time' is periodically reset by
product refreshing their licenses on a periodic bases with
the License Server.
26 AVEVA Enterprise Licensing FAQs

For most company SCADA networks, the licensed nodes

will be in permanent contact with the License Server over
the SCADA network. However, sometimes the network
may be down or disconnected for some time.
When a disconnect occurs, the product software that
acquired the license stops running after the borrowed time
is exceeded. The acquired license is then automatically
released by the License Server making it available for use.

For additional questions or problems;

See the “Troubleshooting” section of AVEVA Enterprise
Licensing online help.
 AVEVA Group plc
High Cross
Madingley Road
Cambridge
CB3 OHB. UK
https://sw.aveva.com/

October, 2018
Part Number