Skip to content

Class: metadata

Formatted output templates allow quick transfer of complete object record data into a customized template file.

AttributeMetadataDescription
labelType: String
Max length: 60
UI-friendly string in the Vault's base language.
activeType: BooleanIndicates whether the component is active.
input_file_typeType: Enum
Allowed values:
  • XFA_PDF
  • MS_WORD
Indicates which type of input file will be used for the formatted output template. Learn more about Word Formatted Outputs in Vault Help.
output_formatType: Enum
Allowed values:
  • PDF_FLAT
  • MS_WORD
Indicates the file format for the resulting output file. MS_WORD is only a valid selection if input_file_type = MS_WORD. Learn more about Word Formatted Outputs in Vault Help.
root_objectType: Component
Required
Root Object for the formatted output, for example, Application.
root_object_typeType: Component
Required
Root Object for the formatted output if the object has object types.
template_fileType: File
Required
An uploaded template file.
OperationSupport
Create
Recreate
Alter
Drop
Rename
Describe
Generate Recreate
Queryable