The best method for building searches with encoded URL is to create and run the search through the Portal. When the desired results are displayed, you can go back to the search page and click Link to Search in the search toolbar to display the URL that creates the search.
Note: Users who run this search with a URL might still be required to authenticate through the
Portal.
All parameters must be URL-encoded.
Required Arguments template
| Argument | Value |
|---|---|
template |
The ID of the template to be loaded. The user must have permission to view this template. The IDs for templates can be found on the Search Template Config page. |
fieldX |
Either the active search keyword or the archive search keyword (such as request) for a search field. The first matching search field will be selected from the template and used. Knowledge of acceptable keywords is required, so we have to provide a master list somewhere. |
opX |
The operator value for the field |
valueAX |
The first value to populate the field with. Text inputs only use valueA - others such as
form fields, or numerical fields with the between operator can use valueB |
valueBX |
The second value to populate the field with |
For field, op, valueA and
valueB, the X is a numerical index starting at 0.
For example, field0=request, op0=1,
valueA0=tealeaf will find a search field in the template that uses the
request keyword, set the operator to includes, and populate it
with the text tealeaf.
Required Arguments template
| Argument | Value |
|---|---|
datespan |
The numeric constant representing the dates to search on. |
startdate |
If datespan is set to -1, this is the ISO-format date for the beginning date of the range (e.g. 2007-01-02 is Jan 02, 2007) |
enddate |
If datespan is set to -1, this is the ISO-format date for the end date of the range (e.g. 2007-01-02 is Jan 02, 2007) |
starttime |
If datespan is set to -1, this is the 6-digit, 24-hour time for the beginning of the range, in HHMMss format (e.g. 003015 is 00:30:15 or 12:30:15 AM) |
endtime |
If datespan is set to -1, this is the 6-digit, 24-hour time for the end of the range, in HHMMss format (e.g. 233059 is 23:30:59 or 11:30:59 PM) |
scope |
The scope of the search. |
sort |
How the results will be sorted |
timeout |
The maximum allotted time for an archive search, in seconds. The search will be stopped once this amount of time has elapsed, but more time may be required to collate the sessions found. |
autostop |
Specifies the limit at which an archive search will be stopped. When X matching sessions are found, the search is stopped. |
dosearch |
If set to 1, the search will be performed once all the fields have been processed and populated. This mode takes you to the search builder, so the search results will appear as a second breadcrumb. This allows a search to be performed, but the user will still be able to go back and tweak the constraints to refine the search. |
Operator Values
The following values may be included in the opX parameter:
| Value | Description |
|---|---|
1 |
Includes/contains (active/archive) |
-1 |
NOT includes/contains |
2 |
Equal (numerical) |
-2 |
NOT equal |
3 |
Between (numerical) |
-3 |
NOT between |
4 |
Greater than |
5 |
Less than |