How to set Service ID while manually editing the TIBCO Spotfire Automation Services configuration files

Date Posted: 2019-05-21
Product: TIBCO Spotfire®

Problem:

Solution:

After exporting the configuration for your service (export-service-config), manually editing the configuration files for automation services, and importing them (import-service-config), you can activate the customized configuration for an existing TIBCO Spotfire Automation Services via the command line using "set-service-config" by passing Service ID value and the Configuration name.
Note: Steps to export and import configuration for your service are mentioned in the Reference section.

While running "set-service-config" command to set the Service ID in command line to activate the customized configuration, you may face an error like this:

Error: C:\tibco\tss\7.10.0\tomcat\bin>config set-service-config --service-id=ServiceValue --config-name=AutomationServicesConfiguration
Invalid parameter value: ServiceValue
Usage: set-service-config [-b value | --bootstrap-config=value]
        [-t value | --tool-password=value] [-k value | --keystore-file=value]
        <-s value | --service-id=value> [-c value | --config-name=value]
        [-f | --force]

Note: For Spotfire versions 10.3 and higher, the config tool command will instead be located in the /tomcat/spotfire-bin/ folder The below steps can be followed to resolve the "Invalid parameter value" issue.

The Service ID value (ServiceValue) can be obtained from the below steps.

1) Log into Spotfire Server web interface:

Spotfire Server > Nodes&Services > Select Automation Services in the left panel > Copy the "Automation Service ID" from the details section on right side.

2) From command line, export the existing configuration, make the required changes in the configuration files, and import the configuration using export-service-config and import-service-config commands. The configuration setting commands like export-service-config, import-service-config, set-service-config can be executed in the command line in the bin path of tomcat folder (for example, C:\tibco\tss\7.10.0\tomcat\bin).

3) Now run the "set-service-config" in command line by passing the copied ID value (for example, xxx-yyy-zzz) from Step 1 and the configuration imported in Step 2. For example:

C:\tibco\tss\7.10.0\tomcat\bin>config set-service-config --service-id="xxx-yyy-zzz" --config-name=AutomationServicesConfiguration

This step helps in activating the customized configuration for your service without any errors. Doc: Manually editing the service configuration files: