Renditionprofile

Class: metadata

Rendition profiles allow you to choose rendition settings that differ from the Vault-wide rendition settings.

Learn about Rendition Profiles in Vault Help.

Attribute	Metadata	Description
`label`	Type: String Max length: 60	UI-friendly string in the Vault's base language.
`active`	Type: Boolean	Indicates whether the component is active.
`bookmark_expansion_level`	Type: Enum Required Allowed values: ALL_LEVELS LEVEL_ONE LEVEL_TWO LEVEL_THREE LEVEL_FOUR LEVEL_FIVE	Determines how many level deep are expanded in the bookmark panel.
`bookmark_list_per_caption_type`	Type: Boolean	If set to `true`, Vault generates a list of bookmarks sorted into sections by caption type when auto-generating bookmarks based on captions. The default value is determined by the Generate “List of…” bookmark sections per caption type setting in the Vault Admin UI.
`caption_bookmarks_exclusion_types`	Type: String Max length: 43 Multi-value	Lists caption types that Vault excludes when auto-generating bookmarks based on captions.The default value is an empty String.
`clear_rendition_properties`	Type: Boolean	If `true`, Vault strips all metadata except for the filename from the viewable rendition.
`content_copying_settings`	Type: Enum Allowed values: NONE ENABLED ENABLED_FOR_ACCESSIBILITY	If `protected_pdf` is `true`, specifies the content allowed for copying in the PDF rendition.
`embed_fonts`	Type: Enum Required Allowed values: DEFAULT FULL_FONT SUB_FONT	Indicates the type of font embedding. Learn more about font embedding in Vault Help.
`generate_bookmarks_for_title_style`	Type: Boolean Required	If set to `true`, Vault generates bookmarks for Title Style.
`generate_caption_bookmarks_tree`	Type: Boolean Required	If set to `true`, Vault auto-generates bookmarks for captions.
`generate_toc_lofs_bookmarks`	Type: Boolean Required	If set to `true`, Vault generates bookmakrs based on the Table of Content and List of Figures.
`include_metadata`	Type: Boolean	If set to `true`, Vault includes source document metadata in the viewable PDF rendition.
`no_mark_up`	Type: Boolean Required	If set to `true`, Vault does not show Markup in the viewable rendition.
`pdf_edit_settings`	Type: Enum Allowed values: NONE ALLOW_ASSEMBLY ALLOW_FORMS ALLOW_ANNOTATIONS	If `protected_pdf` is `true`, specifies the type of editing allowed for the PDF rendition.
`pdf_format`	Type: Enum Required Allowed values: DEFAULT PDFA_1B	Determines the format for PDF viewable renditions.
`pdf_print_settings`	Type: Enum Allowed values: NONE ALLOW_LOW_RESOLUTION ALLOW_HIGH_RESOLUTION	If `protected_pdf` is `true`, specifies the printing resolution allowed for the PDF rendition.
`post_process_restricted_pdf`	Type: Boolean
`preprocess_pdf`	Type: Boolean	If set to `true`, Vault renders non-compliant PDF source documents according to ICH standards. Only RIM Submissions and Submissions Publishing Vaults with Generate compliant rendition for Source PDFs enabled allow non-null values for this attribute.
`prevent_steady_state_merge`	Type: Boolean	If set to `true`, 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.
`protected_pdf`	Type: Boolean	If set to `true`, Vault applies PDF Protection to the viewable PDF rendition.
`render_ppt_hidden_slides`	Type: Boolean	If set to `true`, Vault renders all new Viewable Renditions for PowerPoint documents with hidden slides.
`render_ppt_speaker_notes`	Type: Boolean Required	If set to `true`, Vault includes Speaker Notes in viewable renditions for PowerPoint documents.
`set_link_text_to_blue`	Type: Boolean Required	If set to `true`, Vault sets link text to blue.
`show_standardized_inline_markup`	Type: Boolean
`view_protected_pdf`	Type: Boolean	If set to `true`, Vault attempts to unlock protected PDF files for display in the document viewer.

Supported Operations

Operation	Support
Create
Recreate
Alter	^*
Drop
Rename
Describe
Generate Recreate
Queryable

Notes:

Alter: MDL Operation may not be supported for some multi-value attributes.