Licensing Guidelines

The following article describes the various license or activation guidelines that are implemented in XTAM, why you may be out of compliance with your activated key and how to bring yourself back under compliance.

Of note, the license guidelines messages will only appear to those users with either the System Administrator or Auditor global role.

Application Node License

When activated, your license key contains a total number of Application Nodes that you have been issued.

When the total number of configured Nodes in your XTAM deployment exceeds your license amount, the following message will appear within the software where x represents the total number of nodes allowed and y represents the total number of nodes currently in your deployment:

 

The application exceeded a number of x licensed nodes. Please remove any inactive nodes from your existing count of y using the Administration / Settings / Application Nodes page or contact your account representative for additional information.

To view the current Application Nodes in your deployment, navigate to the Administration > Settings > Application Nodes tab.

On this page, each Application Node will be displayed and is calculated by the number of unique nodes deployed.

A unique node is considered one that has a unique Host Name.

 

For instance, the following represents a common scenario where two application nodes are listed but are only counted as one because they have the same Host name xtamServer:

Copy
xtamServer:Worker
2.3.201907212255 / 07/26/2019 12:04
xtamServer:GUI
2.3.201907212255 / 07/26/2019 12:04

 

Another instance represents a common scenario where XTAM is configured in a High Availability configuration where four application nodes are listed but are only counted as two:

Copy
xtamServerNode-A:Worker
2.3.201907212255 / 07/26/2019 12:04
xtamServerNode-A:GUI
2.3.201907212255 / 07/26/2019 12:04
xtamServerNode-B:Worker
2.3.201907212255 / 07/26/2019 12:04
xtamServerNode-B:GUI
2.3.201907212255 / 07/26/2019 12:04

 

If you find yourself out of compliance with your Application Node license guidelines, then the following options are available to bring yourself back into compliance:

  • Uninstall or shutdown unused or extra nodes from your XTAM server farm. After that, remove these nodes from your vault by clicking the Edit button located in your node’s Actions menu and then click the Remove button. When the node appears online again, it will create a configuration record in the list of Application Nodes again with the default configuration. Or:
  • Contact your Account Representative to purchase additional Application Nodes for your license.

Remote Session Manager Node License

Similar to the above Application Nodes, you are also restricted by the number of Remote Session Manager nodes that can be included within your licensed XTAM deployment.

When the total number of configured Session Manager Nodes (known as Proximity Groups) in your XTAM deployment exceeds your license amount, the following message will appear within the software where x represents the total number of Proximity Groups allowed and y represents the total number of Proximity Groups currently in your deployment:

 

The application exceeded a number of x licensed remote session manager nodes. Please remove any inactive session managers nodes from your existing count of y nodes using the Administration / Settings / Proximity Groups page or contact your account representative for additional information.

To confirm your current deployment of Session Manager Nodes or Proximity Groups, navigate to the Administration > Settings > Proximity Groups tab. Each Proximity Group listed will be counted towards the license regardless of its current connectivity status.

 

If you find yourself out of compliance with your Remote Session Manager Node license guidelines, then the following options are available to bring yourself back into compliance:

  • Remove any additional unused or extra nodes from your deployment by clicking the Edit button located in your proximity group’s Actions menu and then click the Delete button. This will permanently remove this node from your XTAM deployment so please understand the significance of each proximity group before removing it from your deployment. Or:
  • Contact your Account Representative to purchase additional Remote Session Manager Nodes for your license.

User Count License

When activated, your license key may contain a total number of Users that are permitted to use XTAM. When the total number of Users in your XTAM deployment exceeds your licensed amount, the following message will appear within the software where x represents the total number of users allowed and y represents the total number of users currently in your deployment.

 

The application exceeded a number of x licensed users. Note that the User Access report is collected once a day so there could be delay in calculation. Please review your Access Report, listing y users, located at Administration / Global Permissions / Access Report or contact your account representative for additional information.

 

A user is counted against the license when they have been given permission to access an object in XTAM, regardless if they ever logged in and accessed it. Keep in mind that users can be given permission to an object directly or by simply being a member of a group that was given permission to an object.

To generate a report containing your current list of licensed Users, navigate to Administration > Global Permissions > Access Report.

This report will list all users that have permissions to access any object within XTAM and the level and means by which they are granted this access.

 

 

If you find yourself out of compliance with your User Count license guidelines, then the following options are available to bring yourself back into compliance:

  • Remove the permissions of any unused, test or extra Users from your XTAM objects. This can be done by finding the user(s) in the Reports > Users report, using the View Objects option to determine which objects they have permissions to and then removing them where necessary. Once all permissions have been removed for the user, they will no longer be counted towards the license’s User Count. Or:
  • Contact your Account Representative to purchase additional Users for your license.

Record Count License

When activated, your license key may contain a total number of Records that are permitted to be created in XTAM.

When the total number of Records in your XTAM deployment exceeds your licensed amount, the following message will appear within the software where x represents the total number of records allowed and y represents the total number of records currently in your deployment.

 

The application exceeded a number of x licensed records. The current count is y. Please remove any extra records or contact your account representative for additional information.

To generate a report containing your current list of Records, navigate to Reports > Inventory.

This report will list all objects that are currently within the XTAM Identity Vault.

In the Inventory Report’s Search box, enter the query records to filter out all Vaults and Folders so you have a complete report of only the Records.

 

If you find yourself out of compliance with your Record Count license guidelines, then the following options are available to bring yourself back into compliance:

  • Delete any records that are no longer needed such as those that were being used for testing. Or:
  • Contact your Account Representative to purchase additional Records for your license.

Expiration License

When your license expires, you will still have full access to all objects within XTAM; however, you will not be permitted to create new Vaults, Folders or Records.

When your license has expired, you will see the following message:

The application license has expired. Please contact your account representative for additional information.

And if anyone attempts to create a new record, they will receive the following message:

New records cannot be created because the license has expired.

New folders cannot be created because the license has expired.

To extend or renew your license, you must contact your Account Representative.