OpenLM Agent Installation V4 - OpenLM Software License Management
USA +1 866 806 2068 | JAPAN +81 3 45208991 担当:萩原 info@openlm.com

OpenLM Agent Installation V4

Introduction
The OpenLM Agent may be installed on any number of workstations to enhance the end-user experience and control. The goal is to allow individuals at workstations to obtain additional information about licenses which can be used to more effectively manage resources. The possibilities include but are not limited to: providing individual stations with the capability to monitoring of idle and potentially available licenses, reporting project information, and simplify starting, stopping or killing processes.

This document covers only installation and removal of OpenLM Agent. There are three options for installation including using the standard Setup Wizard, silent installation, or with Microsoft System Center Configuration Manager.

For more information about OpenLM Agent configuration and use, please see the following documents:

Introduction to Using OpenLM Agent

Configuring OpenLM Agent

Using Custom Commands

Installation

To begin working with OpenLM Agent, users need to initiate and configure the installation using the installation package openlm_active_agent_win_####.msi (“####” represents the version number). Installation can be handled with the standard Setup Wizard (see the section in this document titled “Option A: OpenLM Agent Setup Wizard Installation” ), through silent installation (see the section in this document titled “Option B: OpenLM Agent Silent Installation”), or with Microsoft System Center Configuration Manager (see the section in this document titled “Option C: Open Agent Installation with SCCM”).

The Setup Wizard package is mostly an automated, on-screen process intended for single-user workstation installations. Silent installation (command prompt) and SCCM installations offer opportunities to do installations on multiple workstations from centralized servers without end-user involvement.

The installation file can be obtained from OpenLM sales or the download area of the website (visit https://www.openlm.com/download/ and locate the OpenLM Agent link).

Option A: OpenLM Agent Setup Wizard Installation

This installation method utilizes the assistance of the on-screen wizard to lead end-users through the installation.

1. Double-click the installer file to launch the installation. The Welcome screen for the OpenLM Agent Setup Wizard will appear (see Figure 1).


Figure 1: The OpenLM Agent Setup Wizard

2. Click [NEXT] to reveal the License Agreement screen (See Figure 2).


Figure 2: The License Agreement screen

3. Read the license agreement and choose one of the following options (A or B):

A. If you do not want to continue the installation, click [Cancel]. A confirmation screen will appear with a warning that you will be exiting the installer without completing the installation. Click [Yes] to exit the installer.

B. In order to continue with the installation, click the “I Agree” radio button (see Figure 3). This will make the [Next] button active. Click [Next] to advance to the OpenLM Extensions screen (see Figure 4).


Figure 3: License Agreement with “I Agree” checked.


Figure 4: The OpenLM Extensions screen.

4. The installer automatically checks for the presence of licensed software packages. If options listed on the screen are installed, they will be detected automatically, and the checkboxes will be activated and checked by default. Review the options and uncheck only if it is not desirable to monitor the packages. Click [Next] to reveal part 2 of the OpenLM Extensions installation options (See Figure 5). [NOTE: If a new extension is installed, OpenLM Agent must be reinstalled and the appropriate extension flag set so that it recognizes the new software.]


Figure 5: Part 2 of the OpenLM Extensions screen.

5. Choose the desired extensions to install using option A, B or C below.

  • If OpenLM App Manager support is desired, choose option A.
  • If monitoring without App Manager is desired, choose option B.
  • If no additional services are desired, choose option C.

A. Click the “OpenLM App Manager” box to install the App Manager component Support. This will also check the “Install Service” item (see Figure 6). The OpenLM App Manager allows monitoring and control of enterprise software allocation policy. It also adds additional options to the OpenLM Agent Configuration screen (see Step #13). See the dedicated documentation for OpenLM App Manager (https://www.openlm.com/openlm-app-manager/). Services will need to be installed along with App Manager.


Figure 6: OpenLM Extensions selection screen with OpenLM App Manager selected.

B. Click only the “Install Service” box to install the service without App Manager component support. A service installation monitors OpenLM Agent and recreates processes in the event that they become unavailable.

C. Leave both boxes unchecked to skip installation of service extensions. This option devotes fewer resources to system monitoring.

6. Click [Next] to reveal the Select Installation Folder screen (see Figure 7). This will populate with a default path for the installation. If you wish to change the path, click the [Browse…] button and select a new folder. [Disk Cost…] will display available drives and details such as the size of the drives and space available.


Figure 7: The Select Installation Folder screen.

7. Click [Next] and the installation confirmation screen will appear (see Figure 8).


Figure 8: The Installation Confirmation screen.

8. Click [Next] and the installation will begin. A screen will appear displaying a progress bar (see Figure 9).


Figure 9: OpenLM Agent installer progress bar.

9. When the software is installed the Agent Configuration screen will appear (see Figure 10).


Figure 10: The Agent Configuration screen.

10. Check the installation options. It may be necessary to check with the system administrator to be sure the configuration options are correct. The default values are generally recommended unless there is a specific reason to alter them.

  • The installation Language is English by default.
  • OpenLM Server must have the correct server name.
  • Check the SSL box if the network uses SSL security.
  • The Port must match the OpenLM Server connection port.
  • Logging Level is recommended as Error (other options may use more resources).

[NOTE: It is possible to close the Agent Configuration screen and return to it at a later time to complete the setup. To complete configuration at a later time, skip to Step #14. To open the screen again, click the Show Hidden Icons arrow on the right of the Windows taskbar, right-click the OpenLM Agent icon on the menu that appears and click OpenLM Agent Configuration on the popup screen. When the screen appears follow Step #11 to Step #15.]

11. Check the connectivity by clicking the [Check Connectivity to OpenLM Server] button. This should return a success message in the OpenLM Connection Check screen (see Figure 11). If the connection is not successful (see Figure 12), check to see that services are running (see the “Services Check” section later in this document), that there is a physical connection to the machine where OpenLM Server resides (e.g., that the server name and port are correct and functioning), and confirm installation options with the system administrator. If you review the services and installation and still get an error, please contact OpenLM support (support@openlm.com).


Figure 11: Connection check success.


Figure 12: Connection check failure.

12. After receiving the success message on the OpenLM Connection Check screen, close the connection check screen by clicking [OK].

13. [Optional] If the OpenLM App Manager extension is installed, the OpenLM App Manager tab will be available at the top of the Agent Configuration screen. Click the tab name to reveal additional options (see Figure 13).


Figure 13: OpenLM App Manager configuration options.

14. Check the License Manager options. It may be necessary to confirm settings with the system administrator. The default values are generally recommended unless there is a specific reason to alter them.

  • The OpenLM License Manager Server must have the correct server name.
  • Check the SSL box if the network uses SSL security.
  • The Port must match the OpenLM License Manager Server connection port.
  • Use [Check Connectivity] to be sure the server connection is setup correctly and functioning. This should return a success screen (see the suggestions in Step #11 if the connection fails).

15. Click [Apply]. This will accept the Agent Configuration changes and close the screen.

16. An installation success screen appears when the Agent Configuration screen is closed (see Figure 18). [NOTE: This does not apply when configuration is done separately as discussed in Step #9.]


Figure 18: The installation success screen.

17. Click [Close] to exit this segment of the installation.

At this point, the installation of OpenLM Agent is complete. See the dedicated end-user documentation to begin using the functionality (Introduction to Using OpenLM Agent).

Option B: OpenLM Agent Silent Installation

This installation method allows users to install OpenLM Agent with predefined options and no on-screen ‘wizard’ assistance.

1. Open a command prompt with administrative privileges (see Figure 19). The command prompt can be run in several ways:

A. Type ‘cmd’ in the taskbar search field and press RETURN on the keyboard. Right-click “Command Prompt” in the results list and choose “Run as administrator” from the popup menu.

B. Launch the EXE directly by right-clicking (e.g., from C:\Windows\System32\cmd.exe) and choosing “Run as administrator” from the popup window.

C. Navigate through the Start menu. Right-click on Start then choose Windows PowerShell (Admin). This will open the Windows PowerShell in administration mode.


Figure 19: The Command Prompt screen in Administrator role.

2. At the command prompt, enter the desired parameters for the installation. This will be in the format as follows:

msiexec /i <msi installation file path> /quiet /norestart <parameters>

The MSI file path is the location of the MSI file downloaded for the installation. The parameters can be selected from the parameter tables (see the “Installation Parameters, Options, and Descriptions” section later in this document to define the desired parameters).

3. Press [Enter/Return] on the keyboard to launch the installation.

At this point, the installation(s) will be complete. Please see the dedicated configuration documentation for more information on basic and advanced OpenLM Agent configurations (Configuring OpenLM Agent).

Option C: Open Agent Installation with SCCM

This installation method allows users to install OpenLM Agent with predefined options through the SCCM Configuration Management Console.

The steps here are concerned only with the installation of OpenLM Agent. The instructions assume that there is already a working SCCM installation in your environment as well as on the workstations where OpenLM Agent will be deployed. It is advisable to seek IT department assistance with SCCM-related tasks. For additional information about SCCM and support of its installation and use beyond the instructions here, please consult with Microsoft Support (click here: System Center Configuration Manager).

Installation requires two stages:

  • Creating the installation package for the application
  • Deploying the application to target workstations

Creating the Installation Package

1. Locate the OpenLM Agent installer (openlm_active_agent_win_####.msi) on the SCCM server or on a network share to be sure it is accessible by that server.

2. Open the SCCM Configuration Management Console on the SCCM server.

3. Navigate to Applications in the Software Library menu at the left of the screen (Software Library > Overview > Application Management > Applications).

4. [Optional] A folder can be created under Applications to help manage organization of applications. This may be helpful in cases where it is an advantage to create applications for a variety of situations. To create a folder, right-click on Applications and choose “Folder” from the popup list. Enter the Folder Name in the Configurations Manager screen and click [OK].

5. Right-click on Applications and choose “Create Application” from the pop-up menu. The Create Application Wizard dialog will open displaying general information (see Figure 20). [NOTE: If an application should be added to a folder created in Step #4, right-click on the folder name in the menu instead of Applications.]


Figure 20: The Create Application Wizard displaying the General panel.

6. Select “Automatically detect information about this application from the installation files” by clicking the radio button. This will use information from the installation files to automate the process of installation as much as possible.

7. Choose an installation file type. To do this, click the down arrow on the Type drop list and choose “Window Installer (*.msi)” by clicking on it.

8. Click on the [Browse] button to locate the MSI installation file identified in Step #1.

9. Click [Next] to advance to the ‘View Imported Information’ panel, which displays information automatically captured from the installer package.

10. Click [Next] to advance to the ‘Specify information about this application’ panel (see Figure 21).


Figure 21: The “Specify information about this application” screen.

11. Complete all relevant and desired details in the upper portion of the screen. These fields are free text which can help identify and sort applications during searches. The fields include Name, Administrative Comments, Manufacturer, Version, Optional Reference and Administrative Categories.

12. In the lower half of the panel, select an Install Behavior from the drop-down menu.

  • Install for user — Installs using the rights of the current user.
  • Install for system — Installs using the rights of the SMS Agent Host service (Local System account).
  • Install for system if resource is a device; otherwise, install for user — If the application is targeted to a collection of devices, use install for system. If the application is targeted to a collection of users or user groups, use install for user.

13. Modify the Installation program field. The [Browse] button can be used to locate the installation file. This field can include the options you would normally use in a silent installation from a command line. See the section in this document titled “Installation Parameters, Options and Descriptions.”

14. Click the [Next] button to advance to the Summary screen.

15. Review the information compiled for the application. If anything needs to be changed, use the [Previous] button to navigate back through the wizard screens; return to the Summary screen after completing changes.

16. When the compiled information has been reviewed, click on the [Next] button on the Summary screen. This accepts the changes and invokes a progress screen (see Figure 22) while the application is created. When the process is complete, the Completion screen will appear along with a review of the processing (see Figure 23).


Figure 22: The “Create Application Wizard” progress screen.


Figure 23: The “Create Application Wizard” success screen.

17. Click on [Close] to close the Completion screen and exit the wizard.

At this point, creation of the installation package is complete. It will be available in the SCCM console listing under Software Library > Overview > Application Management > Applications. Additional applications may be created to handle different installation criteria by repeating Step #4 to Step #17. Additional parameters and details may be added by right-clicking the application in the console and choosing “Properties.”

Deploying the Application to Target Workstations

1. Open the SCCM console and locate the application in the listing under Software Library > Overview > Application Management > Applications.

2. Right-click on the OpenLM Agent application and select “Deploy” from the popup menu that appears. This opens the Deploy Software Wizard with the General screen displayed (panel titled “Specify General Information for this Deployment”). The Software field will be pre-populated with the application name (see Figure 24).


Figure 24: The “Deploy Software Wizard” specify general information for this deployment screen.

3. Click the [Browse] button to the right of the Collection field and the Select Collections screen will appear. By default User collections screen is opened (Figure 25).


Figure 25: The “Users Collections” panel on the Select Collection screen.

4. Use the drop list at the upper left of the Select Collections screen to navigate to User Collections, and choose from available options that appear at the right of the screen.

5. [Optional] Use the drop list at the upper left of the Select Collections screen to navigate to Device Collections, and choose from available options that appear at the right of the screen.


Figure 25: The “Device Collections” panel on the Select Collection screen.

6. Click [OK] to accept the changes and return to the General screen.

7. Click [Next] on the General screen to advance to the Content screen (panel titled “Specify the Content Destination”).

8. Click [ADD] to open the popup menu and choose Distribution Points. Add distribution points by marking the checkboxes on the Add Distribution Points screen.

9. Click [OK] to return to the Content screen.

10. Click [Next] to advance to the Deployment Settings screen (panel titled “Specify Settings to Control How this Software is Deployed”).

11. The default values for Action and Purpose should be “Install” and “Required,” respectively. These options are suggested for OpenLM Agent installation. Click [Next] to advance to the Scheduling screen (panel title “Specify the Schedule for this Deployment).

12. [Optional] Use the options on the Scheduling screen to specify a time for installation. The default value of “As soon as possible after the available time” will launch the installation as soon as possible following completion of the deployment setup.

13. Click [Next] to advance to the User Experience screen (panel titled “Specify the user experience for the installation of the software on the selected devices”).

14. [Optional] Adjust the options as desired. The default for User Notification is “Display in Software Center and show all notifications.” “Commit changes at deadline or during maintenance window (requires restart)” is also checked by default.

15. Click [Next] to advance to the Alerts screen (panel title “Specify Configuration Manager and Operation Manager alert options”).

16. [Optional] Adjust the options as desired. None of the options are enabled by default.

17. Click [Next] to advance to the Summary screen (panel title “Confirm settings for the new deployment”).

18. Review the information compiled for the deployment. If anything needs to be changed, use the [Previous] button to navigate back through the wizard screens. Return to the Summary screen after completing any changes.

19. Click on the [Next] button on the Summary screen. This accepts the changes and initiates creation of the deployment. A progress screen will appear. When the process is complete, the Completion screen will display along with a review of the completed process.

20. Click [Close] to exit the wizard. This will return you to the console screen.

21. [Optional] Locate the deployment by clicking the Deployments tab at the bottom of the SCCM console screen with the application selected.

Upon successful deployment, the OpenLM Agent should appear in the Software Center on the client and will be installed automatically.

Installation Parameters, Options and Descriptions

This section lists parameters that can be used during installation (Option B the Silent Installation option, and Option C the SCCM Configuration Management Console). The parameters are divided into three sections:

  • Command Parameters
  • Active Agent Extensions
  • Proactive License Manager Extension Parameters

These parameters help administrators control the installation options.

Installation Command Parameters

The basic parameters for installation of OpenLM Agent are listed in Table 1: Command Parameters. These apply changes that affect OpenLM Agent software directly rather than the extensions.

Command Parameters Options Default Description
SERVERNAME localhost Use the actual OpenLM server name.
SERVERPORT 7012 Use the actual OpenLM server port number.
SHOW_NOTIFICATION_ICON true

false

true False: hides the OpenLM Agent icon from the user (not recommended).

True : Show the notification icon at the taskbar.

ERROR_LEVEL all

debug

info

warn

error

fatal

off

error Recommended logging level: Error
TARGETDIR

 

C:\Program Files\OpenLM\OpenLM Agent Specifies the root destination directory for the installation.
SHUT_WHEN_NOT_ACTIVE true

false

false True: Shutdown the Active Agent automatically when the inactive for a period of time defined in the INACTIVITY_TIME parameter.

False: Ignore inactivity.

INACTIVITY_TIME A number representing the inactivity time in seconds. Useful only when SHUT_WHEN_NOT_ACTIVE = true
LANG en-US

ru-RU

es-ES

de-DE

fr-FR

ja-JP

pt-BR

en-US The OpenLM language format. The options are as follows:

en-US: English

ru-RU: Russian

es-ES: Spanish

de-DE: German

fr-FR: French

ja-JP: Japanese

pt-BR: Portuguese

REQUEST_TIMEOUT 120 seconds The timeout for an OpenLM Server request the OpenLM Agent. Customers using ‘Suspend and Resume’ to FlexLM controlled applications may want to consider extending the default.

Table 1: Command Parameters.

Installing OpenLM Agent Extensions

OpenLM Extensions are software modules that enable OpenLM to retrieve idle licenses through the “Save and Close” method. Additional information on OpenLM extensions can be found on the OpenLM website (click here: OpenLM Extensions). Parameters and values for installation during silent installation are listed in Table 2: OpenLM Agent Extension Parameters.

[NOTE: Extensions can only be installed when the relevant application installation already exists. If the associated application is not present, the extension is not installed regardless of the installation flag setting and the installation will fail.]

Extensions Options Default Description
INSTALL_ARCGIS

 

0: Do not install

1: Install

Determined at run time.

1 if application exists.

0 if application does not exist.

ArcGIS extension
INSTALL_PLUGIN 0: Do not install

1: Install

1 Relevant to ArcGIS users only. Allows selection of ArcInfo, ArcEditor, or ArcView license levels.
INSTALL_ARCGISPRO 0: Do not install

1: Install

Determined at run time.

1 if application exists.

0 if application does not exist.

ArcGISPRO extension
INSTALL_MATLAB 0: Do not install

1: Install

Determined at run time.

1 if application exists.

0 if application does not exist.

Matlab extension
INSTALL_SOLIDWORKS 0: Do not install

1: Install

Determined at run time.

1 if application exists.

0 if application does not exist.

Solidworks extension

Table 2: OpenLM Agent Extension Parameters.

Installing Proactive License Management Extensions

OpenLM Proactie Application Manager helps manage the process of drawing licenses. For more information, see the dedicated documentation on the website (click here: Proactive Application Manager documentation). The parameters in Table 3: Proactive License Manager Extension Parameters list options for controlling these capabilities through silent installation.

Extensions Options Default Description
USE_SERVICE 0: Do not install

1: Install

0 Proactive license management Windows service
CHECK_INTERCEPTION 0: Do not activate

1: Activate

0 Proactive license management component
PRODUCTS_XML_PATH \\ServerName\Shared folder\OpenLM\products.xml C:\Program Files (x86)\OpenLM\OpenLM Agent\products.xml Enables centralizing the location of a products.xml file which stores OpenLM Agent proactive application management information.Use a local or UNC path.

 

UNC_USER_NAME Username of authorized to (read/write) the products.xml file.
UNC_PASSWORD Password of the UNC_USER_NAME username.

Table 3: Proactive License Manager Extension Parameters.

Examples

The following examples are intended to be guidelines to possible real-world scenarios that may help users select and configure installations for their own needs. They are not intended to be suggested configurations. The ‘####’ string in each example represents the version number of the installer which is subject to change.

Example 1

Install OpenLM Agent on OpenLM Server ‘145.13.4.121.’ Hide the notification icon. Set the logging level to ERROR:

msiexec /i "C:\tmp\openlm_agent_win_####.msi" /quiet /norestart SERVERNAME=145.13.4.121 SHOW_NOTIFICATION_ICON=false ERROR_LEVEL=ERROR

Example 2

Install OpenLM Agent on OpenLM Server ‘olm_server,’ whose server port 7777. Set the language to German. Set the logging level to ALL.

msiexec /i "C:\tmp\openlm_agent_win_####.msi" /quiet /norestart SERVERNAME=olm_server SERVERPORT=7777 ERROR_LEVEL=ALL LANG=de-DE

Example 3

Install OpenLM Agent on the ‘localhost’ machine. Shutdown active license use automatically when an application is inactive for 20 minutes. Specify the root destination directory for the installation to be “D:\program files\OpenLM\OpenLM Agent.” Install the AutoCad, ArcGIS and Matlab extensions.

msiexec /i "C:\tmp\openlm_agent_win_####.msi" /quiet /norestart SERVERNAME=localhost SHUT_WHEN_NOT_ACTIVE=true INACTIVITY_TIME=20 TARGETDIR="D:\program files\OpenLM\OpenLM Agent" INSTALL_AUTOCAD=1 INSTALL_ARCGIS=1 INSTALL_MATLAB=1

Services Check

You will need to be sure all of the necessary OpenLM components are running before attempting to use the module.

1. Open Windows Services (e.g., execute C:\WINDOWS\system32\services.msc or type “Services” in the Windows search on the taskbar and choose the Services App from the result).

2. Be sure that OpenLM Software Locker is running. If the service is not running, right click the service name in the Windows Services screen and choose “Start” from the pop-up menu.

3. When the service has been started, close the Services window by clicking the [X] in the upper right of the screen.

When it is confirmed that the service is running, it is possible to check the server connection.

Uninstalling OpenLM Agent

Uninstall can be initiated through the Windows Control panel (Option A) or by launching the OpenLM Agent Setup Wizard and choosing the option to Remove OpenLM Agent (Option B).

Option A: Uninstall Using Windows Control Panel

1. Open the Windows Control Panel. This is located at C:\Windows\System32\control.exe or by typing “Control Panel” in the Windows search bar and selecting “Control Panel” from the results.

2. Locate and click the “Uninstall a Program” option under Programs highlighted in Figure 26. The Programs and Features screen will appear (see Figure 27).


Figure 26: Windows Control Panel with highlighted link.


Figure 27: The Programs and Features screen.

3. Locate OpenLM Agent in the list of names (click on Name to sort the list alphabetically). Options will appear at the top of the list for possible actions (see Figure 28).


Figure 28: The Programs and Features screen with the options highlighted.

4. Click on Uninstall. This will open a confirmation screen (see Figure 29).


Figure 29: The Uninstall confirmation screen.

5. Click [Yes] to confirm the uninstall. A progress screen will appear (see Figure 30). The progress screen will close when the process is complete.


Figure 30: The OpenLM Agent uninstall progress screen.

6. Close the Programs and Features screen by clicking the [x] in the upper right of the window to close out of the Control Panel.

Option B: Uninstall Using the OpenLM Installer Package

1. Locate the installer file and double-click the installer file or right-click and choose “install” from the pop-up menu. The OpenLM Agent Setup Wizard screen will appear (see Figure 31). “Repair OpenLM Agent” is selected by default.


Figure 31: The OpenLM Agent Setup Wizard screen.

2. Click the Remove OpenLM Agent radio button to select the process for removing the installation (see Figure 32).


Figure 32: The Setup Wizard with “Remove OpenLM Agent” selected.

3. Click the [Finish] button to initiate the process. A progress screen will appear (see Figure 33).


Figure 33: The Removing OpenLM Agent progress screen.

4. If any processes are still running that use portions of the OpenLM Agent and Custom Commands, an error screen will appear with information as to the specific process(es) involved. These processes can be stopped using Windows Services (e.g., execute C:\WINDOWS\system32\services.msc or type “Services” in the Windows search on the taskbar and choose the Services App from the result), and the removal can be continued by clicking [Try Again] (see Figure 34). When the removal is complete, the removal success screen will appear (see Figure 35).


Figure 34: The Files in Use alert screen.


Figure 35: The removal success screen.

5. Click the [Close] button to exit the Setup Wizard.

At this point the removal process is complete. Uninstalling will leave the configuration files for OpenLM Agent intact and these must be deleted manually. They are left so that the OpenLM Agent can be reinstalled without losing previous configurations. They can be found by default in C:\Program Files (x86)\OpenLM\OpenLM Agent.