Configuration Blocks Cannot Be Used When Opening a Local or UNC-Path DXP File with the /file: Command Line Parameter

Keywords:
configuration block, configurationBlock, command line, Spotfire.Dxp.exe, /file:, /uri:, /server:, tibcospotfire:, local DXP, UNC path, network share, Spotfire Library, document property, open analysis with parameters, TS-I-7968, Spotfire Analyst
 

Introduction: This article explains why you can't pass a configuration block when you open a local or UNC-path DXP file from the command line with the /file: parameter. It also shows how to open an analysis with a configuration block when the file is stored in the Spotfire Library.

Confirmed Behavior:

Example:

A user wants to open a DXP file saved on their computer or on a network share (for example, \\server\share\MyAnalysis.dxp) with Spotfire.Dxp.exe /file:. They also want to set the document property "testParam" when the file opens. The /file: parameter has no way to pass a configuration block, so the value isn't applied. If the same analysis is stored in the Spotfire Library and opened with /uri:, the configuration block works.

Process Steps:

1. Check Where the Analysis Is Stored
   • If the DXP file is in a local folder or on a UNC path, you can't pass a configuration block with /file:. Go to Step 2.
   • If the analysis is already in the Spotfire Library, go to Step 3.
2. Save the Analysis to the Spotfire Library
   • Open the DXP file in Spotfire Analyst and save it to a folder in the Spotfire Library. Note the Library path, for example /MyFolder/MyTestFile.
3. Open the Library Analysis from the Command Line with a Configuration Block
   • Use the /server: and /uri: parameters and add the configuration block to the analysis path. For example, to give the document property "testParam" the value "param value": 
     Spotfire.Dxp.exe /server:http://myserver/ /uri:analysis:/MyFolder/MyTestFile:configurationBlock:testParam=%22param%20value%22;
   • You can also use the tibcospotfire: format: 
     Spotfire.Dxp.exe tibcospotfire:server:https\://myserver/:analysis:/MyFolder/MyTestFile:configurationBlock:testParam=%22param%20value%22;
   • Note: Replace the server URL, Library path, property name, and value with your own. Keep the configuration block URL encoded.
4. Check the Result
   • After the analysis opens, check that the document property or parameter has the value you passed in the configuration block.
5. Vote for the Enhancement Request
   • If you need configuration blocks for local or UNC-path files, vote for TS-I-7968 on the TIBCO Ideas portal.
6. Contact Revvity Signals Support
   • If the problem continues, contact Support. Include your Spotfire Analyst version and build number, your Spotfire Server URL, the full command line you used (with sensitive values removed), where the analysis is stored (Library, local, or UNC path), and screenshots of any errors.

Key Findings:

• This Is a Product Limitation:
  • The /file: command line parameter can't pass a configuration block. TIBCO has confirmed this.
• Configuration Blocks Need the Spotfire Library:
  • Configuration blocks work with analyses opened from the Spotfire Library through /uri: or a tibcospotfire: link.
• The Configuration Block Must Be URL Encoded:
  • Encode special characters, such as double quotes (%22) and spaces (%20), in the configuration block.
• An Enhancement Request Exists:
  • Support for local or UNC-path files is tracked in TIBCO Idea TS-I-7968.

Critical Note: You can't pass a configuration block when you open a local or UNC-path DXP file with the /file: command line parameter. To open an analysis with a configuration block, save it to the Spotfire Library and open it with /server: and /uri:analysis:<Library path>:configurationBlock:<URL-encoded block>, or with a tibcospotfire: link. To request support for local files, vote for TIBCO Idea TS-I-7968.