Deployment report

As outlined in the Spotfire license information, to ensure compliance with your subscription terms, you must provide metrics about your Spotfire environment at certain times. To facilitate this process, the required metrics are logged to the Spotfire database. You can download this data as a deployment report to provide to a Spotfire representative as requested.

The data in a deployment report includes historical metrics about, for example, the number of users assigned different product licenses, the extent to which certain license features are used, what Spotfire services you have deployed, and more. For details, see Deployment report contents.

Downloading a deployment report

As an administrator, you can download a deployment report for your Spotfire environment.

In a web browser, log in to the Spotfire server administration pages.
Click About Spotfire.
On the About Spotfire page, click Download deployment report.

Tip: You can also export the deployment report from a command-line interface or using the deployment report REST API:

To export the deployment report with the command-line interface, on the computer running Spotfire server, use the command deployment-report.
To learn how to use the deployment report REST API, you can browse the API in the Swagger UI on your Spotfire Server:
```
 http[s]://<host>[:<port>]/spotfire/api/swagger-ui.html?urls.primaryName=deployment-report
```

Result

The deployment report for your environment is downloaded to your computer as deploymentreport-[GUID]-[TIMESTAMP].zip.

Viewing the data

To inspect the data yourself, you can open the deployment-report.dxp analysis file in Spotfire, or you can open each separate .stdf data file in Spotfire.

The first time you open the analysis file, you must use an installed Spotfire client. Make sure all the data files are in the same directory as the .dxp file. When you open the analysis, in the Missing File prompt that appears, select Use the file found in the same directory as the analysis for all the data files.

If you want to open the analysis in a Spotfire web client, save the analysis to the library and embed the data files in the analysis by selecting Stored data in the data loading settings.

Deployment report contents

A deployment report contains various data files, in Spotfire Text Data Format (.stdf), that capture the usage and deployment of Spotfire in your environment. Included is also a pre-configured Spotfire analysis file (deployment-report.dxp) with useful visualizations of the data.

The data in the report gives an aggregated overview of:

Assigned product licenses over time, which helps to verify compliance with the license agreement.
Usage of product licenses, license features and services over time, which give insight into patterns and trends of the actual usage of product licenses and specific functionality.
System information such as the number of library items, Spotfire service instances and processors running each of the Spotfire services, which helps to verify compliance with the license agreement. It also provides data about the type of clients your Spotfire end-users use, for example the installed Spotfire client, the web clients, or the Spotfire mobile apps.

How is usage data stored and logged?: The data used to generate a deployment report is stored in the Spotfire database. As you use your Spotfire environment (for example, when end-users use Spotfire, when you perform administrative tasks, or when automated tasks run) various system information and events are logged to the database.
How much historical data does a deployment report include?: Data for the deployment report is stored in the Spotfire database from when you installed or upgraded to Spotfire Server version 14.5.0 or later, or a 14.0.x service pack version 14.0.8 or later. Data logged from earlier versions might be less granular.; All the stored data is used to generate the deployment report.

Data files

The data files in a deployment report contain data that captures different aspects of your Spotfire environment.

The table explains the different data files included in a deployment report.

Note: Each record in the data tables contains measures aggregated over a specific period, as defined by the columns From, To and Created. The measures capture information like how many unique users with a certain product license logged in during the aggregation period or how many information link jobs were run.

Filename Description Aggregation period

automationservices-task-counts.stdf

Information about the total number of executions of specific Automation Services task types during each aggregation period.

Columns


`Task`	The type of Spotfire Automation Services task. For example, `Spotfire.Dxp.Automation.Tasks.Tasks.OpenAnalysisFromLibrary`.
`Total`	The total number of times the task type has been run.

Daily

client-types.stdf

Information about the type of Spotfire clients used by end-users in your environment.

Includes the type of client, for example web client or installed client, as well as the Spotfire version or web browser version, and the total number of logins per client type per aggregation period.

Columns


`Client`	The type of Spotfire client. For example, `Spotfire Windows Client`, `Spotfire Analytics for iOS`, `Browser`.
`Version`	The version of the client. For example, Spotfire version, web browser version.
`Logins`	The total number of logins.

Daily

datafunction-executions.stdf

Information about the number of data functions per type that have been run during each aggregation period, as well as information about the type of client that initiated the data function and the target.

Columns


`Client`	The type of Spotfire client that initiated the data function. For example, `Spotfire Windows Client`.
`Data function type`	The type of data function. For example, `Spotfire.PythonScript.Executor`.
`Target`	Additional information about the data function instance. For example, `remote`, `local`.
`Total`	The total number of data functions of the type that have been run.

Daily

library-items.stdf

Information about the total number of library items, modified and created library items, per type.

Columns


`Type`	The type of library item. For example, `Connection data source`, `Data function`.
`Total items`	The total number of the library item type.
`Modified items`	The total number of modified items of the type.
`Created items`	The total number of created items of the type.

Daily

license-feature-usages.stdf

Information about the usage of each license feature, measured as the unique number of users who performed an operation associated with the license feature during the aggregation period.

The table includes information about the type of operation that the user performed. Some license features have multiple associated operations, giving a more nuanced view of how users apply the license feature functionality.

Note: An operation could be one that requires that the user has the license feature assigned (for example, creating a bar chart requires the Create bar chart license feature). Other operations associated with a license feature do not require that the user has the license feature assigned (for example, viewing a bar chart in an analysis does not require the Create bar chart license feature).

Columns


`Technical license group`	The technical name of the license feature group. For example, `Spotfire.Dxp.Extensions`.
`License feature`	The technical name of the license feature. For example, `access_to_extensions`.
`Assigned product license`	The type of product license assigned to the user performing the operation logged. For example, `Spotfire® Analytics`, `Spotfire® Data Science`.
`Operation`	The type of Spotfire action, associated with the license feature, that was performed and logged. For example, `Primary`, `Secondary`, `Viewed`, `Edited`.
`Target`	Additional information about the `Operation`. For example, `Panel`, `Visualization`, `Data`.
`Info`	Sometimes provides additional information about the usage of the `License feature` and the `Operation`. For example, `Spotfire.CheckBoxFilter` (for the `filterPanel` license feature), `stdf, txt` (for `OpenFileData` license feature)
`Usages`	The number of unique users that used the functionality.

Weekly

licenses.stdf

Descriptions and human-readable display names of licenses and license features. You can join this table with other data tables in the deployment report.

Columns


`Technical license group`	The technical name of the license feature group. For example, `Spotfire.Dxp.Extensions`.
`Technical license group name`	The display name of the license feature group. For example, `Spotfire Extensions`.
`Technical license group description`	A description of the license feature group.
`License feature`	The technical name of the license feature. For example, `access_to_extensions`.
`License feature name`	The display name of the license feature. For example, `Access to extensions`.
`License feature description`	A description of the functionality included in the license feature.

N/A

named-user-license-assignments.stdf

Information about how many users are assigned to the different product licenses at the sample time.

Columns


`Product license`	The type of product license. For example, `Spotfire® Analytics`, `Spotfire® Data Science`.
`Assigned`	The number of users assigned the product license type.
`Seats`	The number of available seats for the product license type. For the field to be populated, you must have set a maximum license assignment.

Daily

named-user-license-usages.stdf

Information about the usage of the product licenses you have assigned to users, measured as logins by unique users during the aggregation period.

Note: The number of unique users that have logged in while assigned a certain product license during the aggregation period might exceed the current number of users assigned that product license. This can happen if you have changed users' licenses during the period.

Columns


`Product license`	The type of product license. For example, `Spotfire® Analytics`, `Spotfire® Data Science`.
`Usages`	The number of logins by unique users.

Weekly

service-usage.stdf

Information about the usage of certain Spotfire services, such as Automation Services and Information Services.

Includes the total number of jobs run during each aggregation period.

Columns


`Type`	The type of Spotfire service usage. For example, `Automation Services total jobs` or `Information Services total jobs`.
`Total`	The total number of jobs run for the service.

Daily

system-usage.stdf

Information about the Spotfire services and system components in the Spotfire environment.

For each service or component, information such as the capability (for example, Web Player or Automation Services), the operating system, and number of instances and processors is included.

Columns


`Capability`	The type of Spotfire service or component. For example, `WEB_PLAYER`, `SPOTFIRE_SERVER`.
`Operating Systems`	The operating system of the computer running the service.
`Processors`	The number of processors.
`Instances`	The number of instances of the services.
`Info`	Additional information for some service types, such as the Spotfire Database type and version, and if the system is deployed with Kubernetes.

Daily