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 the number of users assigned different product licenses and the number of library items of different types. 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 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). 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.
Number of library items of different types over time.

How is data stored and logged?: The data used to generate a deployment report is stored in the Spotfire 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 in version 14.5.0 and later is more 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

Filename Description Aggregation period

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`.
`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

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 modified items of the type.
`Created items`	The total number of created items of the type.

Daily