These variables should only be included if they are used for a particular search. It is possible to generate a URL manually using this information; however, this information is included primarily to aid in understanding the component parts of the query URL. If HTTP login is enabled, the username and password variables will need to be manually added to the URL in order to use HTTP login.
|
Query String Variable Name |
Query String Value |
|---|---|
|
username |
The user name of the user account that will retrieve documents. EnableHTTPLogin must be set to true in the Hyland.Web.DocPop element of the Web Server's Web.config. |
|
password |
The password for the user account that will retrieve documents. EnableHTTPLogin must be set to true in the Hyland.Web.DocPop element of the Web Server's Web.config. CAUTION:
The user name and password are passed on the query string as clear text. See Security Considerations. |
|
datasource |
The name of the data source to use with DocPop. EnableHTTPDataSource must be set to true in the Hyland.Web.DocPop element of the Web Server's Web.config. |
|
clienttype |
The web client type used. This variable must be set to HTML. |
|
FromDate |
Used when searching for a document by date or within a particular range, FromDate is the beginning search date (mm-dd-yyyy format). Most often used in conjunction with ToDate. |
|
ToDate |
Used when searching for a document by date or within a particular range, ToDate is the ending search date (mm-dd-yyyy format). Most often used in conjunction with FromDate. |
|
pageID |
Used only with the document # query type, pageID indicates the page number the specified document should open to. Note:
This variable is not supported by all file types. |
|
viewerOnlyForSingle=true or displaySingle=true |
If AutoDisplayOneDocument is set to false in the Web Server's Web.config, then this variable instructs DocPop to display only the document viewer when queries return a single result. If this variable is omitted and AutoDisplayOneDocument is set to false, then queries returning a single result display both the hit list and the viewer. This variable has no effect if AutoDisplayOneDocument is set to true. |
|
sessionID |
Passes the session ID on the query string. This parameter is useful if a custom application uses DocPop to retrieve documents, and the session needs to be controlled by the application. Note:
When the session ID is created through a custom application, the session will not automatically be disconnected by OnBase, and the license will remain in use. It is the responsibility of the application that creates the session ID to disconnect the session when it is done, which will release the license. For information about creating session IDs, see the Hyland SDK. |
|
fts |
Used when searching for a document using a Full-Text Custom Query. The value specified must be three or more characters long. Note:
You must be licensed for Full-Text Search in order for the variable to be passed on the query string. For more information, see the Full-Text Search documentation. |
To assist the integration, an ASPX page exists that will create a sample hyperlink. This Web page is named DocPopURLCreator.aspx and can be found in the \ DocPop directory off of the root of the OnBase virtual directory.