This chapter describes how the Viewer UI Tool is implemented. Viewer URL Tool provides direct access to View Document user interface function.
This chapter includes the following sections:
URL tool is a URL in the Imaging user interface that provides direct access to specific user interface function such as viewing a document. This tool is exposed through a specific access page and is supported as official API into the application.
The access point for the URL tools is currently the "UrlTools.jspx" page found in the following location: http://<server>:<port>/imaging/faces/Pages/UrlTools.jspx
Note:
You need to modify your server architecture such that existing client URLs will continue to work (you could replace the IPM machine with a UCM machine at the same machine/IP address) through network mapping, or modify all the client references.The following URL parameters are used. They can be added as a parameter to the URL tool. Semicolon delimited Parameter Names indicate that multiple parameter names mean the same thing.
| Parameter Name | Description | Valid Values | Default |
|---|---|---|---|
| LockBanner | Indicates the banner should be locked or not locked. Locking the banner means that it is hidden and there is no way to expand it.
HideBanner=0 will override the existence of this parameter on the URL. |
1 or true:
Lock the banner 0 or false: Unlock the banner |
0 - Unlock banner on URL Tool (unless otherwise noted) |
| LockWorkcenter | Indicates the Navigation Pane should be locked or not locked. Locking the Navigation Pane means that it is hidden and there is no way to expand it.
HideWorkcenter=0 will override the existence of this parameter on the URL. |
1 or true: Lock the Navigation Pane 0 or false: Lock the Navigation Pane |
1 - Lock the Navigation Pane on URL tool (unless otherwise noted) |
| ToolName | Indicates which tool should be used to process the request. | Currently there are only two tools. They are ExecuteSearch (or AWSER) and ViewDocument (or AWVWR). | None |
| skin | Indicates which skin to use. | Any value that is deployed with the application. Typically:
|
The current user's preference setting is used. |
The Viewer URL tool exposes the Imaging Viewer UI tool as a directly accessible tool. The following is a summary of the URL parameters that are expected by the ViewDocument tool.
| Parameter Name | Description | Valid Values | Default |
|---|---|---|---|
| showHistory | Causes the history pane of the viewer to be shown or hidden | 1 or true: Show History 0 or false: |
False |
| showProperties | Causes the Properties pane of the viewer to be shown or hidden | 1 or true:
Show properties 0 or false: Hide properties |
False |
| showStickyNotes | Causes the Sticky Notes pane of the viewer to be shown or hidden | 1 or true:
Show Sticky Notes 0 or false: Hide Sticky Notes |
False |
| DocumentId | The document id of the document that should be shown to the user. If this is missing the view of the document will fail with an error. | Any valid document id obtained through searching or as a result of indexing a document through the user interface or the Web service API. | None |
| supportingKey | The key for the supporting information that should be shown | Any valid supporting information key value. | None |
| folder | The name of the folder the viewer should be placed in. This is an optional value that allows different sets of documents to be accumulated into segregated set in the UI cache. | Any string value that can be used as a name of a folder. | If this is not specified the folder name will be "default". This is the same folder the search results place viewed documents. |
| showTabs | Indicates if the tabs should be shown allowing the user to switch between documents in a folder. | 1 or true - Hide the tabs 0 or false - Show the tabs | False |
| closeAllTabs | Tells the URL Tool to close all the tabs in the folder that the document will be opened in. | 1 or true - Close all the documents in the folder. 0 or false - Do not close any of the documents in the folder. | False |
| forceHideProperties | Causes the Properties pane of the viewer to close. This option overrides the system default and any user preferences. | 1 or true - Force close the Properties pane.
0 or false - Do not force close the Properties pane. |
False |
| forceHideStickyNotes | Causes the StickyNotes pane of the viewer to close. This option overrides the system default and any user preferences. | 1 or true - Force close the StickyNotes pane.
0 or false - Do not force close the StickyNotes pane. |
False |
| forceHideHistory | Causes the History pane of the viewer to close. This option overrides the system default and any user preferences. | 1 or true - Force close the History pane.0 or false - Do not force close the History pane. | False |
| HideBanner | Causes the banner in the viewer to be shown or hidden | 1 or true - Hide the banner
0 or false - Show the banner |
True |
Example 31-1 is a sample URL for opening a document in the viewer using the ViewDocument URL Tool.
Example 31-1 Opening a Document for Viewing
In this example, the document with the ID of 123.RPO_456 is placed in a folder named EBS1. The parameter showTabs=0 suppresses the document tabs in the viewer to prevent users from switching to other documents in the folder.
http://<server>:<port>/imaging/faces/Pages/UrlTools.jspx?ToolName=ViewDocument&DocumentId=123.RPO_456&folder=EBS1&showTabs=0