The Document Readiness panel on the Doc Info page provides users and Admins improved visibility into the processes contributing to a document’s readiness for use in Vault. The panel displays statuses related to rendition generation, searchability, and annotations, as well as warnings related to these operations and how to address them.
Viewing the Document Readiness Panel
To open the Document Readiness panel, click Document Readiness () on the Doc Info pane to the right of the document viewer. The panel displays the Content Processing and Warnings sections.
The panel is displayed to users with the appropriate permissions. The panel is not displayed for previous document versions or documents that do not undergo content processing.
Content Processing Status Information
The Content Processing section in the Document Readiness panel displays status indicators for the following activity categories:
- Viewable: This category includes all activities involved in generating a rendition that is displayed in the document viewer. This includes post-processing steps such as PDF/A and PDF standardization.
- Searchable: This category includes all activities involved in indexing document content and making the content searchable by users.
- Ready to Annotate: This category includes all activities involved in making searchable, editable, and OCR-processed text in the document available for annotation.
The following status indicators may be displayed in the Content Processing section of the Document Readiness panel:
- In Progress: Indicates that the activity has not started or is currently in progress.
- Successful: Indicates that the activity has completed successfully.
- Completed with Warnings: Indicates that the activity has completed successfully but one or more warnings occurred.
- Failure: Indicates that the activity failed.
Content Processing Warnings
Warnings are non-fatal errors encountered when the document was last processed. When warnings occurred during document processing, the Viewable status is displayed as Completed with Warnings () in the Document Readiness panel, and the Warnings section is displayed. The warnings are grouped by category, and each category with at least one warning is displayed in the Warnings section with a number to indicate how many warnings occurred within that specific category.
Warning Banner
When you open a document with warnings in the document viewer, a banner is displayed to indicate the document has unresolved warnings. Click Document Readiness Panel in the banner to dismiss it and open the Warnings section of the Document Readiness panel. The banner is displayed for the document every session until all outstanding warnings are resolved or ignored.
Viewing Warning Details
To view more information about a warning, click a warning category name in the Document Readiness panel to open the Warnings dialog. The Warnings dialog lists the individual warnings in the selected category, as well as suggested actions for resolving the warning, if available. You can view warnings in a different category by selecting the Category from the drop-down. Click Learn More in the Suggested Action section, if available, to navigate to a Vault Help article with more information about the warning and suggested steps to resolve the issue.
See Troubleshooting Renditions for helpful information about resolving issues that may occur during the document rendition process.
Resolving and Ignoring Warnings
To resolve a warning, review and follow the guidance in the Suggested Action section of the Warnings dialog, and reupload the document if needed. See Troubleshooting Renditions for more information about warnings and their suggested actions. When you reupload the document, Vault re-renders the document and updates the content processing statuses and warnings in the Document Readiness panel. You can also select Re-render Document from the All Actions menu to manually initiate the rendition generation process without uploading a new document.
In some instances, you may want to acknowledge a warning without taking actions to resolve the source of the warning. In this case, you can click Ignore Warnings () next to the warning category in the Document Readiness panel, or click Ignore All in the Warnings dialog to ignore all warnings in the selected category. To restore previously ignored warnings and include them in the warning count, click Restore () next to the ignored warning category in the Document Readiness panel.
After you have resolved or ignored all warnings, the Viewable status in the Document Readiness panel is displayed as Successful (). When you restore a warning category, the Viewable status returns to Completed with Warnings ().
Reporting on Document Readiness Metrics
The Document Readiness Metrics (document_readiness_metrics__sys) object allows for reporting on outstanding document warnings. To create a report for outstanding warnings, an Admin must create the necessary report type in Admin > Configuration > Report Types.
Permissions
To access the Document Readiness panel for a document, users must have Edit permission for the lifecycle state of the latest document version.