The information on this page refers to License Statistics v6.23 and newer, which introduced the ability to enable/disable multiple license servers at once. If you are using a version previous to v6.23, see documentation for previous versions. |
You can add license servers and edit information for existing license servers using the General tab in the License Servers page, found under the Administration section in the left navigation pane. (This page is visible only for License Statistics administrator users.) You can also verify your License Statistics configuration, which may be useful for troubleshooting purposes.
License Servers grid
The License Servers grid in the License Servers page lists information for each currently configured license server, as described in the following table.
| Column Name | Description |
|---|---|
| License Server | The display name for the license server. |
| License Server ID | The identification of the license server. |
| License Server Description | The optional user-defined description for the license server. |
| License Manager | The license manager type (can be any supported license manager or a custom license manager). |
| Host | The hostname of the license server. If the license server is configured to be redundant (three servers are used) this is the hostname of the main license server. |
| Port | The port to use for the license server. If the license server is configured to be redundant (three servers are used) this is the port for the main license server. |
Data Source Status | The status of the license server for each applicable data source, including Remote, Import, and End User (e.g., Agents). You can hover over each data source status to see its details, including Last Update Time and, for "Failure" status, the relevant error message. For detailed information about license server status, see License Servers. |
| Enabled | Indicates whether monitoring is enabled for the license server. A toggle in the Action column indicates the enabled status and allows you to enable/disable the license server as needed.
You can enable/disable multiple license servers at once by selecting the license servers using the checkbox to the left of the license server row.
|
| Last Update Time | Indicates the time the data for the license server was last updated for all data sources. A status of "Never" indicates that the server was created but doesn't have any data yet (for example, the server has not yet had its first query or it was disabled before it was queried for the first time, or it was never imported). |
| Query Interval | Indicates the time interval (in minutes) between queries. |
| Redundant | Indicates (Yes/No) whether the license server is redundant. |
| Feature Versioning | Indicates (Yes/No) whether Feature Versioning is enabled for the license server. |
Anonymization | Indicates whether users, hosts, or both are anonymized for the license server. A Filters option allows you to show/hide servers according to their anonymization of users and/or hosts: |
Some columns are hidden by default. To control the visibility of columns, see instructions for filtering grid content.
Adding or editing a license server
License Statistics lets you add license servers with the same hostname, port, and other settings multiple times, which may be useful when you want to experiment with using different features, such as Feature Versioning. You should note, however, that the name you give to the license server must be unique; i.e., different than other names already assigned to existing servers.
To add or edit a license server:
- To edit an existing license server, click the Edit icon in the Action column of the License Servers grid row for the license server you want to change. An Edit License Server dialog opens to allow you to change the existing settings for that license server.
or
To add a new license server, click Add at the bottom of the License Servers grid. An Add New License Server dialog opens to allow you to configure the new license server. - The dialog will contain tabs for General information and for each data source that is applicable to the license server type (Remote Monitoring, Importing, and/or End User Monitoring). Complete the information in the Add New/Edit License Server dialog as described below in "License Server settings."
- The Remote Monitoring tab lets you verify the license server configuration manually.
If you would like to verify the configuration, click Verify at the bottom of the Remote Monitoring tab. (This step is not necessary; the configuration will automatically be verified when you save the license server, as described in the next step.)
Verification may take a long time depending on the license manager’s response time, and the status will show that the server is being verified. The verification results will include the status (success or failure), the reason for the failure if verification failed, and the query tool output. The output should look similar to the following.
When the verification is complete, you can use Save to File to export and save the data to a file if desired; for example, X-Formation Support may request this file for troubleshooting. - After completing all settings as needed, click Save or Save and Close to save the license server. You can click Close at any time if you do not wish to save your changes.
License Server settings
License Server settings, described below, are divided into tabs, including General; Remote Monitoring; End User Monitoring (currently for the Autodesk license manager type only); Importing (for license manager types for which importing license server data is supported); and Custom Application Monitoring (for the Custom Application license manager type only). Within each tab, only the settings that are valid for the selected License Manager Type will be shown. For example, the "Vendor Daemon Name" setting is applicable only to FlexNet, RLM and OLicense license manager types, so this setting will not display for other license manager types.
| Setting | Description | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| General tab | |||||||||||||||||||||||||||||||||
| General settings | |||||||||||||||||||||||||||||||||
| Name | The name for the license server that will be displayed in License Statistics. This can be any descriptive, unique name that helps you identify the license server in License Statistics pages. | ||||||||||||||||||||||||||||||||
| Enabled | Check this box to enable monitoring for the license server. When this box is not checked, monitoring for the license server is disabled. Only enabled license servers are counted in the number of license servers you can monitor according to your License Statistics license agreement. You can add any number of disabled license servers. If you have reached your limit of license servers you can monitor, you can disable any license servers that you do not need to monitor and enable the license servers you do need to monitor. | ||||||||||||||||||||||||||||||||
| License Manager Type | The type of license manager you are using for the license server. This selection list includes all supported license managers. You can begin typing the license manager type to limit the selection list to entries that contain the characters you type. If you select Custom as the license manager type, you must specify the path to your custom XML file in the File Path field under Connection settings. See Supporting a custom license server for information on adding a custom license server. If you select Custom Application as the license manager type, you must set up custom application monitoring. | ||||||||||||||||||||||||||||||||
| Description | An optional description for the license server. | ||||||||||||||||||||||||||||||||
| Vendor settings | |||||||||||||||||||||||||||||||||
| Name | The vendor name read from the license server output. Read-only field is set to the proper value on the first query. | ||||||||||||||||||||||||||||||||
Daemon Name | An optional vendor daemon name for the license server. This entry cannot contain spaces or special characters, except underscores, hyphens and periods. Applicable only for FlexNet, RLM, CodeMeter and OLicense license manager types. FlexNet license servers are configured with case-sensitive names by default, so make sure the vendor name uses the correct case when configuring a FlexNet license server. An error in the vendor name may cause problems with License Statistics usage monitoring. See "Failure to find licenses for FlexNet license server" in FLEXlm and FlexNet license server issues for more information. For CodeMeter license server use Firm Code. | ||||||||||||||||||||||||||||||||
| Display Name | An optional name to display for the vendor in reports. | ||||||||||||||||||||||||||||||||
| Gathering settings | |||||||||||||||||||||||||||||||||
Anonymous Usernames/ Hostnames | Make users and/or hosts anonymous in the database and reports (normally used to protect users for legal reasons, as is required in some countries). When enabled:
Note that you can set this additional option only when adding a license server; you cannot edit this option after adding the server. If you do not choose to anonymize data for the license server, note that you can perform "on-demand" data anonymization of historical data as needed. | ||||||||||||||||||||||||||||||||
| Feature Versioning | Enable Feature Versioning for the supported license server types. Note that you can set this additional option only when adding a license server; you cannot edit this option after adding the server. Currently this option works with the following license servers:
| ||||||||||||||||||||||||||||||||
Toggle on to enable Collections. Applies only to Autodesk and Dassault license managers. Note that this setting cannot be changed for Autodesk license servers after the license server has been created. However, this setting may be enabled/disabled for Dassault at any time. | |||||||||||||||||||||||||||||||||
| Remote Monitoring tab | |||||||||||||||||||||||||||||||||
To view remote monitoring settings, toggle on Enable Remote Monitoring at the top of the Remote Monitoring tab (enabled by default). | |||||||||||||||||||||||||||||||||
| General settings | |||||||||||||||||||||||||||||||||
Query Tool Path | The path to the license manager's query tool defaults to license_statistics_installation_directory/query_tool_default_name, where the query tool default name is specific to the license manager being used, as follows:
Edit the path if needed, and make sure the query tool is in the specified path. Important: The query tool executable (and the path provided in the License Statistics UI) must be local. If you edit the path, ensure that the query tool executable is located on the same machine as the License Statistics installation. Query Tool Path is not applicable when using the Custom, Autodesk, JetBrains, License4J, oXygen and Zoo license manager types. | ||||||||||||||||||||||||||||||||
| Encoding | Changes the encoding used by License Statistics when analyzing data from a license server. By default, this is set to UTF-8. For a list of supported encodings, see: https://docs.oracle.com/en/java/javase/13/intl/supported-encodings.html | ||||||||||||||||||||||||||||||||
| Locale | Applies only to Altium license manager type. This optional setting can be used to change the locale assumed by License Statistics when parsing output from the server. This setting is empty by default, and should be specified only if necessary. A list of available locale values can be found at https://www.oracle.com/java/technologies/javase/jdk17-suported-locales.html, under the Language Tag column. | ||||||||||||||||||||||||||||||||
| Query Interval | Time in minutes between each license server query. Choose between 1, 2, 5 (default), 10, 15 and 20 minutes. | ||||||||||||||||||||||||||||||||
| Gathering Data | Toggle on data gathering for usage and/or denials (choices depend on license manager type selected). | ||||||||||||||||||||||||||||||||
| EPLAN Bundle | Applies only to EPLAN LM license manager type. See EPLAN Bundles for more information. | ||||||||||||||||||||||||||||||||
| Connection settings | |||||||||||||||||||||||||||||||||
Redundant | Check this box to specify that redundant servers are being used. For example, for LM-X, you would toggle on the Redundant setting if you are using a HAL (High Availability License) license server. When Redundant is checked, you must enter the hostname and port number for all three servers. For LM-X, the server order is indicated as "#1 HAL server," "#2 HAL server," and "#3 HAL server." The Redundant setting is applicable only for LM-X, FlexNet, BetaLM, Dassault, IBM LUM and GNS license manager types. | ||||||||||||||||||||||||||||||||
| Secured | Check this box to force HTTPS connection for servers using HTTP monitoring. The Secured setting is applicable for oXygen, JetBrains, Zoo and CodeMeter license managers only. | ||||||||||||||||||||||||||||||||
| Hostname | The license server hostname. This entry must be a hostname or domain value, and cannot contain spaces, special characters (underscores, hyphens and periods are allowed), or protocols (e.g., "http(s)://"). | ||||||||||||||||||||||||||||||||
| File Path | For Custom license servers, the Hostname field (described above) is replaced by a "File Path" field, which is used to provide the path to the file to be monitored. | ||||||||||||||||||||||||||||||||
| Port | The license server port number, which may have a default setting depending on the license manager selected, as follows.
The Port number setting is not applicable when using the IBM LUM, LICMAN, Sentinel RMS, MathLM, and Custom license manager types. | ||||||||||||||||||||||||||||||||
| Login | The username to access protected resources. This setting is applicable only for JetBrains and oXygen license manager types. | ||||||||||||||||||||||||||||||||
| Password | The password to access protected resources.. This setting is applicable only for LM-X, Dassault, JetBrains and oXygen license manager types. | ||||||||||||||||||||||||||||||||
| Importing tab | |||||||||||||||||||||||||||||||||
To enable importing the logfile using the License Statistics UI or API, toggle on Enable Importing at the top of the Importing tab. There are no settings for the Importing tab. | |||||||||||||||||||||||||||||||||
| End User Monitoring tab | |||||||||||||||||||||||||||||||||
| This tab currently applies only to the Autodesk license manager type. To view End User Monitoring settings, toggle on Enable End User Monitoring at the top of the End User Monitoring tab. | |||||||||||||||||||||||||||||||||
| Agent Groups | Agent Group(s) that will be used to automatically monitor Autodesk applications on their hosts. This setting is applicable only for the Autodesk license manager type. | ||||||||||||||||||||||||||||||||