Configure Universal Viewing
Universal viewing is an additional View configuration that allows the IDOL View component to work out how to retrieve your original documents. It allows you to retrieve documents from various sources to view, without requiring you to use complex logic in your front end components to work out how to send the View request.
NOTE: Universal viewing requires more internal communication between your IDOL components, which might affect performance.
When you enable universal viewing, you also configure the location of your document store (an IDOL Content component or DAH). You also configure a set of reference fields to specify how to retrieve the original documents (by using Distributed Connector or IDOL NiFi Ingest, a Web URL, or from the file system).
To enable universal viewing
-
Open the IDOL View component configuration file in a text editor.
-
Add a
[UniversalViewing]
configuration section. -
In the
[UniversalViewing]
section, set Enabled toTrue
to enable universal viewing. -
Set DocumentStoreHost and DocumentStorePort to the host and port of your primary data index component (either the Content component, or DAH). View Server uses this component to retrieve the index representation of your documents to find the appropriate reference fields.
-
To use IDOL NiFi Ingest for viewing, set ConnectorGroupField to the name of a document field that contains the connector group for a document.
-
Set one or more of the following parameters to specify the reference fields in your documents that View Server must use to retrieve the documents from the associated sources:
DistributedConnectorReferenceField The document reference field that contains a reference that View Server can use to retrieve the document by using the Distributed Connector or IDOL NiFi Ingest.
To use this option, you must configure the details for the Distributed Connector or NiFi in the[Viewing]
section. See Configure View to Use a Distributed Connector or IDOL NiFi Ingest.FileSystemReferenceField The document reference field that contains a reference value that View Server can use to retrieve the document from a local file system or network share.
WebURLField The document reference field that contains a reference value that View Server can use to retrieve the document from the Web.
-
Save and close the configuration file.
-
Restart the IDOL View component for your changes to take effect.
For example:
[UniversalViewing] Enabled=True ConnectorGroupField=CONNECTOR_GROUP DocumentStoreHost=localhost DocumentStorePort=9900 DistributedConnectorReferenceField=AUTN_IDENTIFIER WebURLField=DREREFERENCE FileSystemReferenceField=ORIGINAL_LOCATION
When you send a View request, the IDOL View component uses the requested reference to retrieve the index representation of the document from the document store. It then attempts to find the configured reference fields in the document:
- If the document has the configured DistributedConnectorReferenceField, View attempts to retrieve the document by using the Distributed Connector or IDOL NiFi Ingest. For this option, you must also configure a Distributed Connector or NiFi in the
[Viewing]
section. - If the document has the configured WebURLField (and does not have the DistributedConnectorReferenceField), View Server attempts to retrieve the document from the Web.
- If the document has the configured FileSystemReferenceField (and does not have the DistributedConnectorReferenceField or WebURLField), View attempts to retrieve the document directly from a file system or network share. Your
[Viewing]
configuration must allow View to retrieve the file.
If the document does not contain any of the configured reference fields, View attempts to retrieve the original document by the reference in the request, as usual. If it cannot retrieve the original document by reference, View returns the document title and content from the document store.