Aveva Licensing System

AVEVA Licensing System

Disclaimer

1.1 AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or free fromviruses.

1.2 AVEVA shall not be liable for: loss of profits; loss of business; depletion of goodwill and/or similar losses; loss ofanticipated savings; loss of goods; loss of contract; loss of use; loss or corruption of data or information; anyspecial, indirect, consequential or pure economic loss, costs, damages, charges or expenses which may besuffered by the user, including any loss suffered by the user resulting from the inaccuracy or invalidity of any datacreated by the AVEVA software, irrespective of whether such losses are suffered directly or indirectly, or arise incontract, tort (including negligence) or otherwise.

1.3 AVEVA's total liability in contract, tort (including negligence), or otherwise, arising in connection with theperformance of the AVEVA software shall be limited to 100% of the licence fees paid in the year in which the user'sclaim is brought.

1.4 Clauses 1.1 to 1.3 shall apply to the fullest extent permissible at law.

1.5 In the event of any conflict between the above clauses and the analogous clauses in the software licence underwhich the AVEVA software was purchased, the clauses in the software licence shall take precedence.

Copyright

Copyright and all other intellectual property rights in this manual and the associated software, and every part of it(including source code, object code, any data contained in it, the manual and any other documentation suppliedwith it) belongs to, or is validly licensed by, AVEVA Solutions Limited or its subsidiaries.

All rights are reserved to AVEVA Solutions Limited and its subsidiaries. The information contained in this documentis commercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or transmitted withoutthe prior written permission of AVEVA Solutions Limited. Where such permission is granted, it expressly requiresthat this copyright notice, and the above disclaimer, is prominently displayed at the beginning of every copy that ismade.

The manual and associated documentation may not be adapted, reproduced, or copied, in any material orelectronic form, without the prior written permission of AVEVA Solutions Limited. The user may not reverseengineer, decompile, copy, or adapt the software. Neither the whole, nor part of the software described in thispublication may be incorporated into any third-party software, product, machine, or system without the prior writtenpermission of AVEVA Solutions Limited, save as permitted by law. Any such unauthorised action is strictlyprohibited, and may give rise to civil liabilities and criminal prosecution.

The AVEVA software described in this guide is to be installed and operated strictly in accordance with the termsand conditions of the respective software licences, and in accordance with the relevant User Documentation.Unauthorised or unlicensed use of the software is strictly prohibited.

Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved. AVEVA shall notbe liable for any breach or infringement of a third party's intellectual property rights where such breach results froma user's modification of the AVEVA software or associated documentation.

AVEVA Solutions Limited, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom.

Trademark

AVEVA and Tribon are registered trademarks of AVEVA Solutions Limited or its subsidiaries. Unauthorised use ofthe AVEVA or Tribon trademarks is strictly forbidden.

AVEVA AVEVA Solutions Limited or itssubsidia

The cop product or software, its name orlogo be

Copyrig gistered trademarks of SafeNet,Inc. All trademarks of their respectivemanufa

AVEVA Solutions Limited

product/software names are trademarks or registered trademarks of ries, registered in the UK, Europe and other countries (worldwide).

yright, trademark rights, or other intellectual property rights in any other longs to its respective owner.

ht 2012, SafeNet, Inc. All rights reserved. SafeNet® and Sentinel® are re other product names referenced herein are trademarks or registered
cturers.

Revision Sheet

Date Version Comments / Remarks




Contents Page



Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1

Client Configuration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1

How License Server Details Are Configured . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1

Update a Workstation already Configured with AVEVA FlexMan Licensing . . 2:2

Configure a Workstation using the AVEVA Licensing System Client Configura-tion Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2

Server Administration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1

Install the AVEVA Licensing System on a Clean Host . . . . . . . . . . . . . . . . . . . . 3:1Install the License File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1

Choose and Set the Server Port Numbers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1

Console Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1

Query/Configure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1

Start/Stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:3

Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:3

Group Reservations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1

Reservation File Characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1

Creating the Reservation File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:2

Three Redundant License Servers . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1

Setting up the Redundant License Managers . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1

2013i© Copyright 1974 to current year.AVEVA Solutions Limited and its subsidaries. All rights reserved.


Configuration and installation of the Three Redundant Server License File . . 6:2

RULES SERVER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1

RULES System and Port Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1

RULES Client Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1

Frequently Asked Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:1

2013ii© Copyright 1974 to current year.AVEVA Solutions Limited and its subsidaries. All rights reserved.


Introduction

1 Introduction

The AVEVA Licensing System (ALS) uses Dual License Server technology (DLS) thatconsists of two individual license servers based on different proprietary technologies:

1. A Rights Management System (RMS) license server provided by SafeNet that serveslicenses for newer products (e.g. E3D).

2. A Flex license server provided by Flexera that serves licenses to older products (e.g.PDMS).

The RMS and Flex license servers work in a cooperative manner that effectively allows thedelivery of licenses from a single "pool" of licenses. This means that different applicationsthat are licensed with the different technologies are able to share those license features.This is of particular benefit when customers use different versions of the same application,some of which are licensed with RMS, and some that are licensed with Flex.

This benefits customers by allowing them to license their products without having topurchase duplicate sets of licenses for each license server.

The following diagram shows a typical ALS configuration using the default license serverports:

20131:1© Copyright 1974 to current year.AVEVA Solutions Limited and its subsidaries. All rights reserved.


Introduction

The ALS consists of the following components:

The user will also notice that there are two ports configured in the ALS: one port is used bythe RMS License Server and one by the Flex License Server. The use of two ports isrequired because it is not possible for the two license servers to share the same port.

Dual License Server Operation

The ALS uses Dual License Server technology to allow applications that use the differentRMS and Flex licensing technologies to share license entitlement. This has been achievedby configuring the Flex License Server so that it notifies the RMS License Server withdetails of the licensing activities of the Flex-enabled applications as and when they occur.

The RMS License Server effectively "controls" the Flex License Server and its clients byallowing or disallowing Flex license check-out and check-in operations based on thelicenses present in the RMS license file.

Log Files

The contents of the RMS Usage Log file and the Flex Debug Log file do reflect theoperations of the RMS and Flex clients.

Important: The DLS functionality means that the RMS Usage Log also contains the detailsof the Flex licensing operations.

ALS Windows Services

Both of the ALS license servers are configured to run as Windows Services. The two licenseservers can be identified by the following names in the Windows Services panel as follows:

RMS License Server: Services license requests from RMS-enabled applications.

RMS License File: Contains the licenses that can be served by the RMS LicenseServer.

Usage Log: A log file written by the RMS License Server that containsdetails of license check-out and check-in operationsperformed by RMS-enabled applications.

Flex License Server: Services license requests from Flex-enabled applications.

Flex License File: Contains the licenses that can be served by the Flex LicenseServer.

Debug Log: A log file written by the Flex License Server that containsdetails of license check-out and check-in operationsperformed by Flex-enabled applications.

RMS License Server: "Sentinel RMS License Manager_AVEVA"

Flex License Server: "AVEVA DLS Flex Server"



Introduction

Server Administration Tool

Previously AVEVA license server software has been managed using the proprietary toolssupplied by the licensing software vendors (typically Flexera). The ALS now consists of twodifferent licensing technologies and so there is no single toolset that will adequately managethe ALS as a single unified system.

Further complexities also arise because of the need for two separate license files: in orderfor the ALS to function correctly the RMS and Flex license files must be aligned with thesame license entitlement otherwise denial of service can occur.

To make sure that the ALS can be correctly and easily administered a Server AdministrationTool has been provided that grants easy access to the administrative tasks most customersare likely to undertake and presents the two underlying licensing systems in a unifiedfashion. The tool is called the AVEVA License System Console and it provides easy accessto the following functionality:

• Starting/Stopping the ALS

• ALS Server Status Query

• License File Installation

• Server Port Configuration

Client Configuration Tool

The Client Configuration Tool has been provided to enable client PC's to be easilyconfigured with details of up to three license servers.

Note: The ALS has been specifically designed so that existing FlexMan clients do not needto be reconfigured if the ALS Server is installed using the detail port settings.



Introduction




2 Client Configuration Tool

The AVEVA Licensing Client Configuration Tool is used to configure a workstation so thatlicensed applications can locate up to three license servers where they can obtain thelicenses required to function.

The Client Configuration Tool also allows configuration of a network timeout setting that canbe used to tune performance on networks that offer intermittent connectivity to a licenseserver. For example, a license server is located on a remote site.

The Client Configuration Tool will usually only need to be used once when installing the firstAVEVA application, however it may be necessary to run it again if the license serverconfiguration changes.

Important: Before attempting to configure a workstation the user must be in possession ofthe hostname and port number of each license server that is intend for use. Ifthe user does not have this information, contact the organisation's systemadministrator or IT department.

2.1 How License Server Details Are ConfiguredLicense servers are identified by a hostname and a port number and this information mustbe configured so that the users applications can function. The system administrator shouldbe able to advise the user of the correct hostnames and port numbers of license servers.

The license server configuration for a workstation is set using the environment variableAVEVA_LICENSE_SERVER_LIST. An environment variable is used as it permits users toconfigure applications to use different license servers by overriding the default workstationsetting in a batch file.

License server host details are configured in the following format:

<port>@<hostname>

Where <port> is the port number used by the license server and <hostname> is thehostname or IP address of the host on which the license server runs. A typical entry wouldlook like this:

4545@licserver

Multiple license servers can be configured by separating the details of each license serverhost with a semi-colon character (';'):

<port1>@<hostname1>;<port2>@<hostname2>;<port3>@<hostname3>

A typical multiple server entry would look like this:

4545@licserver1;4545@licserver2;4545@licserver3




2.2 Update a Workstation already Configured with AVEVA FlexMan LicensingIf a workstation is already configured to use FlexMan licensing then the user will not need toreconfigure it if:

1. The new license server is installed on the same host as the original FlexMan licenseserver.

and:

2. The new license server is configured to use the default port number of 4545.

Applications that support the AVEVA Licensing System will automatically detect and useFlexMan license server settings if the workstation has not been configured to use theAVEVA Licensing System.

2.3 Configure a Workstation using the AVEVA Licensing System Client Configuration ToolAlthough the license server configuration can be set manually the ALS Client ConfigurationTool has been provided to make the task easier. Below is a screenshot of the tool:

The tool allows the configuration of the license server and timeout for the currently logged inWindows user (via the User Environment settings) or for all users on the workstation (via theSystem Environment settings).

The FlexManConfig button will launch the FlexManConfig client configuration tool so thatthe workstation can be configured so applications licensed with FlexMan can be used.




3 Server Administration Tool

If the user is unfamiliar with the AVEVA Licensing System (ALS) refer to Introduction as itprovides an explanation of the ALS and how it works.

The ALS consists of two separate license servers that run cooperatively. Due to thecomplexity of configuring the two separate license servers so that they can operate togethera dedicated utility has been provided called the ALS Console.

The ALS Console is an easy-to-use GUI that can be used to perform tasks such as licensefile installation and stopping and starting the license system.

While it is possible to manually configure the ALS by directly editing configuration filesAVEVA strongly recommends that only the ALS Console is used to administer the ALS.

3.1 Install the AVEVA Licensing System on a Clean HostInstalling the ALS Server package is straightforward: the only installation option that can bechanged is the installation directory. Once the server package has been installed it is onlynecessary to do the following:

1. Install the license file.

2. Configure the server port numbers used by the RMS and Flex license servers.

3. Optionally configure the workstations.

The following sections provide guidance about how to perform these tasks.

3.1.1 Install the License File

The ALS license file consists of three parts that must be installed using the ALS Console.The ALS Console will automatically shutdown the license servers, install the RMS and Flexlicense files, and then restart the servers automatically.

3.1.2 Choose and Set the Server Port Numbers

After the ALS has been installed it is configured to use the following default ports:

RMS Server: Port 4545

Flex Server: Port 744




AVEVA recommends that the default ports are used if possible. If the user does not want touse the default ports then they can be changed as follows:

If AVEVA applications have previously been installed it is highly recommended that the useruses the same port numbers configured in the workstations that run the AVEVAapplications. To find out these port numbers implement the following:

• For workstations running AVEVA applications that are licensed with the ALS run theALSconfig.exe tool.

• For workstations running older applications that are licensed with the FlexManlicensing system run the FlexManConfig.exe tool.

When the license server port numbers have been set, the workstations that run theapplications need to be configured so that they can locate the license servers. To do this runeither ALSconfig.exe or FlexManConfig.exe depending on whether the applications arelicensed with ALS or FlexMan.

Important: If the workstations are already configured with settings for a FlexMan licenseserver the user can avoid the need to reconfigure the workstations if they do thefollowing:1. Install the ALS on the same host as the old FlexMan server (which must beuninstalled first).2. Use the default RMS port number 4545.

New applications that are licensed with ALS RMS will automatically use the older FlexMansettings if no ALS settings are configured. In these circumstances applications will attemptto communicate with an ALS RMS server on port 4545 on the same host as the configuredFlexMan server host. For example, if the user has an existing FlexMan server on a hostcalled "myhost" and the workstations are configured with the FlexMan setting"744@myhost" the user can install the ALS server on myhost, set the RMS server port to4545 and then install the ALS-enabled applications on the workstations without the need toreconfigure them.

RMS Server: a new port number can be entered via the "Edit Configuration" dialogaccessible via the Query/Configure tab.

Flex Server: a new port can be specified by editing the last field on "SERVER" linein the Flex license file. An editor (notepad) can be started by clickingView License File on the Licenses tab).



Console Tool

4 Console Tool

The Console Tool consists of three tabs, each tab presents a different area of functionality:

• Query/Configure: query the server status, view log files, edit license serverconfiguration.

• Start/Stop: start and stop the license servers.

• Licenses: install license files and product entitlement, view individual license files.

4.1 Query/ConfigureThe Query/Configure tab displays the following window:

Query Licensing System

Upon clicking Query Servers the status bars are updated to show the current status of eachlicense server, whether a server is running, down, or not installed.

Note: The status boxes are not updated dynamically and so users should update the statusby clicking Query Server when appropriate.



Console Tool

View Log

1. Use the radio buttons to select the license server log file required to view, then clickView Server Log: a new window is displayed listing the contents of the license serverlog file.

2. If RMS is selected then an additional window before the log file is displayed that allowsthe user to choose whether to view the default anonymised log or view a de-anonymised log file that displays the proper user, host, and display names.

Configure Licensing System

1. Use the radio button to select either RMS or Flex and click Edit Configuration.

2. If RMS is selected the following window is displayed:

• Server and License File Location: displays the path of the RMS license server andlicense file. This setting cannot be changed.

• License Server Port: allows the RMS server port to edited.

• Log File: Allows the usage log file name and directory to be configured. Note that theusage log file name cannot contain three or more continuous underscores.



Console Tool

3. If Flex is selected in the radio button the Flex configuration file(%AVEVA_LICENSING%\FlexMan\cadcentre.opt) will be opened in Notepad. The usercan then edit the file and save it as appropriate.

Note:

• No validation is carried out if the user has changed the Flex configuration file.

• The changes in the RMS log file configuration would only be visible once the system isrebooted.

4.2 Start/StopThe Start/Stop tab allows the user to start or stop the license servers. The window belowthe button shows the results of the commands that are used to start or stop the servers sothat any errors can be seen.

Note: It is not possible to stop or start just one license server.

Start Licensing System

Starts the RMS license server and the Flex license server.

Stop Licensing System

Stops the RMS license server and the Flex license server.

4.3 LicensesThe Licenses tab displays the following window:



Console Tool

View License File

Use the radio button to select the license file to view and then click View License File todisplay the appropriate license file.

Install License

1. Browse to locate the license file

2. Click Install New License File(s)

3. Click Start License File Installation

4. Click Yes in the Warning message window

The licenses in the license files are installed and the license servers are restarted and asuccessful message is displayed to the user.



Console Tool

Note: Backups of existing license files will be created.

Note: The check and install of the license file will be written to a Console.log file. This isstored in the default folder C:\AVEVA\AVEVA Licensing System\console.log. If thereare any issues in installing the license file using the ALS console then send theconsole.log to the AVEVA Support Team.

Entitlement/Revoke

Clicking View Entitlement/Revoke opens a new window that allows the user to view thelicenses and products that they have licenses for. The window displays the amount oflicenses available in a chronological graph to make it easy to visualize the licenses.



Console Tool

Operations

1. The product mapping file is located at the following location:

%AVEVA_LICENSING%\ProductMaps

2. The list of products in the product mapping file are listed on the left screen in a treeformat.

3. On expanding the node for a particular product, all the features belonging to thatproduct are listed.

4. On expanding each feature, the list of licenses in that feature are listed. For example inthe above screenshot, the following are the products and features read from theproduct mapping file:

5. Continuing with the above example, Feature1 has two licenses (Lic0 and Lic1). When aspecific feature is selected, the entitlements for that feature are displayed on the rightside of the dialog.

6. The date range on X axis includes all the licenses for that feature (From earliest startdate to latest end date).

7. The horizontal bars are specific to each license.

8. The vertical bars indicate the total entitlements for all the licenses (of that feature) at aparticular date.

Product Features

AVEVA PDMS Design-Platform, Isodraw, PDMS, Desi-Pipefab



Console Tool

Revoking Entitlements

The Revoke process consists of following steps:

1. Select one of the following options available in the View entitlement Screen

• Re-Host Some Licenses

• Re-Host All Licenses

2. Once the user clicks on Re-Host Some License/Re-Host All Licenses the optionsare disabled.

3. If Re-host All Licences is clicked the following window is displayed:

The user needs to check all three check boxes to proceed.

4. If the user chooses Re-host Some Licenses, the following window is displayed.

The user needs to check the two check boxes to proceed.

5. Once the user has confirmed and clicked Next, the ALS console tool performs therevocation of all the licenses.

On successfully revoking the licenses, one of the following two message are displayed.



Console Tool

Re Host All Licenses

Re-Host Some Licenses

The options disabled earlier can be enabled again by clicking on any product or feature onthe left side of the screen.

On successful revocation, the ALS console tool saves the binary data of RevocationCertificate and that of the Permission Ticket in form of an XML file.

The ALS console tool prompts the user to send this file back to AVEVA as proof that thelicenses were indeed revoked.



Console Tool

Note:

• The ASL console tool revokes all the licenses from the machine irrespective of theoption chosen Revoking Entitlements. The only difference will be the in the messagedisplayed.

• The value for Deferred Revocation Days is read from the Private Vendor Info of AVEVA"Meta Data License" which should be available on the license server. In case it is notpresent or the value of Deferred Revocation Days defined in the license is not valid(outside 1-30), a default value of 5 days is used.



Console Tool



Group Reservations

5 Group Reservations

Group reservations are used to restrict the right to run applications for particular users,computers, or groups. Selected users can be allowed to run certain applications or can beprevented from accessing applications. This can be used as an additional security measureand help to balance application usage when the administrator want to prevent users fromrunning applications on heavily loaded computers or file servers.

This feature gives the administrator the ability to exercise local administrative controls byassociating a series of groups with each feature and reserving for each group a certainnumber of license tokens. The license tokens are not specifically reserved and can be usedby anyone.

Note: The group reservations capability is only meaningful with a network LicenseManager. However, it is not supported when the redundant License Manager pool isset up.

5.1 Reservation File CharacteristicsThe reservation file tells how many license tokens are reserved for members of differentgroups. For example, the Sales department could be a group with ten members for which 15license tokens are reserved. The members might be network users or specific computers onthe network. The reservation file might also tell that certain members of the group areexcluded from taking license tokens.

When the License Manager receives a request, it checks whether the user making therequest belongs to a group. If so, and license tokens are available for that group, theLicense Manager will issue the token(s) and decrement the token count on the LicenseManager. Otherwise, requests will be serviced with tokens that have not been reserved andthat are available. Users for whom tokens have been reserved have first call on availabletokens.

The following apply to groups:

• A maximum of 256 groups, each with 1000 members are supported.

• Groups must be mutually exclusive. Different groups for the same feature must nothave common users or computers.

• Group names and member names cannot exceed 64 characters each.

• The number of license tokens reserved for a feature cannot exceed the number ofconcurrent copies specified in the license code for that feature.

• To exclude all members of a group from using license tokens for a feature, specify 0tokens.

• If the number of license tokens reserved is greater than the number of concurrentcopies specified for the feature in the license code, the number of tokens specified inthe license code will be used.



Group Reservations

5.2 Creating the Reservation File1. Start the WlmAdmin tool and select Reservation File from the Edit menu.

2. To make a new reservation file, select New from the File menu or select Open to editan existing reservation file.

3. To add user definitions for license tokens, select Add from the Feature menu. The AddLicense Reservation Wizard is displayed.

4. Click Next. Enter the feature name=XXX, feature version =1.0 and click Next.

Note: Do not populate the Capacity field.

5. Enter a Group name and the number of Tokens to reserve for that group.



Group Reservations

6. After specifying the above details the Wizard prompts the user to specify the membersof the group. Click Add to add a member.

7. Enter the Name of the Member, then select User or Machine and select Included orExcluded to specify whether member is allowed or not allowed to run the application.



Group Reservations

8. Click OK to finish the definition.

9. If required, click Remove All to remove all the members or select a specific memberand then click Remove.

10. Click Finish to return to the main screen, the groups and members are updated on theWLSGRMGR main screen.

11. Once at least one feature has been defined, the user can define another group to usethat feature. To add a new group select Add from the Group menu. Do not add thesame users or computers to different groups using the same feature.

12. Click Save to save the settings, a reservation file 'lsreserv' is created in the Mydocuments folder that is 'C:\Users\Administrator\Documents\SafeNet Sentinel\SentinelRMS Development Kit\Tools'

13. Copy the 'lsreserv' file into the RMS folder that is 'C:\AVEVA\AVEVA LicensingSystem\RMS'.



Group Reservations

13.To save the file directly into the RMS folder 'C:\AVEVA\AVEVA Licensing System\RMS\',click Save As.

Or

If the user copies the reservation 'lsreserv' file to another folder other than RMS folder thenan environment variable needs to be set, that is Variable Name = LSRESERV_AVEVA andValue = The folder path to the lsreserv file. Ex. 'C:\AVEVA\AVEVA LicensingSystem\RMS\Testing\lsreserv'.



Group Reservations

14. Once the environment variable has been set, restart the License Server using theAVEVA License System Console.

15. The number of licenses reserved for the particular feature can now be viewed using theWlmAdmin tool.



Group Reservations

16. If the user runs a RMS secured program, for example AVEVA E3D which has beenreserved and its usage restricted, the following error message is displayed.

17. f the user runs a Flex secured program, for example Hull Design or PDMS 12.0 whichhas been reserved and its usage restricted, the following error message is displayed.



Group Reservations

Sample Reservation file contents:

AVEVA201, 1.0: Test: 1:User1! User2

Feature Name - Aveva201

Feature Version - 1.0

Group Name - Test

No of Seats Reserved - 1

License Reserved for the user - User1

License Not Reserved for the user - User2



Three Redundant License Servers

6 Three Redundant License Servers

To work with the redundant license model, a License Manager pool needs to be set up. Theprimary License Manager in the pool is designated as the leader-the remaining LicenseManagers become followers. As long as the primary License Manager is up, all the tokensremain with the leader License Manager and are not distributed among other LicenseManagers in the pool.

How it works

• A client sends a license request to the primary License Manager

• The primary License Manager establishes a connection with the client and grants thelicense after successful authentication

• When the primary License Manager (leader) goes down, it transfers all the tokens tothe next leader-the follower License Manager having the highest precedence

• The follower License Manager then itself maintains the information and fulfils the newlicense requests seamlessly (as long as licenses are available)

• If the primary License Manager (the old leader) comes up, it reclaims leadership andthe control is transferred back to the primary License Manager.

6.1 Setting up the Redundant License ManagersThe following requirements and recommendations are for system administrators:

1. First, select the computers on which they will reside.




2. Various factors, including network performance, affect this decision. Because theleader must communicate with all other redundant License Managers, the leadershould be in an area of the network with good bandwidth.

3. The system administrator must define at least three redundant License Managers. Ifthe pool is set up with only a single server, the redundant server pool will never beformed.

4. A License Manager can exist only in one license pool.

5. Each computer on which a redundant License Manager resides must have a static,fixed IP address. Therefore, do not use DHCP to dynamically allocate IP addresses forthose computers.

6. Reverse DNS resolution is necessary for the redundant License Manager setup.

7. Make sure to specify the IP addresses in either IPv4 or IPv6 format. A redundant poolcannot have mixed servers (both IPv4 and IPv6). Consequently, a redundant servercan work either in IPv6 or IPv4 mode-as long as the server is running or not removedfrom the redundant pool.

8. After deciding the License Managers for redundant setup, obtain their locking codesand pass them to the AVEVA license administrator.

9. Setting up the redundant License Managers requires access privileges to all thecomputers and areas of the network on which License Managers are to be installed. Ifchanges are made to the redundant license file, those changes will not be transferredto all License Managers in the redundant License Manager pool. Unless network andwrite access to each of the redundant License Manager computers is allowed. If any ofthese computers run Windows, the user must have administrator privileges to makechanges that affect the License Managers on those computers.

10. The License Managers in the redundant License Manager pool must have the sameversion.

11. The License Managers must preferably be running on the same platforms (such as,Windows only).

6.2 Configuration and installation of the Three Redundant Server License File

1. Install the ALS on all the machines of a License Manager pool.

2. Generate locking information file on all the machines by double clicking on the AVEVA-locking.bat file. The bat file can be found in the Aveva\Aveva LicensingSystem\RMS\Tools\ folder.

3. Send all the locking information files to the AVEVA license administrator and specifywhich machines are to be the primary (leader), secondary, and tertiary license serversin the license manager pool.

4. Save the license file received from the license administrator in the primary (leader)server machine.

5. Run the AVEVA License System Console to install the license file on primary (leader)server. This can be found in START > All Programs > AVEVA > Licensing System >AVEVA License System Console.




6. Click Licenses tab.

7. Click Browse and select the license file.

8. Click Install License File.

9. Enter server host names and IP addresses of the system (The IP addresses arepopulated automatically but should be double-checked as some hosts can havemultiple IP addresses).

Note: Server details should be entered in the same order as you requested the license file(refer to 3.) that is leader first and followed by secondary and tertiary server details.

10. Click Continue.

11. Click Start License File Installation in the install Aveva license file window.

12. Click Yes in the confirmation window.

The license file installation status success/failure is displayed in the install Aveva licensefile window.




Note: The checks and installation details of the license file are written to a Console.log fileand it is stored in the default folder (C:\AVEVA\AVEVA Licensing System\). If there isa failure in the license file installation then send the console.log file to the AVEVAlicense administrator or AVEVA support engineer.

13. Save the license file received from the license administrator in the secondary servermachine.

14. Open the license file in the notepad or notepad++ and find the string 'VENDORcadcentre'

15. Enter the HOSTNAME of the secondary server in the server line (SERVERHOSTNAME ANY 744) and save the file. By default, it will be the primary serverhostname.

16. Follow the above procedure (from 5. to 15.) to install the license file on the secondaryserver.

17. Save the license file received from the license administrator in the tertiary servermachine.

18. Open the license file in the notepad or notepad++ and find the string 'VENDORcadcentre'

19. Enter the HOSTNAME of the tertiary server in the server line (SERVER HOSTNAMEANY 744) and save the file. By default, it will be the primary server hostname.

20. Follow the above procedure (from point 5. to point 15.) to install the license file on thetertiary server.



RULES SERVER

7 RULES SERVER

The RULES system provides support for a new AVEVA licensing model called "Named UserLicensing". The Named User Model (NUM) differs from the floating license model currentlyused by AVEVA in three major aspects:

• Licenses are restricted to a specific number of named users.

• Licenses are locked to a specific user for 30 days from "first use".

• Locked licenses can be used by a user on a limited number of devices.

In effect, this is a form of reserved user licensing, hence the acronym: RULES - ReservedUser Licensing Enforcement System. The RULES system is only available with the AVEVAInsight product at the moment and so users of other products are not affected by the RULESsystem and can ignore any RULES-related issues.

The RULES system introduces the following new components to the ALS:

• A new server, AVEVA_RULES_Server.exe. This server must be running in order forRULES-enabled applications to function.

• A new ALS Console application: support for starting and stopping the RULES serverhas been added to the core functions, as well as the ability to view the RULES serverlog file.

• A new directory, %AVEVA_LICENSING%\RULES, that contains applications and filesthat support the RULES functionality.

7.1 RULES System and Port ConfigurationThe operation of RULES is fully automatic and no configuration is required by the user.RULES obtains its operating parameters directly from the RMS license system and so thereare no additional duties for an administrator other than opening a port for the RULES serveron the system firewall.

The RULES server uses its own port to communicate with RULES applications (for example: AVEVA Insight). The port number is derived from the RMS server port number and cannotbe explicitly set, thus: the RULES server will use the next highest port after the RMS serverport (as defined by the LSPORT_AVEVA environment variable). For example, if the RMSserver is configured to use port 4545, then the RULES server will automatically use port4546.

7.2 RULES Client ConfigurationRULES clients automatically determine the RULES server port number by using the samecalculation as the RULES server, that is they will use the configured RMS server portnumber plus 1.



RULES SERVER

For example, if a client is configured with a server setting of 123@myServer, then theRULES client attempts to communicate with a RULES server on port 124 on servermyServer .If the ALS client is already configured to the RMS server port then there is noneed to change the client settings.

Example: In ALS client configuration tool, the administrator needs to mention the RMSserver port (by default 4545) and license server name, that is 4545@servername. TheRULES client then automatically talks to RULES server on port 4546.



Frequently Asked Questions

8 Frequently Asked Questions

1. What should I do if the error "AVEVA Installation Error, Exiting!" is displayed?

When running the AVEVA License System Console for first time, the following error - AVEVAInstallation Error, Exiting! is displayed:

This can happen on Windows servers, this is a Windows timing problem, the installer hasset an environment variable but its value has not yet to be populated in the menus, as aresult, two workarounds are available.

Wait for a few minutes and try again or (reboot) machine

Or




Navigate to the environment variable, select 'AVEVA_LICENSING' > Click Edit then clickOK to set it again.

2. How to generate the ALS Server Locking Criteria?

Run the AVEVA-Locking.bat file, this can be found in the path 'C:\AVEVA\AVEVALicensing System\RMS\Tools'. This creates a file called AVEVA-Server-HOSTNAME-info.txt.

Email this file back to the AVEVA License Administrator along with the server productrequirements.

The license administrator will in turn return a license file for that server.

3. What should I do if AVEVA-Server-name-info.txt file does NOT have a UUID?

When running the AVEVA-locking.bat file the AVEVA-Server-name-info.txt file does NOThave a UUID listed. See the following example:

Sentinel RMS Development Kit 8.5.3.0020 Host Locking Code Information Utility Copyright(C) 2012 SafeNet, Inc.

IP address : 192.168.200.56

Disk ID : 0xCD341ADF




This sometimes happens on Windows 2003 servers if the ALS system has been installedand the system has NOT been re-started.

If the server is restarted, then run the AVEVA-locking.bat file a UUID value is returned. AUUID value is required in order to obtain a license from AVEVA that will work.

4. What should I do if AVEVA-Server-name-info.txt file does NOT have an Ethernet address?

When running the AVEVA-locking.bat file the AVEVA-Server-name-info.txt file does NOThave an Ethernet address listed. See the following example:


In the registry the first network card listed has a blank in it, or is a network card that RMSdoes not use, for example a Phone card/mini network card. When this happens instead oflooking for the next entry echoid/wechoid stops and returns a blank. To fix this problem whatthe user must do is carefully edit the registry and move the first network card entry to thebottom of the list, thus enabling the echoid/wechoid programs to pick up a valid Ethernetaddress and list it.

Open the machine registry and navigate to:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\WindowsNT\CurrentVersion\NetworkCards

The following example shows a blank entry:-

Host name : UKCAMD3903

Ethernet address[1] : 18-A9-05-C2-37-21

Hard Disk Serial[1] : 9VMC5AEK

CPU Info String : GenuineIntel Intel(R) Core(TM) i7 CPU Q 740 @ 1.73GHz6 14 5

UUID : (This is returned Blank No UUID listed)

IP address : 192.168.200.56



Ethernet address[1] : (This is returned Blank No Ethernet address)



UUID : BD5E286E-30D0-11DF-BBDA-05C2372118A9




To move the blank or problem network card to the bottom of the list, rename the number to ahigher network card number than the last one in the list.

In this example, it is renamed to 91 but it could have been 12.

Once the entry has been changed, the list refreshed, the registry closed and the AVEVA-locking.bat file, the AVEVA-Server-name-info.txt file output contained an Ethernetaddress listed. See the following example:

Sentinel RMS Development Kit 8.5.3.0020 Host Locking Code Information Utility




Copyright (C) 2012 SafeNet, Inc.

Now a license file can be requested using that Ethernet address.

Note: If the license file is requested with that network card active, when the returnedlicense.xml file is to be installed, it MUST be installed with that same network cardactive.

5. What should I do if I get the error 'locking-code mismatch' during the license file installation?

If a Locking-code mismatch occurs when installing a license file for the first time. Acustomer's license can be locked to many criteria, and only the license administrator caninform the user of the criteria.

6. Where is the composite locking criteria code in ALS license file?

The first set of lines in the license.xml file starting with 14 all have the same locking codestarting with *.

The following example code is after NON-REDUNDANT text.

14 PACK_ERM-CS 1.0 LONG NORMAL NETWORK AGGR 1_KEYS INFINITE_KEYS 23APR 2013 1 OCT 2013 APP_SHR:254 SLM_CODE 2_LOG_ENCRYPTION_LEVELNON_COMMUTER NO_GRACE NO_OVERDRAFT FLOAT NON_REDUNDANT*15QL6UFV6WTR5FW2014,Ni NiL Ni NO_HLD NiL 5_MINSC=APPM,APIE,APWPIan.Ashmeade-UKCAMD3903;6lQqCfteOYd2vVPyCe2Kf0e2XjaPRfZm4izHr1kSoHVTkcKfBLARzGE6NtXcc6AyV:nymP2yMrB0vDAXd:cxkefd

In this example it is *15QL6UFV6WTR5FW2014

IP address : 192.168.200.56










7. How can I check the machine is in the same state as the license code?

Run the program: C:\AVEVA\AVEVA Licensing System\RMS\wechoid.exe

Click to select the Disk ID, Ethernet Address, and UUID checkboxes.

In this example the Code plus the Selector Values added together make the locking code inthe license.xml file as above.

Locking code = *15QL6UFV6WTR5FW plus the last part of the selector 0x2014 =*15QL6UFV6WTR5FW2014

8. How to check that the output from echoid.exe is the same as from running wechoid.exe?

Run the C:\AVEVA\AVEVA Licensing System\RMS\Tools\AVEVA-locking.bat file.

Check that the output from echoid.exe is the same as from running wechoid.exe.

The output from echoid (Disk ID, Ethernet address[1], and UUID) are same as output fromwechoid.exe above.





If different values are obtained, at the time as installing the license then there may be aproblem, contact Support/License development.

If locking errors still occur, send the following information to the AVEVA LicenseAdministrator.

The License file, The AVEVA-Server-UKCAMD3903-info.txt file, the screen shot of runningwechoid.exe as shown above.

9. What should I do if I get the error 'locking code mismatch' during the license file installation even though I specified the correct values?

This usually happens on laptop installs, the license server state has changed sincerequesting the license servers locking criteria, and now when attempting to start the licenseserver.

For example when running the AVEVA-Locking.bat file, the laptop was using the LANnetwork card, and now when attempting to start the license server the laptop is using thewireless network adaptor.

For example the following are the contents of a AVEVA-Server-info.txt file when a server isconnected over the LAN with wireless network card disabled.

IP address : 10.0.150.17

Disk ID : 0x884BA25A




CPU Info String : GenuineIntel Intel(R) Xeon(R) CPU W3520 @ 2.67GHz 610 5





Same machine with Wireless network active (see two Ethernet addresses now):

Locking Code 1 [1]: 381E-*15S SFAW CGQ8 XADQ

-------------------------------------------------------------------

Ethernet address [2]: 2C-41-38-08-01-9F

Hard Disk Serial [1]: J3360081G1KVBC

Two workarounds are available:

Place the license server into the same state (as when the .bat file was run when the licensewas requested), then run the license.

Note: Once the license file has been installed it will then work which ever network card isbeing used, so long as the original card is active /enabled.

Run the (.bat file) again and request a new license file with the new [1] locking criteria, onceobtained install it, without changing the server state.

10. How do I specify all TCP and UDP ports for ALS through a firewall?

Flex server ports can be set via the ALS console > Flex - Edit configuration in anyALS1.1.1 version and later versions.

IP address : 10.0.101.38

Disk ID : 0x8771CA45

Host name : UKCAML4161

Ethernet address [1] : 2C-41-38-08-01-9F

Hard Disk Serial [1] : J3360081G1KVBC

CPU Info String : GenuineIntel Intel(R) Core(TM) i5-2540M CPU @2.60GHz 6 10 7

UUID : 008E337B-321F-11E1-9716-6CC25F06A060

IP address : 10.0.101.38

Disk ID : 0x8771CA45

Host name : UKCAML4161

Ethernet address [1] : AC-81-12-97-F1-1C

Hard Disk Serial [1] : J3360081G1KVBC

CPU Info String : GenuineIntel Intel(R) Core(TM) i5-2540M CPU @2.60GHz 6 10 7

UUID : 008E337B-321F-11E1-9716-6CC25F06A060




RMS server port can be set via the ALS console > RMS - Edit configuration in any ALSversion.

First the ALS is a dual license system and by default the RMS part uses UDP port 4545 andonly uses that single port.

The lmgrd.exe Flex part of the ALS uses by default the TCP port of 744 and thecadcentre.exe part uses a random TCP port which can change on startup if the port is notspecified in the Flex/licenses.lic file on the VENDOR line.

To specify the cadcentre.exe TCP port to a specific number, (this must be done at the everytime a .xml license has been installed into the ALS server). After the license file (.xml) filehas been installed navigate to the Flex folder by default it will be C:\AVEVA\AVEVALicensing System\Flex.

Edit the file licenses.lic and change the VENDOR line from:




VENDOR cadcentre

to

VENDOR cadcentre port=745

Then using the AVEVA License system console, stop and restart the license server, thenview the Flex Server log file, lines in the server debug.log file can be found similar to theones below:-

14:39:13 (lmgrd) lmgrd tcp-port 744

14:39:13 (lmgrd) Starting vendor daemons ...

14:39:13 (lmgrd) Starting vendor daemon at port 745

14:39:13 (lmgrd) Using vendor daemon port 745 specified in licensefile

11. How can I see users accessing my ALS/RMS license server?

All the products usage for old Flex secured products or new RMS secured products aredisplayed in the RMS server.

Access via a GUI using the WlmAdmin tool, by default the tool looks at all the STD RMSservers through the default RMS port of 5093. (AVEVA's default RMS port is 4545).

To verify the feature details:

1. Select Edit > Preferences and enter the server port as 4545, then click to select theSave these preferences check box.

2. Close and start the WlmAdmin tool.

3. Expand the Subnet servers and find the required server name.




4. Click the license feature.

5. If the server is not listed under subnet servers then select edit > defined server list.

6. Enter the server name, then click Add then OK.




12. What should I do if FLEXlm lmstat-a does not show new RMS secured products usage?

FLEXlm lmstat-a does not show new RMS secured products usage. All the products usagefor old Flex secured products and new RMS secured products are shown in the RMS server.It is the RMS server which controls products usage NOT Flex.

Flex/Lmstat -a will only show clients accessing FlexLM secured products.

To see ALL the AVEVA products usage, use the GUI WlmAdmin tool that is supplied withALS.

Or

Use the lsmon.exe to view the details of all the usage. It can be found in the pathC:\aveva\AVEVA Licensing System\RMS\Tools folder called lsmon.exe

Create a .bat file in the same folder with the following lines in it: -

Change the yourservername to your server name and run the .bat file, it will create a filecalled license-used.txt with a snapshot of the keys in the license file and the clientsaccessing them.

13. How do I perform a silent installation of the ALS Client configuration Tool?

To silently roll out the ALS Client configuration tool to all the users:

The ALS installer .msi can be run by command line to silently install the whole product byusing the command which is supplied along with a silent-30363(release number).bat file ifthe ALS release is on a DVD release.

The bat file basically run msiexec where output is written to the value of %logfilename%which is set to,

set mndate=%DATE:/=-%

set mntime=%TIME::=-%

set logfilename=C:\AVEVA\sinstallog\30363-AVEVA Licensing 1.0-%mndate%-%mntime%.log

Then msiexec is run to install ALL ALS writing the output to the logfilename.

Example:

msiexec /i "ALS103\Licensing1.03.msi" /qn REBOOT="ReallySupress" /l*e "%logfilename%" /passive ADDLOCAL=ALL

Now to install the Client change ADDLOCAL=ALL to ADDLOCAL=CLI,CLIHLP. If they donot want the Client Help files then it can be reduced to ADDLOCAL=CLI

Example:

msiexec /i "ALS103\Licensing1.03.msi" /qn REBOOT="ReallySupress" /l*e "%logfilename%" /passive ADDLOCAL=CLI

14. What should I do if I get Error [18] when I run the RMS license secured products (ex. Aveva E3D)?

When running any product for the first time,the following error message is displayed:

cd c:\aveva\AVEVA Licensing system\RMS\Tools lsmon.exeyourservername>license-used.txt




There could be several reasons for this.

• This could mean that the Specific license key that the product is trying to use is NOTinstalled in the RMS license server which is running. A common reason is runningAVEVA ADMIN with a license file with just an AVEVA E3D seat and not one withAVEVA ADMIN

• This could also be due to the new license file being linked to either the wrong lockingcriteria or there has been a mistake copying and pasting

• The license file in the server has not been installed yet

Download and run the .bat file as documented in aareadme.txt file located in theServerInfo.zip located on the AVEVA Support site.

Send that (AVEVA-Server-info.txt), along with the license.xml file back to theAdministrator who issued the license, with a screen shot of the product/version thatproduces the error.

15. Why I am getting Error 8 in the Flex license secured products?

If a new Flex 6 licenses.lic part from an installed AVEVA Licensing System server is placedinto an old Flexman5.2 server then following error message is displayed. The example isfrom a PDMS application.

16. Why I am getting Error -21 in the Flex license secured products?

If an old Flex 5 license file is placed into the Flex part of the AVEVA Licensing System serverthen following error message is displayed. This following example is from running a PDMSapplication.




17. What should I do if get the error 'Aborting Installation' when I try to install the license file?

If all the Flex license keys have expired on a license server, the Cadcentre.exe processdies but the lmgrd.exe process is still running.

So when an attempt to install a new license file on that server occurs, the AVEVA licenseSystem Console thinks that the servers are down, but in fact the Flex server/service is stillrunning. When this happens following error is displayed.

To overcome this error the Flex service (lmgrd.exe) programs must be stopped, this can bedone by stopping the lmgrd.exe (Aveva DLS Flex service) processes. Once the service isstopped the new license can be installed.

18. What should I do if I get the error 'Permission Problem' when try to set the port@hostname in the ALS client config tool?

When setting up a client to use an AVEVA licensing server, the following error is displayedwhen running the ASL Client Configuration Tool.




This means that the program needs to be elevated to be run as an administrator.

Select the ALS client config exe, right click > properties ALS Client Configuration Tool.Select the Compatibility tab and set the privilege Level to, Run this program as anadministrator.

19. Having issues in running the products when connected to VPN?

If using a local AVEVA Licensing server and a VPN client, when stopping the VPN client thelicense server stops, or the route to the license server is not restored, and after 8-10minutes the applications give server lost prompts.




The only way to continue is to restart the license server or re-boot the machine. This can befixed if both the RMS and Flex parts of the AVEVA Licensing System are pointed to thelocalhost.

This can be done by editing the Flex licenses.lic file using the ALS console.

Change the SERVER line to read: SERVER localhost ANY 744.




This must be done manually each time a new license is installed.

To use the WlmAdmin tool to check on the license server usage, after using VPN or duringthe use of the VPN software define own (localhost) server.




20. Why I am getting Error [18] and Error (-602) after revoking the licenses?

This error occurs when the products are run five days after revoking part of the licences orall licenses.

When running a RMS secured product (ex. AVEVA E3D) the following error is displayed:

Error[18]: No license code is available for feature UNKNOWN on host localhost.

When running an old FLEX secured product (ex. PDMS) the following error is displayed:

Error (-602) INVALID error code Feature




The license server seems to be up and running but once the file RevokeRequest.xml iscreated and placed in the folder: C:\aveva\AVEVA Licensing System\RMS, any productswill cease to run after five days.

21. How do I know that my server is counting down five days to revoke?

To check the if the server is counting down to revoke, check this in the View Entitlement &Revoke window.

Request a new license file and install it as if the license file has been revoked.




A revoked license server stops serving licenses after five days, if a new license has NOTbeen installed onto that server.

After five days when running Wlmadmin accessing the license server and trying to view anyof the installed license keys, the following error is displayed.

Note: The user is also unable to run any products.

22. List of Error Codes -601 to -610 displayed by the Flex clients

The NEW DLS is not able to convey a meaningful error code back to the Flex basedapplications due to the way that the Flex vendor daemon framework works and the fact thatRMS error codes do not align with Flex error codes.

-601: Unable to create a FLUID.

This indicates a problem with the server system environment or possible a problem with theDLS server implementation.

-602: Can't get RMS feature info.

This indicates that either the RMS server is offline or some other problem with the server.

-603: Feature renewal time is below the allowed minimum.

This indicates that the RMS license has been incorrectly generated.

-604: Unable to set sharing attributes.

This indicates a problem with the RMS server.




-605: Can't set Customer Data field. (HOST USERNAME DISPLAY).

This indicates a problem with the RMS server.

-606: RMS AF Checkout failed.

Either the licenses have been used, the RMS server is down, or some other problem.

-607: RMS PF Checkout failed.

Either the licenses have been used; the RMS server is down, a problem with the way thelicense was generated, or some other problem.

-608: Failed to create map structure.

System problem.

-609: Failed to store map structure.

System problem.

-610: Failed to store map structure.

System problem.



