Format of the deep linking URL

Deep linking uses the deeplink URL query parameter to create external bookmarks to the Latitude Studio. Deep links can include record filters and can set the current state of a tabbed container.

The general form of the URL is:
http://portalhost:port/path/to/page?deeplink=JSON-ARRAY-OF-DATASOURCE-STATES
The following example includes a record filter to only include records with a Designation of Best Buy:
http://localhost:8080/web/guest?deeplink=[{"default":
{"queryFunctions":[{"class":"RecordFilter","recordFilter":
"Designation:BestBuy"}]}}]

If the page you are navigating to includes a Tabbed Component Container, then you can use the pageTransitionTabState parameter to direct the user to a specific tab. To do this:

http://portalhost:port/path/to/page?com.endeca.discovery.
pageTransitionTabState=tabcomponentname[tabnumber]&deeplink=JSON-ARRAY-OF-DATASOURCE-STATES
Where:
  • tabcomponentname is the name of the component.
  • tabnumber is the number of the tab.
In this example, in addition to providing a record filter, the link directs the user to the second tab of the Stores tabbed component:
http://localhost:8080/web/guest??com.endeca.discovery.
pageTransitionTabState=Stores[2]&deeplink=[{"default":
{"queryFunctions":[{"class":"RecordFilter","recordFilter":
"Designation:BestBuy"}]}}]