Document Readiness
The Document Readiness panel helps you understand your document’s readiness for use in Vault related to rendition generation, searchability, and annotations.
Note
The Document Readiness panel does not display for previous document versions, documents in a steady state, or documents that do not undergo content processing.
Content Processing
The Content Processing section shows the status of the following document processes:
- Viewable indicates if a rendition was generated and is ready to view.
- Searchable indicates if the document content is indexed and ready to search.
- Ready to Annotate indicates if the document is ready to annotate.
Possible statuses include:
- In Progress: Indicates that the evaluation of the corresponding process status has not started or is currently in progress.
- Successful: Indicates that the evaluation of the corresponding process status has completed sucessfully.
- Completed with Warnings: Indicates that the evaluation of the corresponding process status has completed sucessfully but one or more warnings occurred.
- Failure: Indicates that the evaluation of the corresponding process status failed.
Warnings
If you see a warning icon () next to any of the processes, the Warning section displays with a list of specific warnings.
To resolve warnings:
- Click a warning link to see more details about it.
Refer to the Suggested Action in the table below and make necessary updates.
Re-upload the document if needed.
Note
Select Re-render Document from the All Actions menu to re-render the document without uploading a new document.
Possible Warnings
| Category | Warning Text | Suggested Action |
|---|---|---|
| Unsupported File Format | Document is not a supported format and may not render as expected. | The document is not a supported format and may not render as expected. If any issues are encountered, please re-upload the document in a supported format. |
| Invalid Merge Field Token Detected | Token [token name] failed to merge due to invalid syntax. | The document contains merge field tokens with incorrect syntax. Please review and correct the merge field tokens, and re-upload the document. |
| Invalid Merge Field Token Detected | Token [token name] of value [token value] was incorrectly inserted in the document. | The document contains merge field tokens with incorrect syntax. Please review and correct the merge field tokens, and re-upload the document. |
| Maximum Merge Field Relationship Depth Exceeded | Token [token name] failed to merge. The current relationship depth of [depth value] exceeds the limit of [depth limit]. | The document contains merge field tokens that cannot be resolved because they exceed the maximum relationship depth. Please reduce the number of relationships in the affected tokens, and re-upload the document. |
| Merge Field Object Not Found | Token [token name] failed to merge. Object or field [object or field name]not found. | The document contains merge field tokens that do not resolve to a valid object or field. Please review and correct the merge field tokens, and re-upload the document. |
| Merge Field Clause Object Not Found | Token [token name] failed to merge. Object located in the token clause not found. | The document has invalid merge field tokens in the WHERE or ORDER BY clauses. Please correct the filter and re-upload the document. Only fields referenced in the primary statement can be used in the token filter, outside of tables. |
| Merge Field List Size Exceeded | Token [token_name] failed to merge. Maximum number of total values [number of values] exceeded. | The document contains merge field tables that exceed the maximum row limit when resolved. Please remove the affected merge field tokens or add a filter clause to reduce the number of rows, and re-upload the document. |
| Merge Field Table Row Limit Exceeded | The table with token [token name] could not be resolved. Too many rows were returned. | The document has merge field tokens that exceed the allowed number of values when resolved. Please remove the affected merge field tokens or add a filter clause to reduce the number of values, and re-upload the document. |
| Unrelated Merge Fields in Table Row | Merge Field table includes the following fields with a relationship differing from the initial column: [field_name] | When a table contains unrelated fields, identical values for the unrelated field will appear in all rows in list format. To correct this, please remove any fields that do not relate to the first field and re-upload the document. |
| Malformed Hyperlinks Detected | Document contains malformed hyperlinks. | The document has malformed hyperlinks. Please check that all URLs, email addresses, and phone numbers are correctly formatted and re-upload the document. |
| Invalid Image Sources | The image [image_name] could not be found. | The document contains one or more invalid image sources. Please update or embed the image and re-upload the document. |
| Document Contains Macros | Document contains macros and may not render as expected. | Macros in the document were disabled during rendering. Please review to ensure all contents are complete and accurate. |
| Backslashes Converted to Yen Signs | Document contains encoding that displays backslash characters as yen signs. | Backslash characters are set to convert to yen signs. To undo this setting, open the document, go to File > Options > Advanced > Layout Options, uncheck Convert backslash characters into yen signs, and re-upload the document. |