The front-end client specifies the format used to display documents returned by a query to users. The viewerMode key in the docHitList object can override the default viewer mode set by the API. Set the viewerMode key to one of the following values to specify the document viewer mode:
|
Value |
Description |
|---|---|
|
|
Image documents, text documents, E-Forms, Unity Forms, OLE documents, and all other file formats are converted to PDF before being sent to the front-end for display. |
|
Native |
Documents are sent to the front-end for display in the format which they were uploaded to OnBase as. Note:
If the user's browser does not recognize the extension of a document's native format, the file may be downloaded instead of displayed in the viewer. |
|
NativeOptional |
Documents are converted to PDF for display, but still be available to download in their native format by using the Download in Native Format button in the document viewer. |
|
null |
The default viewer mode set by the API is used. |
For example, to display documents as PDFs, but give users the ability to download them in their original file format, set the viewerMode key as follows:
"viewerMode": "NativeOptional"