License retrieval of idle applications (MATLAB, AutoCAD, ArcGIS, SOLIDWORKS) – Save and Close – KB4005b
One of the license retrieval methods that OpenLM offers is the “Save and Close” method, also referred to as the “Extension” method. As the name implies, using this method saves the user’s currently opened project and closes the application, returning the license back to the pool.
This method can be configured for the following applications:
- ArcGIS and ArcGIS Pro
- AutoCAD (all features that use the acad.exe process)
Table of Contents
With the ”Save and Close” method, once a workstation with an idle application has been detected, the user’s currently opened project is saved and the application is closed. The autosave location is configurable, so the saved session can avoid overwriting the current project. See the ”Extension dedicated functions” section below for more information.
The “Save and close” method requires the installation of OpenLM Agent on the end-user workstation.
1. If open, close the extension enabled application (ArcGIS / ArcGIS Pro / MATLAB / AutoCAD / SOLIDWORKS ) on all end-user workstations.
3. When installing OpenLM Agent manually, if an extension supported application (e.g. ArcGIS, AutoCAD, MATLAB, SOLIDWORKS, etc.) is detected on the computer, the OpenLM Extensions dialog will have the appropriate checkbox available. Check for each application that you want to use “Save and Close”.
4. Once installation is complete, right-click on the Agent tray icon and open the OpenLM Agent Configuration window. Enter the OpenLM Server IP / hostname the Agent will connect to, then click Apply (this setting can also be set with a silent install).
At this point, OpenLM Agent will have an extension for each of the supported applications. It is good practice to ensure that the extension has been properly installed. See the “Verify the OpenLM Extension Installation” appendix at the end of this document.
The following steps are required to configure the “Save and Close” method for a supported application. For software suites like ArcGIS which use the same license for multiple applications (e.g. ArcMap, ArcCatalog, ArcGlobe), these steps will have to be repeated, setting the same idle time values for each application that you want to control.
1. Open the OpenLM EasyAdmin web application by going to Windows Start → OpenLM → OpenLM EasyAdmin User Interface.
2. Click EasyAdmin Start → Administration → Process Features. The Process Features window opens:
3. Select an extension enabled application (ArcGIS / ArcGIS Pro / MATLAB / AutoCAD / SolidWorks), and click Edit.
4. In the Edit process window, from the License release method drop-down menu select Extension.
5. Make sure the Enabled and the Enable automatic license release functionality boxes are checked.
6. Set the “Enable automatic license release functionality” parameters. These parameters determine the policy for labeling an application as idle and how license retrieval proceeds:
- Start releasing licenses after usage rate of (percentage): The usage rate is expressed as a percentage of used licenses relative to the total amount of licenses available for this vendor/application. Once the set percentage threshold of used licenses has been reached, licenses that meet the Idle time license release threshold will be released. E.g. if there are 100 total licenses, the threshold is set to 80%, then when there are 80 used licenses or more, applications that have been idle for the value below (e.g. 15 min) are released automatically.
- Idle time license release threshold (minutes): Licenses will be marked as idle and released if they have been idle for more than the specified amount of time.
7. The ‘Advanced’ panel can be expanded to set the system resource threshold parameters. These numbers are thresholds used for determining whether the monitored application is idle. The default values shown should not be changed unless explicitly instructed by OpenLM Support. Wrong values can adversely affect the OpenLM system’s performance.
- % Processor time (Default: 2): This is the CPU usage percentage threshold over which the application is considered active. The software will only be closed if its use of the workstation’s processor time is lower than the percentage shown
- I/O Data operations / sec (Default: 2): Similarly, this is an I/O threshold over which the application is considered active. The software will only be closed if the number of disk operations per second is lower than the value shown.
- User usage (Default: 2): The processor utilization for user-mode processes on the workstation.
8. Click Save.
Your license usage will now be automatically optimized by OpenLM’s “Save and Close” method.
- Idle applications will have the current project saved and the application closed. An appropriate notification will pop-up on the workstation to notify the user.
- Users who had been waiting for licenses to become available will be notified.
- Activity may be resumed via OpenLM Agent’s “Recently closed documents” interface on the end-user workstation.
For more information on the OpenLM Agent notifications and capabilities please refer to this document.
The Active Agent component in EasyAdmin’s Administration panel has an Extension Dedicated tab which contains extension-specific functions. There are three accordion panels entitled:
- Handling extensions
- Software items that will not be saved nor reported when closed
- List of directories for which projects will not be saved when closed
Note: OpenLM recommends keeping most extension-dedicated preferences at their default values, as this is an advanced feature.
In order to edit “Extensions dedicated” preferences, click EasyAdmin Start → Administration → Active Agent and select the ”Extension dedicated” tab.
Specify the folder in which to save extension-closed project documents, if the “Overwrite existing projects” box is unchecked or if the project was not saved at least once to a specific location after being created.
- Checked (Default): The project document will be saved as if the user clicked Save in the respective application. Document is saved in its original location, thus overwriting the original file. If the document has not been saved at least once after creation, the location for saving will be the one in “Folder to save closed projects”.
- Unchecked: The project document will be saved as a copy in the “Folder to save closed projects” path, as if the user clicked “Save As…”. The same filename is kept and the above folder path is used. The original file will remain untouched (unless the source folder path and the specified path is overlapping).
- Checked: The application’s extension list is shown when the application is restarted after being detected as idle and closed. This is useful for manually prompting users to confirm their usage of a certain extension.
- Unchecked (Default): The application’s extension list will not be shown when the application is restarted after detected as idle and closed.
- Checked (Default): Extensions that require licenses are closed together with the idle application. This requires the user to obtain a license for the extension when restarting the application.
- Unchecked: Extensions that require licenses are not closed together with the idle application.
- Checked (Default): Extensions that do not require licenses are closed together with the idle application. This requires the user to obtain a license for the extension when restarting the application.
- Unchecked: Extensions that do not require licenses are not closed together with the idle application.
There are two ways to deal with an event when a licensed extension that is part of an application has passed the usage threshold:
- The extension is turned off.
- The application is shut down altogether.
When this option is enabled, any extension-supported applications that are still open will be shut down at the specified time. This can be useful if the license usage rate has not reached the defined threshold but you still want to close and release licenses at a certain time (e.g. midnight). To use this function:
- Check the “Shut application down” radio button
- Set the time as to when any working applications will be automatically shut down.
Checking this box will prevent users with OpenLM Agent from being able to adjust the ArcGIS license levels.
This panel lists executables that would not have their data saved when the application is closed; e.g.: ArcCatalog.exe is a file browser which holds no substantial data so it would not be saved. Click ’Add’ to add more executables to the list.
Any projects located in the specified directories will not be saved when the application is automatically closed. This is useful for projects that must maintain the same static information every time they are started. Click ’Add’ to add more directories to the list.
- Click Customize → select Extensions
- Confirm that OpenLM ArcGIS Extension appears in the Extensions list and that the box is checked.
In the main menu, click on Add-In Manager and check if OpenLM_ArcGISPro_Extension_2 is present.
“Save and Close” works for Autodesk software applications that use the acad.exe process. To verify:
- In AutoCAD Map 3D for example, type in the “OLM” command at the bottom of the AutoCAD window. If the OpenLM Agent extension was installed, the end user should receive a message such as depicted below.
If the Extension is not installed, an error message will appear, stating that the “OLM” command is not recognized.
When opening MATLAB, the Command Window will display a STARTUP FILE status.
Go to Tools → Add-Ins. The OpenLM Extension should be in the list and its box checked.