Introduction

(Since 2024.01)

Document Displays can be configured in the DocumentDisplays.xml. There are three different types of document displays: 

1. Report display
2. Document Browser
3. Compose display

A part of the functionality of the Document Displays depends on the configuration of ArchiveProducts, ArchiveProductSets and Compose in the Documents.xml file, please refer to 36 Documents documentation.

Report Displays:

Visualise and edit reports based on

1. Delft-FEWS Reports;
2. Deltares Open Archive Products

Please find the configuration of these two reports below. Some general configuration options:

• <relativeViewPeriod unit="hour" start="-4" end="0"/> controls the maximum age of the reports to be shown.

• A <productWorkflowStatusId> filter can be added, in the code block Archive Product Example below an example is given where only products that have the productWorkflowStatus of concept or review are shown in the display.

Delft-FEWS Reports

Reports generated by the FEWS Report Module can be added as a Report Display. Please note that:

• Only reports that are stored in the FEWS database can be displayed in Web OC (<sendToLocalFileSystem> = false) in report module configuration. 
• Only images that are embedded in the report can be visualised (<embedImagesInReport>true</embedImagesInReport>)

	<documentDisplay id="ReportAnalysis" name="ReportAnalysis">
		<report>
			<reportModuleInstanceId>ReportAnalysis</reportModuleInstanceId>
			<editor>false</editor>
		</report>
		<relativeViewPeriod start="-20" end="0" unit="day"/>
		<viewPermission>operator</viewPermission>
		<editPermission>operator</editPermission>
	</documentDisplay>

Deltares Open Archive Products

Also HTML archiveProducts can be added as Report Display. By configuring an <archiveProductId>, the archiveProduct should be configured in the Documents.xml. 

<documentDisplay id="ReportShiftEnd" name="ReportShiftEnd">
		<report>
			<archiveProductId>ReportShiftEnd</archiveProductId>
			<showReports>
				<productWorkflowStatusId>concept</productWorkflowStatusId>
				<productWorkflowStatusId>review</productWorkflowStatusId>
			</showReports>
			<editor>true</editor>
		</report>
		<relativeViewPeriod unit="hour" start="-4" end="0"/>
		<viewPermission>operator</viewPermission>
		<editPermission>operator</editPermission>
<documentDisplay>

Document Browser

Through the Document Browser a part of the Archive can be visualised. It will show a list with configured metadata (see <layout> section below). A selected product will be visualised if the <preview> is set to true. For now .html, .pdf, .jpg and .png is supported in the preview. Users with the correct permissions (editPermission) can upload, delete, and edit (if format is .html) documents. The <relativeViewPeriod> controls the maximum age of the products that are shown. 

Which archiveProducts are visualised in the browser is controlled by the <archiveProducts> element, which can hold two types of childs 1) <archiveProductId> or 2)<archiveProductSetId> . The former refers to one archiveProduct, while the latter contains a set of products.

	<browser>
			<layout>
				<preview>true</preview>
				<headers>
					<header name="Name" productAttribute="name"/>
					<header name="Author" productAttribute="author"/>
					<header name="Creation Time" productProperty="timeZero"/>
				</headers>
			</layout>
			<archiveProducts>
			    <archiveProductId>archive_product</archiveProductId>
				<archiveProductSetId>document_browser</archiveProductSetId>
			</archiveProducts>
		</browser>
		<relativeViewPeriod unit="day" start="-365" end="0"/>
		<viewPermission>operator</viewPermission>
		<editPermission>operator</editPermission>
	</documentDisplay>

Compose Display

NOTE: Not implemented yet

A compose display can be used to produce on the fly a new archiveProduct based on a template. The template itself is also an archiveProduct. In this way you can make reports generated by FEWS editable by users.

A compose display requires configuration in two files:

1. definition of a compose display in the DocumentDisplays.xml
2. definition of a compose product in the Documents.xml

Example of a compose display:

	<documentDisplay id="compose" name="compose">
		<compose>
			<composeId>end_shift_form</composeId>
		</compose>
		<relativeViewPeriod start="-10" end="1" unit="day"></relativeViewPeriod>
		<viewPermission>operator</viewPermission>
		<editPermission>operator</editPermission>
	</documentDisplay>

Example of a compose product definition:

	<composeProduct id="end_shift_form">
		<archiveProductId>end_shift_form</archiveProductId>
		<template>
			<archiveProductId>template_ReportShiftEnd</archiveProductId>
		</template>	
	</composeProduct>