Skip to content

Class: metadata

Defines how a field layout section appears on the Doc Info page in the Vault UI. While multiple Docfieldlayouts can use the same label, each one must have a unique name.

AttributeMetadataDescription
show_in_edit_modeType: BooleanFor internal Veeva use only.
allow_field_assignmentType: BooleanFor internal Veeva use only.
panelType: String
Max length: 1500
For internal Veeva use only.
activeType: Boolean
Required
Whether the layout is active.
iconType: Enum
Allowed values:
  • UNDEFINED
  • AUSTRALIA
  • AUSTRIA
  • BELGIUM
  • CANADA
  • CHINA
  • EUROPEAN_UNION
  • FRANCE
  • GERMANY
  • GLOBAL
  • IRELAND
  • ITALY
  • JAPAN
  • NETHERLANDS
  • SPAIN
  • SWEDEN
  • SWITZERLAND
  • UNITED_KINGDOM
  • UNITED_STATES
  • VEEVA
The icon to display in the section header.
orderType: NumberThe order of the section relatve to other sections.
fieldsType: Component
Multi-value
The Docfield's listed in order they should appear in the section.
labelType: String
Required
Max length: 60
UI-friendly string in the Vault's base language.
OperationSupport
Create
Recreate
Alter*
Drop
Rename
Describe
Generate Recreate
Queryable

Notes:

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