Construct a Direct Search URL
- Brian Banet
- Phil Holtz
GlobalSearch supports a lightweight URL driven searching route, allowing customers to build links that will run a search and display the results automatically. Common use cases include embedding links into other applications, allowing quick and easy access to specific documents from within other applications.
Instructions
A direct search URL resembles the following:
https://yoursquare9.com/square9web/index.html#/direct?db=10&a=1&s=10&p=1307:2804In this example:
The domain yoursquare9.com should be updated to reflect your GlobalSearch instance.
Beside the base address, the only edits to the URL come after the question mark. The easiest way to identify the additional parameters that are required is to run the search in GlobalSearch. Running a search will present a URL in the address bar similar to:
Find the parameter db=
This parameter represents the Database ID. Use this ID for the db parameter in the Direct Search URL.Find the parameter archive=
This parameter represents the Archive ID. Use this ID for the a parameter in the Direct Search URL.Find the parameter Id=
This parameter represents the Search ID. Use this ID for the s parameter in the Direct Search URL.Find the parameter criteria=
This parameter represents the search details, which are prompt id followed by a colon, and the value to search for.The prompt id is the first part of the criteria parameter. You might notice a URL encoded curly brace (%7B). Disregard that and use the numeric value preceding the colon are the left side of the colon in the p parameter.
The search value is the second part of the criteria parameter, following the colon. The value you are searching for should be added to the URL after the colon.
Direct Search URL’s are passing plain text in the URL. In some cases, the data you are passing may not be allowed in a URL and these situations will need to be tested and accounted for in your environment. Basic searches, and in particular searches for data where there are no special characters should run without any special consideration.
Documentation on Percent Encoding can be found here.
A URL Encoding reference can be found here.
Referencing Searches by Name
GlobalSearch Go supports referencing searches by name instead of search ID.
You must be configured to use GlobalSearch Go. For Cloud customer, you should already be configured for GlobalSearch Go. Learn how to access GlobalSearch Go here. For Premise customers, learn how to configure your local instance for GlobalSearch Go.
To construct your search you will need the following information:
Instance Name - Name of your GlobalSearch Instance. This can most easily be obtained from the GlobalSearch Go login page.
Database ID and Archive ID - The IDs for the targeted database and archive. This can most easily be obtained by select the target archive and running any search then inspecting the URL.
Search Name - The exact name of the search with URL encoding of %20 between the words.
The URL Search for GlobalSearch Go follows the format:
https://instanceName.square9.cloud/db/databaseID/archive/archiveID/search-by-name/searchName
Example:
https://soundcoast.square9.cloud/db/2/archive/4/search-by-name/Waiting%20For%20Indexing
This search will look in the SoundCoast instance of GlobalSearch for a search named Waiting for Indexing located in Archive 4 of Database 2.
When clicked, the above link would take the user to the Waiting For Indexing search results.