How to get a list all users with "Spotfire Analyst" license from the Spotfire database

How to get a list all users with "Spotfire Analyst" license from the Spotfire database

book

Article ID: KB0070458

calendar_today

Updated On:

Products Versions
Spotfire Server All Versions

Description

This article describes a way to get a list of all users with the "Spotfire Analyst" license enabled, and more generally to get a report of all licenses set on the Spotfire Server and stored in the Spotfire database.

Issue/Introduction

How to get a list of all users with Spotfire Analyst license from the Spotfire database

Environment

All supported operating systems

Resolution

The show-licenses command can be used to create a report file that shows the licenses set on the server. On the computer running Spotfire Server, open a command line as an administrator and change the directory to the location of the config.bat file (config.sh on Linux). The default location is <server installation dir>/tomcat/spotfire-bin. This is where you execute commands. For example:
config show-licenses --expand-groups=true --force-overwrite=true

You can read the resulting file in Spotfire. The file has headers that explain the contents displayed in the columns. The column "From Group" contains the group on which the license is explicitly set. For every group that has a license set explicitly, the resulting groups and users (if the expand option is set) are shown once.

Users get the sum of all licenses (and functions). When you analyze the file, note that a user and a license might occur more than once if the user gets its licenses from more than one group with explicit licenses set.

Calculation of the number of licenses is as follows: 
  • The number of Spotfire Analyst licenses is equal to the number of unique users in all groups with the Spotfire Analyst (Spotfire.Dxp.Professional) license enabled. 
  • The number of Spotfire Business Author (Spotfire.Dxp.WebAnalyzer) licenses is equal to the number of unique users in all groups with the Spotfire Business Author license enabled, minus the number of Spotfire Analyst licenses.
  • The number of Spotfire Consumer licenses is equal to the number of unique users in all groups with the Spotfire Consumer (Spotfire.Dxp.WebPlayer) license or the Spotfire Enterprise Player (Spotfire.Dxp.EnterprisePlayer) license enabled, minus the number of Spotfire Business Author licenses, minus the number of Spotfire Analyst licenses.​​​​​​

Additional Information

Doc:  show-licenses