Viewing and managing licenses in your Spotfire environment

You can manage and get an overview of how you have assigned licenses in your Spotfire environment on the Spotfire Server administration pages.

About this task

You also have various options for how to show and count licenses in your environment.

On this page

Getting an overview on the Groups page

About this task

The Groups page of the Spotfire Server administration pages is your primary way to get a quick overview of licenses. There you can see how many licenses of each type you have assigned to users in your environment, what groups have a certain license, and you can manage each group's licenses and license features.

When you view and assign licenses on the Groups page, you see and select the licenses according to the currently configured product license version in your environment. To change between the new and legacy licenses, see Changing the product license version.

Tip: To filter the list to show only the groups that have a certain license, click the quick filter for the license type of interest.

Counting the number of licenses assigned with CLI commands

Another way to get a count of the number of named users that are assigned each product license is to use a command-line interface. See Count license features and named-user licenses.

Changing the product license version

You can configure your Spotfire environment for the license model you use; the new licenses (Data Science, Analytics, Analysis Consumer, Analysis Viewer) or the legacy licenses (Analyst, Business Author, Consumer). This makes it easier to assign and manage licenses according to your contract.

About this task

Important: As a Spotfire administrator, you are responsible for assigning licenses to user groups so that your company's use of Spotfire complies with the product licenses defined in the commercial agreement.

The product license model (new or legacy licenses) to use in your environment is determined by your current contract. If you are not sure about the product license model of your contract, contact your Spotfire Account team.

When your commercial agreement is updated to use the new product licenses (Data Science, Analytics, Analysis Consumer, Analysis Viewer), you must change the license model in your environment accordingly.

Procedure

On the computer running the Spotfire server, open a command-line interface in the directory that contains the file config.bat (config.sh on Linux).
Export the active server configuration with the export-config command.
With the set-config-prop command, set the property licenses.version in the exported configuration file:
- Legacy licenses (Analyst, Business Author, Consumer)
```
config set-config-prop -n licenses.version -v 1
```
- New licenses (Data Science, Analytics, Analysis Consumer, Analysis Viewer)
```
config set-config-prop -n licenses.version -v 2
```
With the import-config command, import the updated configuration back into the Spotfire database.
Restart the Spotfire server.

Setting the maximum license assignment

You can add information about how many licenses your contract includes with the CLI command set-named-user-licenses-assignment. Then, in the licenses overview on the Groups page, you can see the maximum license assignment for each license type in relation to how many users you have currently assigned the license.

About this task

Note: Adding a maximum number for a certain license type does not prevent you from assigning the license to more users. Displaying the maximum number simply enables you to see how your current license assignment relates to that number.

Procedure

On the computer running Spotfire server, open a command-line interface in the directory that contains the file config.bat (config.sh on Linux).

With the set-named-user-licenses-assignment command, add the maximum license assignment information:

Setting a maximum number for Consumer, Business Author, and Analyst licenses

config set-named-user-licenses-assignment -v=1 -L"Spotfire.Dxp.Consumer"=1000 -L"Spotfire.Dxp.BusinessAuthor"=500 -L"Spotfire.Dxp.Analyst"=100

Setting a maximum number for Analysis Viewer, Analysis Consumer, Analytics and Data Science licenses

config set-named-user-licenses-assignment -v=2 -L"Spotfire.Dxp.AnalysisViewer"=1000 -L"Spotfire.Dxp.AnalysisConsumer"=500 -L"Spotfire.Dxp.Analytics"=100 -L"Spotfire.Dxp.DataScience"=50

Removing obsolete licenses and license features

You can remove obsolete licenses and license features that are not available in any client distributions deployed to your deployment areas.

About this task

If you have a Spotfire environment that you have upgraded from earlier versions, obsolete licenses and license features might have accumulated over time. This can make it difficult to navigate the list when you are assigning license features to groups.

Note: Do not perform this task if you plan to continue using Spotfire clients and services from earlier versions in your environment.

Procedure

On the computer running Spotfire server, open a command-line interface in the directory that contains the file config.bat (config.sh on Linux).
To see if there are obsolete licenses in your environment, run the list-obsolete-licenses command.
```
config list-obsolete-licenses
```
To delete any obsolete licenses, run the delete-obsolete-licenses command:
```
config delete-obsolete-licenses
```
Important: If you still see duplicate license features after running the delete-obsolete-licenses command, check if you have old client distributions deployed to your deployment areas and remove them first.