Displaying Images Stored in OnBase on HTML Documents - System Administration - On-Premises - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

On-Premises System Administration

Platform
OnBase
Product
System Administration - On-Premises
Release
Foundation 22.1
License
Standard
Essential
Premier

If an image is already stored in OnBase, you can include it on OnBase HTML documents, Custom Queries, and E-Forms that are displayed in the OnBase Client and Web Client. This feature lets you maintain an image on a document or form by updating the image in OnBase and allows users that have rights to the Document Type the image is stored in to view the image within the document/form. For example, if you revise a referenced image using EDM Services, the image on the HTML document will reflect the revision. You can also update OnBase images on HTML documents by modifying the Keyword Values on the referenced images.

Note:

Displaying an image stored in OnBase on E-Forms is not supported in the Unity Client.

To reference an image in OnBase, use the following format:

<img alt="mz:DocTypNum;KeyTypeNum1:KeyValue1;KeyTypeNum2:KeyValue2;">

Where:

  • DocTypeNum is the image's Document Type number.

  • KeyTypeNum1 is the Keyword Type number of a Keyword Type on the image.

  • KeyValue1 is the value associated with KeyTypeNum1 on the image.

Here is an example:

<img alt="mz:151;138:ONE;">

Notice that KeyTypeNum and KeyValue are separated by a colon, whereas other parameters are separated by semicolons. You can enter as many KeyTypeID:KeyValue pairs as needed to identify the image document.

Be sure to use Keyword Values that uniquely identify the image. If multiple images match the parameters provided, different images may be returned depending on the application. OnBase images must be referenced by a unique Keyword Value to link the image to the document.

Tip:

Use the HTML document's file name as the Keyword Value parameter, and then index the image you want to display with the file name. This practice helps ensure that only one image is associated with the HTML document.