docIdPrototype parameter

The ViewONE Document Streaming Server Module needs to identify every document internally. This parameter provides a method for assigning a unique identifier to documents.

If you are using a value of ${originalDocURL} for docURLPrototype, it represents a unique identifier for the document and as a result the docIdPrototype can be set to the same value. In most cases, this setting is adequate. If you access documents by using a proxy that might result in differing URLs for the same document, then consider the more advanced usage of docIdPrototype.

The default value is ${originalDocURL}.

Requirements

ViewONE Document Streaming Server Module, any version

Example


docIdPrototype=${originalDocURL}

The unique identifier can alternatively be built up directly from your original ViewONE Document Streaming Server Module URL in a similar fashion to the docURLPrototype. Tokens can be specified as part of this prototype by using ${ to start the token and } to end it. The values for these tokens are taken from the URL that the ViewONE Document Streaming Server Module is called with. For example, assume that the following ViewONE Document Streaming Server Module URL is specified in the file name parameter in the HTML page for the IBM Daeja ViewONE Professional client:


http://hostname/streamer/streamer?docId=89&version=20

And the following docIdPrototype is yours:


docIdPrototype=${docId}-${version}

Then, the resulting unique identifier is 89-20.