Rendition profiles allow you to manage Vault-wide rendition settings. For instance, if you have separate Microsoft Word templates for two locales and the Table of Contents bookmarks should be generated differently for each, selecting locale-specific rendition profiles makes it possible to render both of the documents without changing Vault-wide rendition settings.
Admins can configure rendition profiles, including automatic selection of a default Rendition Profile, or conditional selection under specified criteria. For example, Vault can be configured to automatically apply a specific rendition profile when a document’s Country field has a particular value.
Configuring Rendition Profiles
Admins can create and edit Rendition Profiles.
To enable the Rendition Profile field for a document type:
- Navigate to Admin > Configuration > Document Fields > [Document Type]
- Click Add and select Existing Shared Field.
- Select Rendition Profile (rendition_profile__v) from the dropdown in the Use Shared Field dialog.
- Click OK.
To create a new Rendition Profile:
- Navigate to Admin > Configuration > Rendition Profiles.
- Click Create.
- Change settings for Font Embedding, Bookmark & Link Settings, Rendition Display, Rendition Display, PDF Format, Protected PDF, and Rendition Metadata.
- Click Save.
To change Rendition Profile settings, navigate to Admin > Configuration > Rendition Profiles, click the name of the desired profile, and click Edit. Select options to customize the Rendition Profile.
Changes to the Rendition Profile settings apply to all new document versions created using the Rendition Profile. Changes do not apply retroactively to existing documents using the modified Rendition Profile. You must manually re-render or up-version the document for the new settings to take effect.
Font Embedding
You can set the level of font inclusion within viewable renditions generated by Vault. The settings apply to newly generated renditions. The settings can be applied to existing renditions by re-rendering them from their source files.
Default Settings:
- Vault does not embed Arial, Courier, and Times New Roman font sets.
- Vault embeds all other fonts, including Asian fonts, as subsets. In other words, Vault embeds individual characters of those font sets only when they are used in a document.
- Vault embeds a complete font set only when every character of the font set is used in the document.
Optional Settings:
- Always embed complete font sets (including TrueType fonts) for all fonts being used in the document. Asian (double-byte) fonts will remain embedded as subsets.
- Always embed font subsets (including TrueType fonts) for each character being used in a document.
Note: Any PDF distributed outside of Vault (submitted to a health agency, for example) may require all font sets embedded to ensure that the recipients can view the text as intended. However, this will increase the rendition file size. Individual health authority requirements for font embedding should always be verified before submission.
Bookmark & Link Settings
You can modify these settings to determine how Vault handles bookmarks and links:
- Generate bookmarks based on Table of Contents: When creating bookmarks, Vault looks for a Table of Contents (TOC)/List of Figures (LOF) and generates bookmarks to match all TOCs and LOFs that exist in your Microsoft Word file. If no TOC or LOF exists, Vault generates bookmarks based on headings (Heading 1 - Heading 9). If enabled, Vault also generates bookmarks for captions and titles under headings. This setting may be necessary if renditions in your Vault must adhere to PDMA standards.
- Generate bookmarks for Title style: When creating bookmarks, Vault looks for text with the Title style applied. If a title exists, Vault generates a Level 0 bookmark. If there are multiple titles in the document, Vault generates multiple Level 0 bookmarks. Vault defaults to Bookmarks based on Table of Contents if both settings are enabled.
- Set link text to blue: When Vault renders a Microsoft Word file, the viewable rendition displays links in blue text.
- Auto generate bookmarks for captions: When creating bookmarks, Vault looks for in-line captions and generates bookmarks under parent headings within the bookmark hierarchy.
- Generate “List of …” bookmark sections per caption type: When creating bookmarks, Vault looks for in-line captions and generates bookmarks under sections titled “List of <Caption Type>” for each caption type.
- Exclude captions of type: Vault can exclude captions when creating bookmarks from captions using the Auto generate bookmarks for captions or Generate “List of …” bookmark sections per caption type options. By default, you can exclude three (3) caption types: SeqTableNote, Table, and Figure. You can add excluded captions to the picklist called Caption Exclusions and set them on the Renditions Settings and Rendition Profiles pages. Identifiers for excluded captions must start with a letter and are limited to 40 characters (letters, numbers, and underscores). Refer to Microsoft guidelines for details on defining captions. You can exclude up to 25 captions per rendition profile.
- Expand PDF bookmarks to show Level X: By default, Vault expands the first level of bookmarks in the downloaded PDF. You can use this setting to select a different bookmark level to expand.
Veeva Support can also enable a setting which includes styles applied to bookmarks (bold, italic, or uppercase) in the downloaded viewable rendition.
Merge Fields Settings
The Prevent Merge In Steady State setting determines whether Vault should continue to merge fields while in a steady state. If enabled, documents using merge fields merge one final time when transitioning to a steady state, and will not merge again until they transition out of the steady state. This setting is enabled by default and only available on the default rendition profile.
Rendition Display
Microsoft Word documents are rendered in Vault with all markup. If you select the Do not show Markup in Viewable Renditions for Word documents checkbox, Vault renders all Microsoft Word documents without the Markup and Comments that appear in the native Word file. All source files are unaltered.
MS PowerPoint documents are rendered in Vault without Speaker Notes. If you select the Always show Speaker Notes in Viewable Renditions for PowerPoint documents checkbox, all new viewable renditions for PowerPoint documents in Vault include Speaker Notes.
Vault can display and allow annotation of PDF and XFA-based PDF files with enabled Adobe Acrobat security settings with the Allow viewing and annotation of protected PDF files checkbox. This option is only available on the default rendition profile.
Rendition Metadata
You can enable basic metadata population on PDF and PDF/A-1b renditions of Microsoft 365 source files by setting the Include source document properties in the Viewable Rendition checkbox under Rendition Metadata.
If the Title, Author, Subject, and Keywords fields are not blank on the source document, Vault extracts them and populates the corresponding fields in the Document Properties of the PDF viewable rendition.
Enabling PDF/A Viewable Renditions
In addition to standard PDF viewable document renditions, Vault supports PDF/A viewable renditions to comply with widely-adopted ISO standards. When PDF/A renditions are enabled, Vault does not generate standard PDF renditions. You can also configure a rendition profile to limit PDF/A rendition generation to specific documents.
Vault does not automatically re-render existing viewable renditions when you enable PDF/A compliant renditions. You must re-render all documents of that type to generate the PDF/A rendition.
Automatically Applying Rendition Profiles
You can configure an event action on a document lifecycle to automatically apply a default Rendition Profile to a document or a specified profile upon meeting the configured criteria. For example, you can configure Vault to automatically apply a specific Rendition Profile when a document’s Country field has a particular value.
Configure automatic Rendition Profile application as an event action on a document lifecycle.
Generating Compliant Renditions for Source PDFs
Admins in Submissions and Submissions Publishing Vaults can configure the Generate compliant rendition for Source PDFs (RIM only) option to render PDF source files according to ICH standards.
PDF Standardization
Admins in Submissions and Submissions Publishing Vaults can configure a rendition profile to render PDF source files according to ICH standards. If you select the Generate compliant Viewable Rendition for Source PDFs checkbox under PDF Standardization, Vault standardizes documents when you create new versions. You can also apply this setting in the default Rendition Profile, which applies standardization to all new documents as a Vault-wide setting unless overwritten by a custom Rendition Profile. You must re-render existing documents using Vault Loader.