One can open documents with IceViewer using URL parameters, as in the following example:
https://myiceviewerwebsite/?documentid=c:\docs\invoice.tif
The myiceviewerwebsite must be replaced with the IP address of your IceViewer web server, or domain name.
The c:\docs\invoice.tif must be replaced with the absolute path of the document on the IceViewer Server you would like to open.
Opening documents with URL parameters allows Administrators to embed the IceViewer into their application, and open documents without user-interaction.
The IceViewer supports the following parameters in the URL:
|
Parameter |
Explanation |
|
DocumentID |
The ID of the document that you would like to open. The DocumentID can be anything, an absolute path, of a database row ID. It’s the IceViewer’s job to recognize the DocumentID, and open the document using the associated Content-Engine.
Examples: |
|
Profile |
The Profile specifies the layout (User Interface) for the viewing session. IceViewer can have multiple preconfigured layouts for various purposes, for example for hiding the icons and footer, when the IceViewer is embedded in an application. To edit existing profiles, or create new ones, go to the Admin Panel > User Interface tab.
Examples for embedding: https://myiceviewerwebsite/?documentid=c:\docs\invoice.tif&profile=0 |
|
Config |
The Config specifies the Session Configuration for the viewing session. This parameter can be used to specify the behavior and settings of the IceViewer, for example the default View Mode for a viewing session.
If the Config is not specified, IceViewer will use the default settings from the web.config file on the IceViewer Server.
If you specify a Config that is not exists, IceViewer will create a new Session Configuration. You can configure the Session Configuration based on the IceViewer Options – Session Configurations section.
Examples: https://myiceviewerwebsite/?documentid=c:\docs\invoice.tif&config=555 |
|
CE |
The CE parameter specifies the Content-Engine that will be used to open the document.
Possible values: 1: FileEngine (default) 2: DatabaseEngine
Examples: https://myiceviewerwebsite/?documentid=c:\docs\invoice.tif&ce=1 https://myiceviewerwebsite/?documentid=900531&ce=2
If the CE parameter is not specified, the Default Content-Engine will be used, which is the FileEngine. |
|
Annotation |
The Annotation specifies an external annotation file, that will be loaded for the TIFF document.
Examples: https://myiceviewerwebsite/?documentid=c:\docs\invoice.tif&annotation=c:\ann\2.ann
If the Annotation file does not exist, or the Annotation parameter is not specified, the IceViewer will load the annotations from the TIFF document itself.
NOTE: When the Annotation parameter is specified in the URL and you save the document, the annotations will be saved into the specified Annotation File. |