Skip to content

Class: metadata

Signature pages display the manifested signatures for a Vault document.

AttributeMetadataDescription
labelType: String
Max length: 60
UI-friendly string in the Vault's base language.
activeType: BooleanIndicates whether the component is active.
advanced_modeType: BooleanIf true, indicates an advanced signature page template. If false, indicates a basic signature page template.
fileType: FileReference to the XFA template file. As of 24R3.2, this attribute is deprecated and replaced by header_richtext, footer_richtext, and signature_block_richtext. You must use MDL to edit XFA templates for signature pages created before 24R3.2.
footer_01Type: String
Max length: 1500
Footer line 1. As of 24R3.2, signature page headers are populated from the value of the header_richtext attribute unless schema_version= 0 or is blank.
footer_02Type: String
Max length: 1500
Footer line 2. As of 24R3.2, signature page headers are populated from the value of the header_richtext attribute unless schema_version= 0 or is blank.
footer_richtextType: String
Max length: 6000
The HTML for the signature page footer.
header_01Type: String
Max length: 1500
Header line 1. As of 24R3.2, signature page headers are populated from the value of the header_richtext attribute unless schema_version= 0 or is blank.
header_02Type: String
Max length: 1500
Header line 2. As of 24R3.2, signature page headers are populated from the value of the header_richtext attribute unless schema_version= 0 or is blank.
header_richtextType: String
Max length: 6000
The HTML for the signature page header.
locationType: Enum
Allowed values:
  • start__v
  • end__v
Specifies whether the signature page appears at the beginning or end of the document.
schema_versionType: NumberIf blank or set to 0, Vault populates the signature page with values from legacy attributes header_01, header_02, signature_block_01, signature_block_02, footer_01, and footer_02. If set to 1, Vault populates the signature page with RichText values.
signature_block_01Type: String
Max length: 1500
Signature block 1. As of 24R3.2, signature page headers are populated from the value of the header_richtext attribute unless schema_version= 0 or is blank.
signature_block_02Type: String
Max length: 1500
Signature block 2. As of 24R3.2, signature page headers are populated from the value of the header_richtext attribute unless schema_version= 0 or is blank.
signature_block_richtextType: String
Max length: 6000
The HTML for the signature block.
OperationSupport
Create
Recreate
Alter
Drop
Rename
Describe
Generate Recreate
Queryable