Subscribe to feed

 

TIBCO Spotfire URI Scheme

The TIBCO Spotfire URI scheme is used for providing links to items in the Library and capabilities related to the TIBCO Spotfire Server. The TIBCO Spotfire protocol handler is registered on all Windows client machines running TIBCO Spotfire 3.3 or later, which means that links can be used in emails, web pages, etc., to directly open analyses stored in the Library

Links to library items and bookmarks can be obtained from:

• LibraryLinks
• BookmarkLinks

 

Use the following syntax in the link:

tibcospotfire:<key1>:<value1>:<key2>:<value2>...<keyN>:<valueN>

server:[server URL]
|
(server:[server URL])
	analysis: [path]|[guid]
		(configurationBlock:[configuration block]|bookmark:[guid])
	|
	informationLink:[path]|[guid]
		(configurationBlock:[configuration block])
	|
	search:[search string]
		(orderBy: Title | Modified | Created | Accessed | ContentSize | Description)
		(maxResult: [non negative integer])
		(sortDirection: Ascending | Descending)
		(searchIn: [guid](,[guid])*)

Explanation: 
[Descriptive name of value]
(optional value)

Encoding

Values should be encoding according to the following scheme

Character	Escape sequence
"	\'
:	\:
\	\\

Explanation

Key	Value description
server	The url to the TIBCO Spotfire Server, can be used to make sure that clients connect to the correct server. [optional] When only this value exists it can be used to connect TIBCO Spotfire to different servers
analysis	The library identifier or path to the analysis that should be opened
informationLink	The library identifier or path to the information link that should be opened
configurationBlock	The configuration block that should be applied after the analysis or information link have been opened. [optional]
bookmark	The library bookmark that should be applied after the analysis have been opened [optional]
search	The library search string. See searching the library for more information
orderBy	Defines which property that should be used to order the search result.
maxResult	A non-negative integer that sets the maximum size of the search result. Default is that all results are returned (0).
sortDirection	Defines the sort direction of the order by property.
searchIn	Defines a list of library folders identifiers.

Usages

Links can be used

• When starting the application, see Command Line Parameters
• As links in a TextArea, links will be re-written so that the linked analysis will be opened in TIBCO Spotfire Professional for persons using that client and in TIBCO Spotfire Web Player for others, depending on context .
• For TIBCO Spotfire Server registration, e.g. tibcospotfire:server:http\://spotfire.example.com/

 

Available from TIBCO Spotfire 3.3