Manually editing the service configuration files

The service configuration files give you access to options that are not available in the Spotfire Server administrative interface. You can use the default configuration files as a template to create and import as many customized service configurations as your Spotfire implementation requires. You can then apply the customized configurations to new or existing Spotfire Automation Services or Spotfire Web Player services.

Procedure

  1. On the computer running Spotfire Server, open a command line as an administrator and change the directory to the location of the config.bat file (config.sh on Linux). The default location is <server installation dir>/tomcat/bin.
  2. On the command line, export the service configuration that you want to modify from Spotfire Server by using the export-service-config command. Specify the service's capability and the deployment area, and optionally the configuration name.
    Note: By default, all new services receive a "Default" configuration. The properties of the default configuration cannot be changed, but you can edit the configuration files and import the resulting customized configuration with a specified name.
    Important: If you are editing a service configuration that has been applied to an existing service, you must verify the name of the active service configuration before you export it. If the name of the active configuration is not "Default", you must specify the name in the export command.
    Example for exporting the "Default" Spotfire Automation Services configuration that is in the Production deployment area:
    config export-service-config --capability=AUTOMATION_SERVICES --deployment-area=Production
    Example for exporting a customized configuration:
    config export-service-config --config-name=AutomationServicesConfiguration
    The following configuration files are exported. By default, these files are saved to the <server installation dir>\tomcat\bin\config\root directory.
    • Spotfire.Dxp.Worker.Automation.config (for Automation Services only)
    • Spotfire.Dxp.Worker.Core.config
    • Spotfire.Dxp.Worker.Host.exe.config
    • Spotfire.Dxp.Worker.Web.config
    • log4net.config
  3. Edit the exported configuration files in a text editor or XML editor. For details about these files, see Service configuration files.
  4. On the command line, import the customized configuration file back into Spotfire Server and name the configuration by using the import-service-config command.
    Note: If the configuration to be imported was created from the default configuration, a name must be specified.
    Important: If you are editing already customized configuration files, specifying a name when importing will create a new service configuration. If you import the changed customized configuration without the --config-name parameter, the old customized configuration will be replaced.
    config import-service-config --config-name=ServiceConfiguration
    When you install a new service or edit an existing one, you can select the customized configuration.
  5. Optional: To activate the customized configuration for an existing service, run the following command on the command line:
    config set-service-config --service-id=value --config-name=ServiceConfiguration
    Tip: Use the list-services command to obtain the service ID.
    Note: Activating the configuration for a Spotfire Web Player service causes its web clients to restart.