Create Mandatory Document Acknowledgment Indicators

XML Forms Guide

Version
R2025.1.0
Create Mandatory Document Acknowledgment Indicators

You can add the <DocReviewValidationBinding> tag to the <UploadDownload> element in a form's XML to track whether a user opened attached documents. When you use this tag, a read-only acknowledgment checkbox is added to your form. This checkbox is placed above the list of mandatory documents, and includes a label that affirms that the user opened each document. When the user opens all of the attached documents, the checkbox is selected and they can submit the form. If the employee tries to submit the form without opening all of the documents, an error message shows that reminds them to view every document.

Sample form output featuring the DocsReviewValidation tag.

The content of the <DocReviewValidationBinding> tag is the user-defined boolean field that tracks the opened state of the mandatory documents. In the following example, the field is named UserDefinedFields.UDFBool1. You can view the state of this field in the form submission data. You must include a unique <AttachedEntityID> tag value for each document.

Copy
<UploadDownload>
    <DocMgmtTypeXRefCodes>
        <DocMgmtTypeXRefCode>HR_POLICY</DocMgmtTypeXRefCode>
    </DocMgmtTypeXRefCodes>
    <Block>1</Block>
    <Row>2</Row>
    <Column>0</Column>
    <RowSpan>4</RowSpan>
    <ColumnSpan>3</ColumnSpan>
    <ItemSource>List_DocMgmtFileStore</ItemSource>
    <AttachedEntityId>10</AttachedEntityId>
    <DocReviewValidationBinding>UserDefinedFields.UDFBool1</DocReviewValidationBinding>
    <IsReadOnly>false</IsReadOnly>
</UploadDownload>