Spotfire® Server and Environment - Installation and Administration

Switching off library versioning

A new version of all files is by default kept each time a file is updated in the library. As an administrator, you have the option to switch off version history for your Spotfire environment. Use the command line configuration tool and set library.versioning.enabled to false to disable library versioning completely. You can also choose to exclude certain item types only.

About this task

Note: With version history enabled, there is a risk that data that should have been removed remains in the library, in an older version of the analysis. For example, if a piece of sensitive data by mistake gets embedded into an analysis and later is removed, the old versions of the analysis that contain the sensitive data should also be deleted.

Before you begin

You must have administrative credentials for Spotfire Server.

About this task

Tip: A Spotfire Analyst author can switch off library versioning for a specific analysis file from the Document Properties dialog, using the Keep older versions of this file when saving check box on the Library tab in the installed client.

Procedure

  1. Open a command-line interface and export the active configuration (the configuration.xml file) by using the export-config command. (For details on using the Spotfire command line, see Executing commands on the command line.)
  2. Use the following command to switch off library versioning:
    config set-config-prop --name="library.versioning.enabled" --value="false"

    Use the following command to disable library versioning for specific types of items (the example uses sbdf files and mods):

    config set-config-list-prop --name="library.versioning.disabled-types" --item-name="type" -Vspotfire.sbdf -Vspotfire.mod

    As a library administrator, you can change the default item property setting for all analyses in the library from having versioning on for all analyses by default to be off by default, and let the analysis authors specifically enable it for the most important analyses only.

    Use the following command to change the default setting for analysis files not to keep older versions by default:

    Note: If you change this setting, only analysis files can be under version control (if opted in by authors) because there is currently no support to switch it on for other item types.
    config set-config-prop --name="library.versioning.enabled-by-default" --value="false"
  3. Import the configuration file back to the Spotfire database by using the import-config command.

Server configuration example

The following is an example of a server configuration where the library versioning is enabled, but Spotfire mods have been listed as disabled-types:

<configuration>
  <library>
    <versioning>
      <enabled>true</enabled>
      <disabled-types>
        <type>spotfire.mod</type>
      </disabled-types>
    </versioning>
    ...
  </library>
  ...
</configuration>

See Spotfire item types for a list of available types.