Upgrading to 14.0.8 and 14.5.0: New license management

In versions 14.0.8 and 14.5.0 of Spotfire, new functionality has been added to make it easier to manage licenses and license features. Because of underlying changes to how the licenses work, you must upgrade the Spotfire Server before you deploy the new Spotfire client package and update your installed clients and Web Player services.

About this task

Note: The information in this article is relevant when you upgrade from any Spotfire version earlier than 14.5.0 that is not a 14.0 LTS service pack version 14.0.8 or later.

Tip: Setting the license model after upgrading

After upgrading, make sure you set the product license model in your Spotfire Environment according to your contract, to use either the new (Data Science, Analytics, Analysis Consumer, Analysis Viewer) or the legacy (Analyst, Business Author, Consumer) licenses. See Changing the product license version.

Why do you have to upgrade both the server and client?

If you have not upgraded the Spotfire Server before you deploy the new Spotfire client package, certain changed license features are not automatically assigned to the user groups that require them. This causes issues when starting and using updated clients and services:

Updated Web Player services cannot start, which means that you cannot use the Spotfire web client.
Note: On the node manager, the log file Spotfire.Dxp.Worker.Host.log will include the following error:
"The required license for the user to access the program is missing."
In updated installed clients, you cannot open analysis files.

Resolving issues: To resolve issues if you updated clients and services, see Resolving issues if you deployed the client before upgrading the server.

Upgrading Spotfire to a version with new license management

When you upgrade Spotfire to a version with the new license management, make sure you first upgrade the Spotfire Server, and then deploy the new Spotfire client package to update clients and services.

About this task

Before deploying the version 14.0.7 or later client package, upgrade the Spotfire Server to version 14.0.8 or later.
Before deploying the version 14.5.0 or later client package, upgrade the Spotfire Server to version 14.5.0 or later.

Procedure

Follow the instructions in Upgrading Spotfire.

Note: After the upgrade is complete, on the Upgrade Issues page, you can see a section about "Licenses migrated", which confirms that licenses in your environment were migrated successfully.
When the upgrade is complete, configure your Spotfire Server for whether you use the new or legacy licenses. See Changing the product license version.

Tip: To show how many of each product license you have available when you assign licenses in the Server administration pages, add the number of licenses of each type your contract includes to the Spotfire Server configuration. See Setting the maximum license assignment.
Optional: If you no longer have any deployment areas with client packages from earlier versions, and you no longer have any services or clients on earlier versions, you can clean out obsolete licenses. See Removing obsolete licenses and license features.

Resolving issues if you deployed the client before upgrading the server

If you deployed the client package before you upgraded the Spotfire Server, you must manually trigger the license migration after upgrading. If you need time to prepare, you can downgrade any clients and services you upgraded.

About this task

Note: Perform these steps only if you deployed a 14.0.7 or 14.5.0 client package before you upgraded the Spotfire Server to 14.0.8 or 14.5.0.

Migrating licenses after upgrading

To trigger the license migration manually after upgrading the Spotfire Server, you must first remove the Spotfire.Dxp.View license feature group from any group that was assigned it.

About this task

Procedure

Upgrade the Spotfire Server to version 14.0.8 or 14.5.0 or later. See Upgrading Spotfire.
When the upgrade is complete, on the computer running the Spotfire Server, open a command-line interface as an administrator in the directory that contains the file config.bat (config.sh on Linux).
To see which groups have license features from the Spotfire.Dxp.View license feature group, use the following command:
```
config show-licenses --licenses="Spotfire.Dxp.View"
```
This generates a log file that shows all groups in your environment with license features from the Spotfire.Dxp.View license feature group assigned. If you have not manually changed any license features after deploying the client package, only the Administrator group has the Spotfire.Dxp.View license assigned.
For each group that has license features from the Spotfire.Dxp.View license feature group, run the following command:
```
config remove-license -l="Spotfire.Dxp.View" -g="{{Group name}}"
```
Example:
```
config remove-license -l="Spotfire.Dxp.View" -g="Administrator"
```
To migrate to the new license management, run the following command:
```
config update-licenses --from-license-version=v1 --to-license-version=v2
```

Results

If the license migration is successful, all the updated license features are added to your environment and assigned to all the groups that should have them.

Downgrading clients and services to an earlier version

To resolve issues while you prepare to upgrade your Spotfire Server, you can deploy the previous version of the client package and downgrade your clients and services.

About this task

Note: If you upgrade the Spotfire Server right away, there is no need to downgrade your clients and services.

Procedure

Deploy the previous version of the client package (Spotfire.Dxp.sdn and/or Spotfire.Dxp.netcore-linux.sdn) to a deployment area.

Tip: If you use the same deployment area where you deployed the updated client package, you might have to clear the area by removing all existing packages before you can deploy the previous version client package. Select all the packages in the area, and then click Remove packages.
Downgrade your clients and services by updating them with the package you deployed:
- To downgrade Web Player services, go to the Network tab, select the Web Player service to downgrade, and click Update service.
- To downgrade an installed client, start the client and connect to the Spotfire Server. Select the deployment area where you deployed the previous version. When you are prompted to install the older version of Spotfire, click Install now.

Results

When you have downgraded the clients and services, you can start your Web Player services and use the installed client like normal.

Migrating licenses manually

If you cannot use the license migration after upgrading your Spotfire Server, or if you need to use an updated client while you prepare to upgrade, you can assign the View (Spotfire.Dxp.View) group of license features manually.

About this task

Warning: If you manually assign the View license feature group, instead of using the automatic license migration during the server upgrade or the update-licenses CLI command (see Migrating licenses after upgrading), you must verify that your groups have the intended license features after the upgrade. Some license features have changed, and they might have been added or removed from some groups.

See changed license features for the list of affected license features.

To use updated clients and services, after you have deployed the 14.0.7 or later client package, assign View (Spotfire.Dxp.View) to the following groups:

Scheduled Updates Users
Any group with users who should be able to use an installed Spotfire client or web client

Changed and deleted license features

The following are license features that have been changed in version 14.0.8 (14.0.7 client) and 14.5.0. Some license features have been moved to a different license feature group. Some duplicate license features have been deleted, because the same license features were included in multiple groups of license features.

Changed license features


License feature name	Old license feature group	New license feature group
Spotfire web client	`Spotfire.Dxp.WebPlayer`	`Spotfire.Dxp.View`
Create multiple windows	`Spotfire.Dxp.EnterprisePlayer`	`Spotfire.Dxp.View`
Open from library	`Spotfire.Dxp.EnterprisePlayer`	`Spotfire.Dxp.View`
Open linked data	`Spotfire.Dxp.EnterprisePlayer`	`Spotfire.Dxp.View`
Open file	`Spotfire.Dxp.EnterprisePlayer`	`Spotfire.Dxp.View`
Trust mods	`Spotfire.Dxp.Extensions`	`Spotfire.Dxp.EnterprisePlayer`
Trust external actions	`Spotfire.Dxp.Extensions`	`Spotfire.Dxp.EnterprisePlayer`
Access to extensions	`Spotfire.Dxp.Extensions`	`Spotfire.Dxp.EnterprisePlayer`
Author scripts	`Spotfire.Dxp.Extensions`	`Spotfire.Dxp.Professional`
Automation Services job builder tool	`Spotfire.Dxp.Extensions`	`Spotfire.Dxp.Professional`
Develop mods	`Spotfire.Dxp.Extensions`	`Spotfire.Dxp.WebAnalyzer`
Open/save local visualization mod	`Spotfire.Dxp.Extensions`	`Spotfire.Dxp.WebAnalyzer`
Open/save local action mod	`Spotfire.Dxp.Extensions`	`Spotfire.Dxp.WebAnalyzer`
Open visualization mod from library	`Spotfire.Dxp.Extensions`	`Spotfire.Dxp.WebAnalyzer`
Open action mod from library	`Spotfire.Dxp.Extensions`	`Spotfire.Dxp.WebAnalyzer`
Save visualization mod to library	`Spotfire.Dxp.Extensions`	`Spotfire.Dxp.WebAnalyzer`
Save action mod to library	`Spotfire.Dxp.Extensions`	`Spotfire.Dxp.WebAnalyzer`
Advanced aggregation methods Note: Changed in client version 14.0.8 and 14.6.0	`Spotfire.Dxp.Metrics`	`Spotfire.Dxp.WebAnalyzer`
Custom expressions Note: Changed in client version 14.0.8 and 14.6.0	`Spotfire.Dxp.Metrics`	`Spotfire.Dxp.WebAnalyzer`
Execute data function Note: Changed in client version 14.0.8 and 14.6.0	`Spotfire.Dxp.Metrics`	`Spotfire.Dxp.WebAnalyzer`
f(x) flyout Note: Changed in client version 14.0.8 and 14.6.0	`Spotfire.Dxp.Metrics`	`Spotfire.Dxp.WebAnalyzer`
Pin data functions Note: Changed in client version 14.0.8 and 14.6.0	`Spotfire.Dxp.Metrics`	`Spotfire.Dxp.WebAnalyzer`

Deleted duplicate license features


License feature group	Deleted license features
`Spotfire.Dxp.Professional`	Open file Open library data Create page Simple visualization properties Advanced visualization properties Change column selector Create bar chart Create waterfall chart Advanced data properties Create table Create cross table Create annotations Create line chart Create map chart Create parallel plot Create pie chart Create scatter plot Create KPI chart Create treemap Create combination chart Merge data Open information links Replace data Open empty data Simple filter panel properties Manage data tables Replace values in visualizations Error bars Insert new column Data panel Recommendations (before 10.0) Customize toolbar Data action recommendations
`Spotfire.Dxp.WebPlayer`	Create collaboration conversations View collaboration conversations Create multiple windows Use external actions
`Spotfire.Dxp.WebAnalyzer`	Recommendations (before 10.0)

Troubleshooting

If you notice differences in what functionality some groups have access to before and after upgrading to a version with the new license management, the following are some common troubleshooting steps.

Duplicate license features removed from Spotfire.Dxp.Professional not assigned correctly

License features that were previously available as duplicates in both the license groups Spotfire Analyst (Spotfire.Dxp.Professional) and Spotfire Business Author (Spotfire.Dxp.WebAnalyzer) have been removed from Spotfire.Dxp.Professional. User groups that before the upgrade only had the Spotfire.Dxp.Professional-versions of the license features, and who did not have any license features from the Spotfire.Dxp.WebAnalyzer group might not have gotten assigned the corresponding set of license features after the upgrade.

About this task

If you encounter this issue, you can repair the license assignment with the command repair-professional-license-migration. The command ensures that any group that had the obsolete license features from Spotfire.Dxp.Professional enabled also gets the corresponding license features in Spotfire.Dxp.WebAnalyzer.

Note: For the repair-professional-license-migration command to be able to automatically repair your license assignment, you must not have deleted the obsolete licenses from before the upgrade with delete-obsolete-licenses. If you have, the command instead produces a list of set-license commands that you can use to assign the moved license features to groups.

Procedure

On the computer running the Spotfire Server, open a command-line interface as an administrator in the directory that contains the file config.bat (config.sh on Linux).
Generate a list of the current assignment of license features in the Spotfire.Dxp.WebAnalyzer and Spotfire.Dxp.Professional license groups, for comparison purposes, with the following command:
```
config show-licenses --licenses="Spotfire.Dxp.WebAnalyzer,Spotfire.Dxp.Professional"
```
To start the repair process, run the following command:
```
config repair-professional-license-migration
```
For each group that the command manages to repair, a message is shown that reports the changes.

Generate a list of the updated license assignments with the following command:

config show-licenses --licenses="Spotfire.Dxp.WebAnalyzer,Spotfire.Dxp.Professional"

Compare the resulting license assignment with the list from before you ran the repair-professional-license-migration command, to verify that the updated license assignment is correct.

If the repair-professional-license-migration cannot automatically repair the license assignment, it instead produces a list of set-license commands that you can use to assign the moved license features to groups. Review the suggested commands before you run them, to ensure that license features are assigned correctly.

Moved license features from Spotfire.Dxp.Metrics to Spotfire.Dxp.WebAnalyzer not assigned correctly

About this task

In Spotfire version 14.6.0 and 14.0.9, the following license features are moved from the license group Advanced Analytics (Spotfire.Dxp.Metrics) to Business Author (Spotfire.Dxp.WebAnalyzer):

Advanced aggregation methods (advancedAggregationMethods)
Custom expressions (customExpressions)
Execute data function (executeDataFunctions)
f(x) flyout (fxFlyout)
Pin data functions (pinDataFunctions)

After deploying the client package, verify that the moved license features have been assigned correctly to all groups that should have them. When you deploy the client package, any group that had any license feature under Business Author (Spotfire.Dxp.WebAnalyzer) enabled is automatically assigned the moved license features, regardless if they had them under Advanced Analytics (Spotfire.Dxp.Metrics) before.

Important: To perform the verification steps below, the old versions of the license features must still be available in your environment. That is, you must not have run the command delete-obsolete-licenses after you deployed the client package.

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 get the list of groups that have the license groups Advanced Analytics and Business Author enabled, run the following command:
```
config show-licenses -l Spotfire.Dxp.Metrics,Spotfire.Dxp.WebAnalyzer
```
In the output licenses report file, verify that the new and old versions of the license features (advancedAggregationMethod, customExpressions, executeDataFunctions, fxFlyout, pinDataFunctions) are assigned correctly:
- Any group that has the license features enabled in Spotfire.Dxp.Metrics should have them in Spotfire.Dxp.WebAnalyzer.
- Any group that does not have the license features enabled in Spotfire.Dxp.Metrics also should not have them in Spotfire.Dxp.WebAnalyzer.
If you spot any discrepancies, assign or remove the new license features under Spotfire.Dxp.WebAnalyzer. See Setting the license and license features for a group.
Required: If you are using the legacy product license model (Analyst, Business Author, Consumer):
After you have verified that the moved license features are assigned correctly, make sure any group that should have the Business Author product license does not have the Advanced Analytics (Spotfire.Dxp.Metrics) license group enabled.

To remove the Advanced Analytics (Spotfire.Dxp.Metrics) license from a group, use the following command:
```
config remove-license -g "<Group Name>" -l Spotfire.Dxp.Metrics
```