AVEVA™ Enterprise Licensing version 4.1 Readme

Last revision: 10/25/2024

About this Readme

This document contains important information about AVEVA Enterprise Licensing version 4.1. This Readme documents the system requirements, known issues, resolved issues, and changes, if any, to the AVEVA Enterprise Software documentation included with the AVEVA Enterprise Licensing components

Important: AVEVA Enterprise Licensing platform version 3.7.002 is not compatible with versions 2.0 or earlier. Versions 2.0 and earlier were installed with Recipe Manager Plus 2014 R3 and earlier, Alarm Adviser 2014 R2 SP1 and earlier, and Intelligence 2014 R3 and earlier. Upgrading to AVEVA EnterpriseLicensing platform version 4.1 could interfere with the functionality of those products. To upgrade to version 4.1 when you have versions 2.0 and earlier already installed on your system, you need to apply a hotfix. Contact AVEVA Technical Support to obtain the hotfix, and reference change request L00152975.

You can upgrade to version 4.1 directly from versions 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.5.1, 3.6, 3.7, 3.7.001 3.7.002 and 4.0. Licensing versions earlier than 3.0 require upgrade to version 3.0 before upgrading to version 4.1.

Note: You can find information and procedures for installing and upgrading AVEVA Enterprise Licensing, License Manager, and License Server in the AVEVA Enterprise Licensing Installation online help, available from the installation utility.

Note: When you upgrade to AVEVA Enterprise Licensing 4.1 from an older version, the AVEVA Enterprise License Server Legacy Support checkbox is unselected by default. However, you may select the AVEVA Enterprise License Server Legacy Support checkbox , as it is recommended that all nodes be upgraded to 4.1, unless your nodes have version 4.0 installed.

AVEVA Enterprise Licensing Changes and Enhancements

This section describes the new and enhanced functionality available in AVEVA Enterprise Licensing, providing an overview of the most significant changes, in the following versions:

Version 4.1

This version incorporates the following components and enhancements:

• Support to acquire an alternate license if the previously acquired license had expired.
• Support to notify users with an error message regarding activation of an expired license in offline mode.
• Updated technology related to licensing, including:
  • gRPC components to the latest version.
  • .Net Core to latest version
  • PCS framework to latest version.
  • Shared and third-party components to their latest versions across all licensing components.
• Enhanced License Configurator to run AELicWorkgroup utility in workgroup environments.
• Reduced SDL debt.
• This release includes several bug fixes. For more information, refer to the Resolved Issues of Version 4.1.

Important! There is a backward compatibility issue with historian 2020 and 2023. For more information, refer to the Known Issues of Version 4.1.

Version 4.0.1

This version of AVEVA Enterprise Licensing incorporates several bug fixes.

Version 4.0

This version incorporates the following components and enhancements:

• The Licensing platform can be configured in secure mode using the Platform Common Services (PCS) framework.
• Licenses can be reserved using their part numbers.
• New Legacy Support checkbox option in the License Manager to set product compatibility.
• Licensing Help is now hosted on the AVEVA Help Viewer.
• User interface and user experience enhancements.

Version 3.7.002

This version incorporates redistributable updates.

Version 3.7.001

This version incorporates the following components and enhancements:

• AVEVA Enterprise Licensing 3.7 onwards supports configuring a License Server in Configurator even if it fails to validate
• Support to populate the Trial License duration period and Trial start date in Local License Viewer.
• Support to the domain user to access the License Server.
• Support Part Numbers with asterisk '*' character in the .avevalic file.
• Performance improvements in Checkout operations

AVEVA Enterprise Licensing Installation

Introduction

Installation Requirements

Installation

Upgrading AVEVA Enterprise Licensing

Uninstalling AVEVA Enterprise Licensing

Introduction

The AVEVA Enterprise Licensing system is a common platform that allows you to effectively and efficiently manage AVEVA Enterprise Software product 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.

You can install AVEVA Enterprise Licensing with AVEVA Enterprise products or you can install as a standalone. Different types of installation that you can install as a standalone are:

• Clean Install - License Manager only: installation on a machine with no previous installation of License Manager.
• Clean Install - License Server only: installation on a machine with no previous installation of License Server.
• Clean Install - License Manager and the License Server together: installation on a machine with no previous installation of License Manager or License Server.
• Upgrading AVEVA Enterprise Licensing
  • Installation done on a node that has AVEVA Enterprise License Manager of any version
  • Installation done on a node that has AVEVA Enterprise License Server of any version
  • Installation done on a node that has AVEVA Enterprise Licensing of version greater than or equal to 3.0

Installation Requirements

This section describes the operating system, hardware, and software requirements to install AVEVA Enterprise Licensing.

Supported Operating Systems

Below are the Operating System minimum requirements:

• Client Operating System (x86 and x64):
  • Windows 10 and above
• Server Operating System (x64 only):
  • Windows Server 2016 and above

For more information about supported operating systems, refer to the AVEVA System Platform 2023 R2 Readme.

.NET Requirement

AVEVA Enterprise Licensing requires .NET Framework 4.8. The licensing installation process checks if .NET version 4.8 is installed. If not, you are prompted to allow .NET installation.

Note: A system restart is required when .NET installation is complete. If the licensing installation does not automatically resume after the system restart, you can restart it manually.

Hardware Requirements

Below are the basic hardware requirements to install AVEVA Enterprise Licensing:

• CPU Cores: 4
• RAM: 4 GB

Software Requirements

• A clean installation of License Manager and License Server requires .NET Framework 4.8
• An upgrade Installation of licensing components requires a software product installed that uses licensing.
• To make the licensing secure communication, the Platform Common Services (PCS) framework is required to be installed.

Port List

The following ports are used by default:

• 55555: AVEVA Enterprise License Server Legacy Support port.
• 55559: License Server Core Service Port on the License Server node.
• 59200 / 59201: License Server Agent Port on the License Server node and Product License Service port on the product node.
• 59203: AVEVA Enterprise License Product Service port.
• 80: License Manager port on the License Manager node.
• 443: License Manager Secure port on the License Manager node.

Important:
If you want to change the default ports, be very careful when changing port settings. Doing so may impact product operation. For more information about changing ports, see the "About Changing Default Port Settings" section in the AVEVA Enterprise Licensing Help.

Installation

This section describes the installation steps of AVEVA Enterprise Licensing.

Installing AVEVA Enterprise Licensing

Note: All installed products should be shut down before upgrading. This will release all the licenses so that when the products are re-started licenses will be acquired correctly.

To install the AVEVA Enterprise Licensing standalone

1. Locate and right-click the setup.exe file and then select Run as administrator.

   The License Agreement screen appears.

2. Accept the End User License Agreement and then click Next.
3. Select the components that you want to install:

   

   • Select License Management to install only both the license server and license manager on the same node
   • Select License Server to install the license server on the node.
     • Select AVEVA Enterprise License Server to install the secure license server.
     • Select AVEVA Enterprise License Server Legacy Support to allow support for legacy versions of Licensing on client nodes. If this checkbox is not selected, all client nodes that connect to this License Server would need to be upgraded to 4.1.

     Note: When you upgrade to AVEVA Enterprise Licensing 4.1 from an older version, the AVEVA Enterprise License Server Legacy Support checkbox is unselected by default. However, you may select the AVEVA Enterprise License Server Legacy Support checkbox , as it is recommended that all client nodes be upgraded to 4.1, unless your client nodes have version 4.0 installed. To have only secure communication, once all the client nodes are updated you can uninstall legacy support.

   • Select AVEVA Enterprise License Manager to install the license manager on the node.
   • Select the Product Interface to install the Licensing API components. When upgrading, the Licensing API components that you previously installed with the product are selected automatically and are upgraded.

     If an older version of the Licensing API is not installed, then the Licensing API option will be disabled and will not be selected to install.

   • Select the Operations Control Logger.
   • Select AVEVA Help to install the Product Help Viewer. This is required to access the AVEVA Enterprise Licensing Help.
4. Click Next.

   The Ready to Install the Application screen appears.

5. Click Install to start the installation.

   Once the installation is complete, the Installation successful dialog box appears.

6. Click Finish.
7. Configure the License Server as needed:
   • If you install License Manager only - the Configurator will not appear after installation. You will need to add a license server when you start the License Manager.
   • If you install License Server only - the Configurator will not appear after installation.
   • If you install License Manager and License Server on a clean machine - the Configurator will not appear after installation. The License Manager automatically adds the local installed server by machine name.
   • If you upgrade, the Configurator appears after the installation is complete. Server configuration for the previously installed version of AVEVA Enterprise Licensing will be valid in most cases. Reconfigure the server name, server port, and redundancy as needed.

Installing AVEVA Enterprise Licensing Silently

If you are installing AVEVA Enterprise Licensing to multiple computers, you can run the installation "silently" (command line mode).

Installing AVEVA Enterprise Licensing Silently from the Command Line

1. Open the command prompt (cmd.exe) as Administrator.
2. Change the working directory to the folder where you downloaded AVEVA Enterprise Licensing Setup.exe.
3. Run one of the following commands, depending on whether or not you want the computer to reboot automatically:
   • To automatically restart the node when installation is complete, enter the following command:

     "C:\...\CD-AELicensingPackage\Setup.exe"/silent"C:\Response.txt"

   • If you do not want to automatically restart after installation, use the /Silentnoreboot option:

     "C:\...\CD-AELicensingPackage\Setup.exe" /silentnoreboot "C:\Response.txt"

Note: If you do not require Configurator as a part of Silent Installation, then you can navigate to All.txt file located in CD-AELicensingStandalone\SampleResponseFile and delete the section containing the <Configurator> tags.

Upgrading AVEVA Enterprise Licensing

You can verify the version of License Manager by navigating to Control Panel and selecting Programs and Features. The installed AVEVA Enterprise License Manager, AVEVA Enterprise License Server, or AVEVA Enterprise Licensing (licensing platform components) version displays in the Version column.

Note: Licensing platform components are installed with every product, whether or not a License Manager or a License server are installed on that node. These components display in Programs and Features as "AVEVA Enterprise Licensing" for both 32- and 64-bit systems.

The following table describes different upgrade scenarios of AVEVA Enterprise Licensing to version 4.1. In some upgrade scenarios, licenses will enter the grace period. You can resume normal licensing functionality when the grace period ends. Refer to the AVEVA Enterprise Licensing Help, "Working with the Grace Period" topic for more information.

Note: You can resume normal licensing functionality once the Grace Period is ended. See the AVEVA Enterprise Licensing Guide for the detailed procedure. Since all licenses should be removed from the server prior to ending the Grace Period, no licenses will be lost due to this action.

To upgrade AVEVA Enterprise Licensing

Note: All products should be shut down before upgrading. This will release all the licenses so that when the products are started licenses will be acquired correctly.

1. Right-click the setup.exe file and select Run as administrator.

   An alert message with the list of products that will be upgraded appears.

2. Click OK.

   The License Agreement screen appears.

   Follow the steps from step 2, in the Installing AVEVA Enterprise Licensing section.

Note: After you upgrade to AVEVA Enterprise Licensing 4.1 from an older version, a License Server Migration pop-up appears when you launch the License Manager. Select the Migrate button to ensure that all data is migrated to the latest version.

Uninstalling AVEVA Enterprise Licensing

Note: You cannot uninstall the product licensing if there is a product currently installed or when other products are currently using it.

To uninstall an AVEVA Enterprise Licensing Component

1. Click the Uninstall or Change a Program option in Windows Control Panel. The list of software installed on your computer appears.
2. Select the AVEVA Enterprise Licensing component that you want to uninstall, and then click the Uninstall/Change button. The Modify, Repair or Remove Installation dialog box appears.
3. Click the Remove option, and then click Next. The confirmation dialog box appears.
4. Click Uninstall. The component is uninstalled, and the complete uninstallation dialog box appears.
5. Click Finish.

Modifying AVEVA Enterprise Licensing

You can change the AVEVA Enterprise Licensing components installed on your computer. You can add new components or remove the existing ones. You can modify any component of AVEVA Enterprise Licensing.

Note: You must have the installation media ready before you can modify a program.

To modify an installation

1. Select the Modify option from the AVEVA Enterprise Licensing Modify, Repair or Remove Installation dialog box. You can open the dialog by doing either of the following:
   • Run Setup.exe from the AVEVA Enterprise Licensing installation media.
   • Navigate to Uninstall or Change a Program in the Windows Control Panel. Then, select any AVEVA Enterprise Licensing component and then click the Uninstall/Change button.

     Note: The name of the Uninstall/Change option may vary depending on which Windows operating system is installed on your computer.

2. Click the Modify option, and then click Next. The list of AVEVA Enterprise Licensing components appears.
3. Select or clear the components that you want to add or remove, and then click Next. The verify change dialog box appears.
4. Click Modify. The selected components are added or removed and the complete modification dialog box appears.
5. Click Finish.

   Note: The system may not prompt you to restart the system after Modify is successful. However, if you have added a new product or feature, a system restart is recommended.

Repairing AVEVA Enterprise Licensing

You can repair the installation of any component of the AVEVA Enterprise Licensing. You can repair missing or corrupt files, registry keys or shortcuts. You can also reset the registry key to the default value.

Note: You must have the installation media ready before you repair a program.

To repair an installation

1. Click the Uninstall or Change a Program option in Windows Control Panel. The list of software installed on your computer appears.
2. Select the AVEVA Enterprise Licensing component that you want to repair, and then click the Uninstall/Change button. The Modify Repair or Remove Installation dialog box appears.

   Note: The name of the Uninstall/Change button varies depending on the Windows operating system installed on your computer.

3. Click the Repair option, and then click Next. The Confirm Repair dialog box appears.
4. Click Repair. The complete repair dialog box appears.
5. Click Finish.

Resolved Issues

This section includes corrections for the issues listed in the following table. These issues are listed by their Defect ID (IMS number), any assigned Service Request (SR) or Case Number with a brief description of the defect.

Resolved Issues of Version 4.1

Resolved Issues of Version 4.0.1

Resolved Issues of Version 4.0

Resolved Issues of Version 3.7.002

Known Issues

This section describes known issues in AVEVA Enterprise Licensing.

Known Issues of Version 4.1

Known Issues of Version 4.0.1

Known Issues of Version 4.0

Known Issues of Version 3.7.001

System Requirements

The system requirements for AVEVA Enterprise Licensing components are the same as those for the products you have purchased and installed. See the Readme file and the installation guide associated with your specific product for more information.

Browser Settings- Security

AVEVA Enterprise License Manager is accessed through the browser installed on any computer on your network. License Manager is compatible with the major browsers including Microsoft Internet Explorer, Firefox, and Chrome. Each browser has its own security features and configuration.

For example, using Internet Explorer to access License Manager requires setting the following options:

• Internet Explorer Enhanced Security Configuration should be disabled. Refer to the Internet Explorer documentation for information about how to change this setting.
• The License Manager site must be set as a trusted site.

See the Internet Explorer documentation for information about how to configure trusted sites.

For additional information on browser-based web help and active content, see Web Help Display and Video Playback.

Browser Settings- Animation Display

Browser-specific settings need to be configured to enable animation display within AVEVA Enterprise License Manager. Setting details for each browser are described below.

Internet Explorer

Animation display is not enabled by default for Internet Explorer. To enable animation, do the following:

1. From the browser, select Internet Options.

   The Internet Options dialog box appears.

2. Scroll to the Multimedia options and select Play animations in webpages.

Firefox

Animation display is enabled by default in Firefox. If animated content such as progress meters is not displaying, do the following:

1. Enter about:config into the browser address bar.

   Acknowledge the warning to proceed.

2. Enter image.animation into the search bar.

   The image.animation_mode setting will appear.

3. Set the setting to normal.

Web Help Display and Video Playback

Web Help - Browser-based User Assistance

Web help components have been delivered in this release. Web help displays in the default browser on your local computer. Help displayed in a browser allows more dynamic and searchable user assistance including standard web browser navigation and tutorial videos.

Typically, help content is installed on your local machine as part of the documentation library, and displays in your default browser without requiring an Internet connection. You can invoke the help by right-clicking a context menu item, a symbol, or another UI element, or otherwise invoking help using elements contained in your specific UI.

Browser Permissions for Displaying Web Help

Each browser and Windows operating system combination has its own security permissions. Using Internet Explorer (version 8, 10, or 11) as an example, you may see a dialog requesting you to "Allow blocked content" each time you invoke the web help. This dialog is triggered by the presence in the help system of JavaScript components that control internal navigation and topic display elements such as pop-up or in-place-expanding display blocks that contain text and graphical images. The text and image content is itself non-active.

You can accept each occurrence of this dialog, or you can set the following option in Internet Explorer, depending on your IT security requirements: In Internet Options, click the Advanced tab, then navigate to the Security section. Enable the "Allow active content to run in files on My Computer." Permissions and security settings will vary depending on your specific browser.

Playback of Tutorial Videos

The web help may contain a number of brief tutorial videos. To play these videos:

• You must have Microsoft Media Player installed on your local machine.
• In Windows 2008 and 2012 server operating systems, you must enable the "Desktop Experience" feature using Server Manager.

AVEVA Enterprise Licensing Documentation

The AVEVA Enterprise Licensing documentation includes the following:

• AVEVA Enterprise Licensing Web Help: Online Help hosted on the AVEVA Help Viewer.

  To view the online help content, select the Help icon when the License Manager is active in your browser.

  Alternatively, you can go to the Windows Start menu, select the AVEVA folder, and then select AVEVA Help.

  The web help opens in a browser window.

• AVEVA Enterprise Licensing Guide: User guide containing information on AVEVA Enterprise Licensing in Portable Document File (PDF) format.

  To view PDF files, you need Adobe Reader installed on your computer. You can download the latest version of Adobe Reader from the Adobe Corporation web site:

  http://get.adobe.com/reader/

  After installing Adobe Reader, double-click on a PDF file to view the book with Adobe Reader. You can also open a PDF book with the Adobe Reader Open command from the File menu.

• AVEVA Enterprise Licensing Readme (Release Notes): A single HTML file which opens in your default browser.

  To view the Readme file, double-click the "Readme-Licensing.html" file installed on your computer with the AVEVA Enterprise Licensing components.

• AVEVA Enterprise Licensing Checkout Utility Help: A single HTM file which opens in your default browser.

  To view the Checkout Utility Help file, double-click the "AELicensingCheckoutUtilityHelp.htm" file installed on your computer with the AVEVA Enterprise License API components.