Licensest User Guide: For Mark Controls Platform

Download as pdf or txt
Download as pdf or txt
You are on page 1of 24

GEH-6867

LicenseST User Guide


for Mark* Controls Platform
June 2020

Public Information
These instructions do not purport to cover all details or variations in equipment, nor to provide for every possible
contingency to be met during installation, operation, and maintenance. The information is supplied for informational
purposes only, and GE makes no warranty as to the accuracy of the information included herein. Changes, modifications,
and/or improvements to equipment and specifications are made periodically and these changes may or may not be reflected
herein. It is understood that GE may make changes, modifications, or improvements to the equipment referenced herein or to
the document itself at any time. This document is intended for trained personnel familiar with the GE products referenced
herein.
GE may have patents or pending patent applications covering subject matter in this document. The furnishing of this
document does not provide any license whatsoever to any of these patents.
Public Information – This document contains non-sensitive information approved for public disclosure.
GE provides the following document and the information included therein as is and without warranty of any kind,
expressed or implied, including but not limited to any implied statutory warranty of merchantability or fitness for
particular purpose.
For further assistance or technical information, contact the nearest GE Sales or Service Office, or an authorized GE Sales
Representative.

Issued: June 2020

© 2020 General Electric Company.


___________________________________
* Indicates a trademark of General Electric Company and/or its subsidiaries.
All other trademarks are the property of their respective owners.

We would appreciate your feedback about our documentation.


Please send comments or suggestions to controls.doc@ge.com

Public Information
Acronyms and Abbreviations
DMSS Device Manager Software Suite

GUI Graphical User Interface

VM Virtual Machine

GEH-6867 3
Public Information
Safety Symbol Legend

Indicates a procedure or condition that, if not strictly observed, could result in


personal injury or death.
Warning

Indicates a procedure or condition that, if not strictly observed, could result in damage
to or destruction of equipment.

Caution

Indicates a procedure or condition that should be strictly followed to improve these


applications.

Attention

4 GEH-6867 LicenseST User Guide


Public Information
Contents
1 Overview ............................................................................................................................................. 7
2 Installation.......................................................................................................................................... 9
2.1 Computer Requirements and Recommendations ............................................................................................9
2.2 Required Software ...................................................................................................................................9
2.3 Component Installation on Windows ...........................................................................................................9
2.3.1 Extra Component Installation for VMware® Hosted Windows Machines .....................................................9
2.4 Component Installation on Linux .............................................................................................................. 10
3 LicenseST......................................................................................................................................... 11
3.1 Activation ............................................................................................................................................ 11
3.1.1 Online Activation............................................................................................................................ 11
3.1.2 Offline Activation ........................................................................................................................... 13
3.2 Return a License Activation..................................................................................................................... 13
3.3 Advanced Settings Tab ........................................................................................................................... 14
3.3.1 Query Server for Products................................................................................................................. 14
3.3.2 Submit Problem Report .................................................................................................................... 14
3.3.3 Clean Up License Data..................................................................................................................... 15
3.3.4 Change Logging Settings.................................................................................................................. 15
3.3.5 Change Connection Settings.............................................................................................................. 15
3.3.6 Analyze Current Dongle ................................................................................................................... 16
4 LicenseSTCommandLine ............................................................................................................. 17
4.1 Activation ............................................................................................................................................ 17
4.1.1 Online Activation............................................................................................................................ 17
4.1.2 Offline Activation ........................................................................................................................... 17
4.2 Return a License Activation..................................................................................................................... 17
4.3 Set Connection Settings .......................................................................................................................... 18
4.4 Get Security Dongle Serial Number........................................................................................................... 18
4.5 Show Licensed Products ......................................................................................................................... 18
5 What is the Correct Activation Type? ....................................................................................... 19
Appendix Common Issues ................................................................................................................. 21

GEH-6867 5
Public Information
Notes

6 GEH-6867 LicenseST User Guide


Public Information
1 Overview
LicenseST is an application that allows a user to interact with licensing in ControlST*, Advanced Developer Toolkit,
CIMPLICITY*, and Device Manager.
This document provides the instructions on how to use and interact with LicenseST in both Windows® and Linux®
environments.

Overview GEH-6867 7
Public Information
Notes

8 GEH-6867 LicenseST User Guide


Public Information
2 Installation
2.1 Computer Requirements and Recommendations
The supported Windows Operating Systems are:

• 64-bit Windows 7
• Windows 10
• Windows 2012R2
• Windows Server 2016
• Windows Server 2019
The supported Linux Operating Systems are:

• 64-bit Debian based systems, specifically Ubuntu 18.04, 19.10

2.2 Required Software


Before using LicenseST, the following software dependencies must be installed on the computer:

Note The specified versions are required versions, not minimum versions.

• On Windows:
− VC redist v141 x64
− Dotnet Core runtime V3.1.0 x64
− Windows desktop runtime v3.1.0 x64
• On Linux:
− Dotnet Core runtime v3.1.0 x64

2.3 Component Installation on Windows


Starting with ControlST V07.08.00C, Advanced Developer Toolkit V07.03.00C and Device Manager Software Suite (DMSS)
V02.01.00C, setup.exe installs the necessary dependencies on Windows and then automatically installs LicenseST. If
installing manually, ensure the dependencies are installed and then install LicenseSTWixProduct.msi. The prerequisite files
can be downloaded from https://dotnet.microsoft.com/download/dotnet-core/3.1. Visual Studio can be downloaded from
https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads.

2.3.1 Extra Component Installation for VMware® Hosted Windows


Machines
Any Windows Operating System hosted on VMware needs to install the PowerCLI.

➢ To install the PowerCLI


1. From the Start menu, select the Windows Powershell folder, right-click on the Windows PowerShell app and
select Run As Administrator.
2. Enter the command: Install-Module -Name VMware.PowerCLI

Installation GEH-6867 9
Public Information
2.4 Component Installation on Linux

Note All commands in Linux are to be done from the terminal.

• Ensure that Dotnet Core runtime v3.1.0 x64 has been installed on the machine. This prerequisite can be downloaded from
https://dotnet.microsoft.com/download/dotnet-core/3.1.
• Copy the LicenseSTLinux.tar file into the location where you want to install it.
• If you are upgrading LicenseST, the previous version must be uninstalled.

➢ To uninstall a previous version of LicenseST: execute the following commands:

• cd ./LicenseST
• sudo ./uninstall.sh
• cd ..
• rm -rf ./LicenseST

➢ To install LicenseST: execute the following commands:

• tar -xvf LicenseSTLinux.tar


• cd ./LicenseST
• sudo ./setup.sh

10 GEH-6867 LicenseST User Guide


Public Information
3 LicenseST
LicenseST has a graphical user interface (GUI) that allows a user to activate, return, refresh, or view activated licenses.

Note The LicenseST GUI can only be used in Windows.

➢ To open the LicenseST GUI: from the Start menu, select LicenseST, and then LicenseST.
Alternatively, double-click the LicenseST Monitor icon in the system tray. This icon can be green, orange or red depending
on licensing status.

LicenseST Monitor icon

3.1 Activation
To compare the license activation types, refer to the section What is the Correct Activation Type?.

3.1.1 Online Activation


If proxy settings modifications are required, refer to the instructions in the section Change Connection Settings.

➢ To Activate a License Online


1. After setting the proxy settings, from the LicenseST GUI, click Add License.
2. Enter the license code and click Activate.

LicenseST GEH-6867 11
Public Information
The license information displays in the LicenseST main window. The license code is provided via email or from the
distributor.

12 GEH-6867 LicenseST User Guide


Public Information
3.1.2 Offline Activation
➢ To Activate a License for Offline Use
1. From the LicenseST GUI, click Add License to display the LicenseST Activation window.
2. In the LicenseST Activation window, select the Offline Activation tab.
3. Paste the activation code into the Application License Code field and click Generate. The Activation Certificate
For Webpage field should populate.
4. Select Copy to Clipboard or Export To File to save the Activation Certificate For Webpage text.
5. On a PC with Internet access, navigate to https://www.activationportal.me/selfservice/activation.aspx?Type=1&cid=
7300&pid=8440&lang=en-US and paste the Activation Certificate For Webpage text into the Activation Certificate
field, then click Activate.
6. Copy the text generated from the activation portal webpage to a file or to the clipboard.
7. In the LicenseST Activation window, select Paste from Clipboard or Import From File to get the text generated from
the activation portal webpage into the Response Certificate From Webpage field and click Activate.

3.2 Return a License Activation


A license activation for a given product can be returned for any reason. For example, a new license activation needs to be
activated for the same product or a new computer procured and want to reuse the same license from the previous computer.

➢ To Return a License Activation


1. From the LicenseST main window’s top right drop-down list, select the product license to return.

LicenseST GEH-6867 13
Public Information
Information about the license to be returned is displayed on the License Info tab.
2. Click Return License.
If the tool detects cloud connectivity, it returns the license to the cloud. If cloud connectivity is not detected, the deactivation
string of characters can either be copied to the clipboard or into a file. This deactivation string must be pasted into the
deactivation portal (https://www.activationportal.me/selfservice/deactivation.aspx?Type=2&cid=7300&pid=8440&lang=
en-US) . On the portal page, click Deactivate to complete the return of the license activation.

3.3 Advanced Settings Tab


3.3.1 Query Server for Products
This forces a communication to the cloud to refresh the lease period for all products that are licensed in LicenseST.

➢ To Query Server for Products: from the LicenseST main window, click the Advanced tab, then click Query
Server for Product.

3.3.2 Submit Problem Report


If there is an issue, please submit a problem report.

➢ To Submit a Problem Report


1. From the LicenseST main window, click the Advanced tab, then click Submit Problem Report.
2. Fill out the information and click OK to email the problem report.
If the workstation does not have Internet access, click Save to File, copy the saved file to a PC with Internet access, and
email the file to swbgs@ge.com; make sure the body of the email is left blank.

14 GEH-6867 LicenseST User Guide


Public Information
3.3.3 Clean Up License Data
This option purges all license data from the given computer.

Do not use this option unless instructed by Customer Care or by the Development
Team.

Attention
➢ To Clean Up License Data: from the LicenseST main window, click the Advanced tab, then click Clean up
License Data.

3.3.4 Change Logging Settings

Do not change this setting unless instructed by a Developer debugging an issue.

Attention
➢ To Change Logging Settings: from the LicenseST main window, click the Advanced tab, then click Change
Logging Settings.
This window also provides an easy way to get all log files by selecting Zip Log Files.

3.3.5 Change Connection Settings


➢ To Change Connection Settings
1. From the LicenseST main window, click the Advanced tab, then click Change Connection Settings.
2. Fill out the Proxy Settings and VMWare vSphere Settings (only available on VMware hosted OS) and click Save.

LicenseST GEH-6867 15
Public Information
A validation happens.

➢ To Validate the Proxy Settings: from the LicenseST main window, bottom left, look at Connectivity. If it
displays Connected To Cloud, the Proxy Settings are good.

Note VMware vSphere Settings are only accessible on the VMware managed operating system. VMware vSphere Address
(es) can be a list of addresses separated by semicolons ‘;’.

3.3.6 Analyze Current Dongle


➢ To Analyze Current Dongle: from the LicenseST main window, click the Advanced tab, then click Analyze
Current Dongle.
If a recognizable security dongle is there, the following will display:

The Reload button reloads the serial number from the dongle. This can be used when changing dongles.

16 GEH-6867 LicenseST User Guide


Public Information
4 LicenseSTCommandLine
LicenseSTCommandLine is a command line interface that allows a user to activate, return, refresh, or view activated licenses.

Note LicenseSTCommandLine can be used in Windows and Linux.


All examples use the syntax for Linux command line.

4.1 Activation
To compare the license activation types, refer to the section What is the Correct Activation Type?.

4.1.1 Online Activation


If proxy settings modifications are required, refer to the instructions in the section Set Connection Settings.

➢ To Activate a License Online: after setting the proxy, execute the following command:
<LicenseST_Path>/LicenseSTCommandLine -activation online -code
"CST-XXXX-XXXX-XXXX-XXXX"

➢ To verify what is licensed: use the show products command. Refer to the section Show Licensed Products.

4.1.2 Offline Activation


➢ To Activate a License for Offline Use:
1. Execute the following command:
<LicenseST_Path>/LicenseSTCommandLine -activation offline -code
"CST-XXXX-XXXX-XXXX-XXXX"
A string of letters and numbers is returned.
2. Copy this string from the terminal to a PC with Internet access.
3. On a PC with Internet access, navigate to https://www.activationportal.me/selfservice/activation.aspx?Type=1&cid=
7300&pid=8440&lang=en-US and paste the string into the Activation Certificate field, then click Activate.
The activation portal displays a long string of characters.
4. Copy the string of characters to a file or to the clipboard.
5. From the console, paste the string of characters and press [Enter].

➢ To verify what is licensed: use the show products command. Refer to the section Show Licensed Products.

4.2 Return a License Activation


➢ To Return a License Activation:
1. Determine what product is licensed (for example, the first division of the activation code).

LicenseSTCommandLine GEH-6867 17
Public Information
For ControlST it is CST, for Advanced Developer Toolkit it is ADT, and for GE Digital Products it is DIG.
2. Execute the following command:
<LicenseST_Path>/LicenseSTCommandLine -returnproduct <first_division_activation>

Note If unsure of the product use XXX for <first_division_activation> to get a list of products.

If the tool detects cloud connectivity, it returns the license to the cloud. If cloud connectivity is not detected, the console
displays a long string of deactivation characters. These deactivation characters must be pasted into the deactivation portal
(https://www.activationportal.me/selfservice/deactivation.aspx?Type=2&cid=7300&pid=8440&lang=en-US ). On the portal
page, click Deactivate to complete the return of the license activation.

4.3 Set Connection Settings


➢ To Set Connection Settings: execute the following command:
<LicenseST_Path>/LicenseSTCommandLine -setconnectionsettings -setproxyaddress
http://<proxy> -setproxyport 80 -setproxyusername "<user_name>" -setproxyuserpassword
"<password>" -setvsphereaddress "<address>" -setvsphereusername "<username>"
-setvspherepassword "<password>" -setcomputernameinvsphere "<compName>"

Note Parameters shown in Italic are optional. vSphere settings are only used in VMware hosted Windows machines.

4.4 Get Security Dongle Serial Number


➢ To ensure that the system is detecting the Security Dongle: execute the following command:
<LicenseST_Path>/LicenseSTCommandLine -getdongleserial
This reads the serial number from the dongle. This command also fixes the issue of when products are no longer licensed due
to the non-detection of the security dongle. This command clears that non-detection error immediately instead of having to
wait for up to an hour for the service to execute.

4.5 Show Licensed Products


➢ To show what products are currently licensed: execute the following command:
<LicenseST_Path>/LicenseSTCommandLine -showproducts

18 GEH-6867 LicenseST User Guide


Public Information
5 What is the Correct Activation Type?
Type of Activation Is Virtual Machine? Length of Lease1 Operating System Is Security Dongle
Required?
Online No 20 days All No
Offline No Until expiration date All No
Online2 Yes Until expiration date Windows- Hyper-V or No
VMware Managed
Offline2 Yes Until expiration date Windows- Hyper-V or No
VMware Managed
Offline Yes Until expiration date Any Yes
1 Length of Lease = Time before you will not be licensed
2 If certain information cannot be detected on the system, the Lease period is set to 500 hours by default.

Note A security dongle extends the lease time for virtual machines (VM) for an offline activation. This is because VMs that
are copied are identical and this dongle provides a unique identifier.

What is the Correct Activation Type? GEH-6867 19


Public Information
Notes

20 GEH-6867 LicenseST User Guide


Public Information
Appendix Common Issues
The following table provides some common issues a user may encounter while using LicenseST products and how to resolve
the issue.

Issue Solution
I do not have cloud connectivity • Ensure you are connected to the Internet
• If you have a proxy server, set the properties. To set the
properties, follow the instructions in section Change
Connection Settings for LicenseST and Set Connection
Settings for LicenseSTCommandLine
The lease on my online activation is not refreshing Without a proxy, the service that automatically refreshes the
lease does not know how to connect to the cloud.
• Ensure you are connected to the Internet
• If you have a proxy server, set the properties. To set the
properties, follow the instructions in section Change
Connection Settings for LicenseST and Set Connection
Settings for LicenseSTCommandLine

Appendix Common Issues GEH-6867 21


Public Information
Notes

22 GEH-6867 LicenseST User Guide


Public Information
Public Information

You might also like

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy