How to update the Web Player URL used while generating absolute URLs when saving analysis files as a library item with the Spotfire Analyst client

Product:TIBCO Spotfire Analyst
Versions:All

Summary:
How to update the Web Player URL used while generating absolute URLs when saving analysis files as a library item with the Analyst Client.

Details:
When saving an analysis file to the library from the TIBCO Spotfire installed client, it is useful to instantly see the URL of that analysis. It may be required to update the initial host name/directory which Spotfire uses to generate that absolute URL for the analysis file. This is most often required when there is a load balancer in front of a cluster of TIBCO Spotfire Servers, but there can be multiple scenarios where this may be needed. The process for this can depend on the exact Spotfire version and is described below.

Resolution:

By default, the installed Analyst client will use the host name of the TIBCO Spotfire Server when generating absolute URLs. For example:

• http://myServerHostName/spotfire/wp/OpenAnalysis?file=/myFolder/myReport

 

Version 7.6 and higher:

You can also explicitly provide a public address/endpoint which will be used when generating absolute URLs. It should always be configured and enabled if Spotfire Server is accessed through a load balancer or reverse proxy. To do this use the following commands, depending on the version of the TIBCO Spotfire Server:

• Version 7.9 and higher:set-public-address 
• Version 7.8: config-public-address
• Version 7.7 and 7.6: config-public-endpoint

For example:

• Version 7.9 and higher: config set-public-address --enabled=true --url="http://serverAlias"
• Version 7.8: config config-public-address --enabled=true --url="http://serverAlias"
• Version 7.7 and 7.6: config config-public-endpoint --enabled=true --url="http://serverAlias"

This will result in URLs like:

• http://serverAlias/spotfire/wp/OpenAnalysis?file=/myFolder/myReport

To update your server configuration with this new setting, here are the full instructions:

1. Launch a command prompt on the Spotfire Server machine as Administrator and browse to \tomcat\bin folder
2. Export the current configuration using the following command:
   • config export-config --force (this will export the configuration to the default \tomcat\bin folder as configuration.xml
3. Run the following command:
   • Version 7.9 and higher: config set-public-address --enabled=true --url="http://serverAlias"
   • Version 7.8: config config-public-address --enabled=true --url="http://serverAlias"
   • Version 7.7 and 7.6: config config-public-endpoint --enabled=true --url="http://serverAlias"
4. Import the configuration using the following command:
   • config import-config --comment="Add a comment here"
5. Restart the Spotfire Server service

 

Version 7.5:

In Spotfire version 7.5, the Analyst client does not use the public endpoint/address as described above above. In this case, the installed Analyst client will only use the host name of the Spotfire Server when generating absolute URLs.

 

Version 7.0 and earlier:

In the "Administration Manager", set the "DXPLibraryWebURL" preference with the base Web Player URL as needed. If this preference is not set, the direct URL for the analysis will not be presented when saving analysis files as library items. This is done here:

• Administration Manager > Preferences > Everyone (or other desired group) > Application > ApplicationPreferences > DXPLibraryWebURL: http://myWebPlayer/SpotfireWeb/