For token licensing information for Maximo 7.6.1 and 126.96.36.199 systems, see the Token licensing for IBM® Maximo® Asset Management article on IBM Support (https://www.ibm.com/support/pages/token-licensing-maximo-asset-management).
Token licensing is a fixed-term license control method. You can use token licenses, which are also known as tokens, to license Maximo Asset Management, various Maximo industry solutions, and Maximo add-ons. The total number of tokens that you purchase is based on your predicted usage of the tokens. Tokens have a 1-1 relationship to license keys that you store and manage in IBM Rational® License Key Server. A request is sent from the Maximo server to Rational License Key Server whenever a token is consumed or released. The UserAnalyzer cron task in the Maximo system tracks and updates token usage data so that you can determine how tokens are being used.
Before you enable token licensing, consider the following information:
- Perpetual or non-token licenses and token licenses cannot be mixed on the same server.
- The License Usage Monitor application does not report on token licenses and cannot be used with token licensing.
You enable token licensing after you set up your Maximo system. To enable token licensing, you complete the following steps:
- Configure Rational License Key Server and Rational License Key Administrator.
- Configure the client file.
- Configure the Token Licensing Setup application.
- If you have IBM Maximo for Aviation, associate any custom security groups with similar, default security groups.
If you used token licensing for 7.6.1 and then upgraded directly to 188.8.131.52, you do not need to re-enable token licensing, but you must refresh the license keys for your system after you upgrade. For more information, see Refreshing the token license keys.
Token usage behavior
The installed Maximo products determine when tokens are consumed and released. The user's access type and whether multiple Maximo environments or sessions are used determines how many tokens are consumed. The following token usage rules apply only to 184.108.40.206.
Consumption and release of tokens
In most cases, tokens are consumed when a user logs in and released when a user logs out. When a user accesses an application that is part of an add-on product, the tokens that are consumed when the user logs in cover the add-on usage.
The following products uniquely consume and release tokens:
- For IBM Maximo Anywhere, tokens are consumed when the user accesses an application.
- For IBM Maximo APM - Asset Health Insights On-Premises, tokens are consumed when the Maximo server is running and released when the server is no longer running. Tokens are not consumed when users log in.
- For IBM Maximo Enterprise Adapter for Oracle Applications and IBM Maximo Enterprise Adapter for SAP Applications, tokens are consumed when the Maximo server is running and released when the server is no longer running. Tokens are not consumed when users log in.
No tokens are consumed for Maximo integration framework users for any Maximo product if the user logs in to a Maximo system as part of an automated process.
For all products, closing the browser does not release the tokens. If a user does not manually log out of the Maximo system before the browser or browser tab is closed, tokens are not released until the timeout value. The timeout value is specified in the web.xml file and is 30 minutes by default. If the timeout is longer than 30 minutes, token usage might be higher than expected. By default, every 5 minutes, the mxe.tokenlic.cleanupinterval property is used to scan the Maximo system for these inactive sessions. If a session is located, it is ended, and the tokens are released.
Access types determine how many tokens a user consumes. Access types are automatically assigned according to a user's security profile. Configure your users' security profiles to ensure that each user is assigned the access type that you want the user to have. If a product is installed in your system but no user has access to that product, that product does not impact the number of tokens that are consumed for any user.
Access types are assigned to users when the UserAnalyzer cron task runs. By default, the UserAnalyzer cron task runs daily. In the Token Licensing Setup application, you can edit the schedule for the cron task by selecting More Actions > Data Collection Settings. For access types to be accurately assigned, all installed Maximo products must be specified in the Token Licensing Setup application. You complete this step when you enable token licensing.
Access types are associated with licenses, and each access type inherits the qualities of the lower access types. For example, for a user to be assigned a limited access type, the user must qualify for limited and express access types. All users qualify for the self-service access type. All users can access the Maximo self-service applications, such as the Self-Service Requestor and the Desktop Requisitions applications, and that access does not affect the assigned access type.
The following access types are available:
|Access type||Assigned to||Tokens consumed|
Users who can access only the self-service applications.
Users who have read-only access to one or more applications, can change the status of records, and can update work orders that are assigned to them.
Fewer tokens than any other access type except for the self-service access type.
Users who can update data in three or fewer modules and have read-only access to one or more applications. For a user to be assigned a limited access type, the user must not be able to access the Administration module. Users can update work orders that are assigned to them, and the Work Orders module is not included in the three-module limit.
More tokens than the express access type but fewer tokens than the full access type.
Users who have read-only and update access to four or more modules.
The most tokens.
Multiple environments and sessions
If a single username is logged in to several Maximo sessions simultaneously, and each session involves identical Maximo products, tokens are consumed for only one session. If the sessions do not involve identical Maximo products, tokens are consumed for each session. If a user logs in to multiple, simultaneous sessions in multiple complete Maximo environments, such as a development environment, a test environment, and a production environment, the tokens are still allocated by username and product combination. A complete Maximo environment is a complete Maximo instance on its own database.
The following examples describe token usage when multiple complete Maximo environments and sessions are used:
- Example 1: A system administrator logs in to Maximo Asset Management in the development environment. After the system administrator logs in, the system administrator opens another browser and logs in to Maximo Asset Management in the production environment. Because the user ID and product combination is the same and the system administrator logs in to the development environment first, tokens are consumed only when the system administrator logs in to the development environment. Tokens are not consumed when the system administrator logs in to the production environment.
- Example 2: A system administrator logs in to Maximo Asset Management in the development environment. After the system administrator logs in, the system administrator opens another browser and logs in to an instance of Maximo Asset Management that includes an add-on in the production environment. The user ID is the same for each environment, but the products are different. Because the products are different, tokens are consumed when the system administrator logs in to the development environment, and more tokens are consumed when the system administrator logs in to the production environment.
If you have Maximo Enterprise Adapter installed on your system and you have multiple environments, when the Maximo server starts running, all environments consume individual sets of tokens and retain those tokens until the Maximo server stops running.
For example, you have a development environment, a test environment, and a production environment. When the Maximo starts running, each of those environments consumes Y tokens and retains those tokens until the Maximo server stops running.
Conditional token usage rules
If a user does not have an assigned access type or if products are not specified in the Token Licensing Setup application, other rules are used to determine when tokens are consumed and released and how many tokens are used. A user might not have an assigned access type if the user is a new user and the cron task has not had the opportunity to run. The rules for multiple sessions and environments still apply in these scenarios.
The following table describes these rules for a single user session in a single complete Maximo environment:
For more information about triads, review Configuring a license server on Microsoft™ Windows™ (https://www.ibm.com/support/knowledgecenter/SSSTWP_8.1.4/com.ibm.rational.license.doc/topics/r_redundant_servers_win.html) or UNIX™ (www.ibm.com/support/knowledgecenter/SSSTWP_8.1.4/com.ibm.rational.license.doc/topics/r_lic_server_unix.html).
The performance of a license server is directly proportional to the bandwidth and latency of the network that the license server is connected to. The consumption of network bandwidth is directly proportional to the number of users who are requesting tokens from the license server and the availability of tokens.
Performance is measurable in ping time. Ping time is the time that is required for a request to be sent from the Maximo server to the license server plus the time that is required for that request to be acknowledged by the license server. Any value that is less than the request timeout for the installed Maximo products is an acceptable ping time for the license server.
To improve performance, you might complete the following tasks when you set up your license servers:
- Connect your license server to a network that has a latency of at least 100 milliseconds (ms).
- Add a license server to the same geographical region as the users of that server.
- Use Linux® or UNIX for the license server. By using Linux or UNIX, you can have more control over the file descriptor size, which you can use to control performance. If the license server is running on Windows and more than 3000 users are requesting tokens, distribute the tokens across multiple license servers so that each license server is handing requests for no more than 3000 users.
Enabling token licensing
To enable token licensing, complete the following steps. Review the end of this document for troubleshooting information.
- Configure Rational License Key Server and Rational License Key Administrator.
- Configure the client file.
- Configure the Token Licensing Setup application.
- If you have Maximo for Aviation, associate your custom security groups with similar, default security groups.
- Verify your token enablement.
Configuring Rational License Key Server
To configure Rational License Key Server, install the product and then generate and import the license key for each license server.
- Install Rational License Key Server and Rational License Key Administrator.
- Download the files from Fix Central. For instructions, see the online product documentation (www.ibm.com/support/knowledgecenter/en/SSSTWP_8.1.6/com.ibm.rational.license.doc/topics/t_download_files_support.html).
- Complete the installation. For installation instructions, see the online installation product documentation (https://www.ibm.com/support/knowledgecenter/en/SSSTWP_8.1.6/com.ibm.rational.license.doc/topics/c_node_installing.html).
- For each license server, generate a license key.
- Log in to Rational License Key Center (https://www.ibm.com/support/pages/ibm-support-licensing-start-page).
- On the Get keys screen, click IBM Tokens.
- In the box for your product or unique sales order, in the LICENSE KEYS FOR THIS ORDER section, click the checkbox.
- Click Next.
- In the Number of keys to generate field, specify the number of tokens that you want to assign to the license server.
- In the Existing hosts and Server Configuration fields, select the options for your license server.
- In the Host ID Type field, select an option for the hardware that you are registering your key for.
- In the Host ID and Hostname fields, specify the values that are included in Rational License Key Administrator. To view this information, in Rational License Key Administrator, select License Keys > Host Data.
- Click Generate.
- For each license server, import and verify the license key.
- On the View Licenses By Host screen, click Download License Keys. To download and import the license key, complete the steps that are provided in the License Key Installation Instructions section.
- After the license key is imported, in Rational License Key Administrator, review the license key information and ensure that accurate Maximo products, license types, and license quantities are displayed.
To learn more about how to configure, administer, and use license servers, see the Rational License Key Server online product documentation (https://www.ibm.com/support/knowledgecenter/en/SSSTWP_8.1.6/com.ibm.rational.license.doc/helpindex_RCL.html).
Configuring the client file
You configure the client file for each Maximo server so that the Maximo server can communicate with its associated license server or servers.
- Download the client files.zip file, which is attached to this article.
- Extract the files from the client files.zip file. The client files.zip file contains two files. If you are using Windows, your client file is the rcl_ibmratl.dll file. If you are using Linux or UNIX, your client file is the librcl_ibmratl.so file.
- Relocate your client file to any directory that your Maximo server can access.
- Add the following text to the jvm parameter of the Maximo server. Replace the client file directory variable with your client file directory:
-Djava.library.path=client file directory
- Repeat these steps for all Maximo servers.
- Restart the application servers.
Configuring the Token Licensing Setup application
You use the Token Licensing Setup application to connect your Maximo system to Rational License Key Server and manage the installed products.
- Enable the Token Licensing Setup application.
- Log in to your Maximo system as the system administrator.
- In the Security Groups application, open the MAXADMIN security group.
- On the Applications tab, filter for token licensing setup and then select the Grant Access checkbox for the application.
- Save the security group.
- Log out and log back in to the Maximo system.
- In the Token Licensing Setup application, in the Server Address field, specify the addresses for your license servers.
- The format for a single address is port@hostname.
- If you are using Linux or UNIX, separate multiple addresses by using colons (:).
- If you are using Windows, separate multiple addresses by using semicolons (;).
- Separate multiple addresses for redundant license servers or a triad by using a comma (,).
- If you specify a hostname that is not fully qualified, the connection to the server might not be established. If the connection is not established, specify a fully qualified hostname.
If you are using stand-alone license servers, the order of the servers in the field determines the order that license servers are used to complete at token request if one of the license servers cannot complete a request. For example, if you specify A;B;C and server A cannot complete a request, server B is used to complete the request.
- Click Test. If the connection is successful, a confirmation message is displayed.
- If the connection is successful, click Save. The server addresses are added to the mxe.token.licensepath system property. Do not click Save unless the connection is successful.
- Add the Maximo products that are installed in the current environment to the Manage Products dialog box.
- In the More actions menu, click Manage Products.
- In the Manage Products dialog box, click New Row.
- In the Product Name field, select an installed product.
- In the License Type field, select the license type.
- Click OK and save the row.
- Change the status of the row to active.
- Repeat these steps for all other installed products.
If you have Maximo for Aviation, you must associate custom security groups with default security groups. The default security groups are the security groups that are provided with your purchase of Maximo for Aviation. Custom security groups include cloned security groups. When security groups are associated, the custom security group impacts token usage and access type assignment identically to the default group. The custom group must provide equal or fewer security privileges than the similar group, and a custom group can be associated with only one similar group.
- In the Token Licensing Setup application, in the More actions menu, click Associate security groups.
- Click New Row.
- In the Custom Group field, select a custom security group.
- In the Similar Group field, select a similar, default security group.
- Save the row.
To verify that token licensing is enabled, generate token information from each of your license servers.
Before you begin, ensure that the following events occurred in the following order:
- The UserAnalyzer cron task ran. Access types are not assigned to users until the cron task runs. If a user who does not have an assigned access type logs in, the token usage by that user might be higher.
- Actions that cause tokens to be consumed have occurred. For example, ensure that the Maximo server is running and that users of varying security permissions logged in to the Maximo system.
- The UserAnalyzer cron task ran again. The first time that the cron task ran, access types were assigned, but because no users had logged in prior to the cron task running, token usage was not reported.
Then, complete the following steps:
- In a command line, open the Rational License Key Server directory.
- Run the following command. Replace the port and hostname variables with the port and hostname of the license server.
lmutil lmstat -a -c port@hostname
If token licensing is enabled, the output contains license server details, feature names, and the times and number of tokens that were consumed.
Refreshing the license keys
If you used token licensing for 7.6.1 and upgraded directly to 220.127.116.11, you must refresh the license keys. You do not need to re-enable token licensing for 18.104.22.168.
- Log in to Rational License Key Center and click View keys by host.
- For each of your license servers, complete the following steps:
- Click Refresh.
- Download the new license key.
- In Rational License Key Administrator, click License Keys > Import License Key(s).
- Import the new license key into the license sever.
In Rational License Key Administrator, review the license key information and ensure that accurate Maximo products, license types, and license quantities are displayed.
Connection is not established with the license server
In the Token Licensing Setup application, if the connection to the license server is not successful, ensure that the license server is running. Then, from the Maximo application server host machine, use telnet to connect to the lmgrd port of the license server.
An unsuccessful connection to the license server is saved
In the Token Licensing Setup application, if an unsuccessful connection to the license server is saved, you can undo the configuration by running the following database query:
select * from propvalue where propname='mxe.tokenlic.licensepath';
Then, by running the following database query:
update maxpropvalue set propvalue=null where
License server cannot complete a token request
A license server can be unable to complete a request for the following reasons:
- The network or firewall that is used for the license server is unavailable or the quality of the network is poor. If a poor network is used, the requests might time out before the requests reach the license server. For more information about improving performance, see Server configuration options.
- The user who requests the tokens is blocked from the license server. You can block or unblock users from a license server by using the license option file.
- The license server has no available tokens. Consider purchasing more tokens or review your users' security profiles to ensure that security profiles are not increasing a user's access type unnecessarily.
- Many users are simultaneously requesting tokens from a license server. If many users are requesting tokens, the Maximo system can be unresponsive and long delays can occur between the time that the tokens are requested and when the tokens are provided. Consider purchasing more tokens or improving the system or server performance. For more information, see Server configuration options.
- A significant time zone difference exists between the license server and the Maximo server. In this case, the following error occurs in the license server log file after a license request is sent: Licensing Error: Clock Difference too large between client and server. Geographically align your license server with the associated Maximo server.
Token Profile tab shows excessive token usage
If an erroneously high number of token licenses is tracked on the Token Profile tab in the Users application, complete the following steps:
- In the Application Designer application, open the Users application.
- Click the Token Profile tab and then right-click the Token Licenses table.
- In the Table Properties dialog box, clear the Business Object field.
- Save your changes.
The BMXAA4214E error occurs for UserAnalyzer cron task
If the BMXAA4214E error occurs for the UserAnalyzer cron task, ensure the latest interim fix for the Maximo system is installed and then complete the following steps:
- In the maximo_root/deployment directory, open the buildmaximoear.xml file.
- Append the following text to the end of the maximo.businessobjectsclasspath property: lib/license_metric_logger_22.214.171.124507131115.jar
- Rebuild and redeploy the EAR file..
The following text is an example of this change:
<property name="maximo.businessobjectsclasspath"> lib/license_metric_logger_126.96.36.199507131115.jar
Was this topic helpful?
02 August 2021