Overlaytemplate

Class: metadata

Overlays allow you to apply information to a viewable rendition when users download it from Vault.

Learn about Managing Overlays 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.
allow_download_without_overlay	Type: Boolean	If set to true, identifies an overlay template as optional and allows users to download a viewable rendition if Vault fails to apply an overlay.
footer_01	Type: String Max length: 1500	Footer line 1. As of 24R3.4, overlay template footers are populated from the value of the footer_richtext attribute unless schema_version= 0 or is blank.
footer_02	Type: String Max length: 1500	Footer line 2. As of 24R3.4, overlay template footers are populated from the value of the footer_richtext attribute unless schema_version= 0 or is blank.
footer_richtext	Type: String Max length: 6000	The HTML for the overlay template footer.
header_01	Type: String Max length: 1500	Header line 1. As of 24R3.4, overlay template headers are populated from the value of the header_richtext attribute unless schema_version= 0 or is blank.
header_02	Type: String Max length: 1500	Header line 2. As of 24R3.4, overlay template headers are populated from the value of the header_richtext attribute unless schema_version= 0 or is blank.
header_richtext	Type: String Max length: 6000	The HTML for the overlay template header.
overlay_override_page_match	Type: Boolean	If set to true, Vault applies overlays to documents within 0.5” of the specified height or width of the overlay. If no matching overlay template overrides within the 0.5” page tolerance are found, Vault applies the standard overlay template.
schema_version	Type: Number	If blank or set to 0, Vault populates the overlay template with values from legacy attributes header_01, header_02, watermark, footer_01, and footer_02. If set to 1, Vault populates the signature page with RichText values.
watermark	Type: String Max length: 1500	Diagonal watermark that appears across the center of the downloaded rendition.
watermark_richtext	Type: String Max length: 3000	The HTML for the overlay template watermark.

Overlayoverride

Section link for Overlayoverride

Overlays allow you to apply information to a viewable rendition when users download it from Vault.

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.
file	Type: File	Reference to the XFA template file. As of 24R3.4, this attribute is deprecated and replaced by header_richtext, footer_richtext, and watermark_richtext. You must use MDL to edit XFA templates for overlay overrides created before 24R3.4.
footer_richtext	Type: String Max length: 6000	The HTML for the overlay template footer.
header_footer_placement	Type: Enum Allowed values: header_footer__v left_right_margin__v	Indicates whether the header and footer should be positioned in the header and footer of the document, respectively, or the left and right margins, respectively.
header_richtext	Type: String Max length: 6000	The HTML for the overlay template header.
orientation	Type: Enum Allowed values: portrait__v landscape__v	Indicates the orientation of the specified page size.
overlay_format_type	Type: Enum Allowed values: xfa_override__v basic_overlay_format__v	Indicates the overlay format type.
paper_size	Type: Enum Allowed values: letter__v a4__v a3__v legal__v tabloid__v	Indicates the page size to which this rich text basic overlay format should be applied.
watermark_richtext	Type: String Max length: 3000	The HTML for the overlay template watermark.

Supported Operations

Section link for Supported Operations

Operation	Support
Create
Recreate
Alter
Drop
Rename
Describe
Generate Recreate
Queryable