Skip to content

Class: metadata

The layout of an object detail page.

Learn about Layouts in Vault Help.

AttributeMetadataDescription
labelType: String
Required
Max length: 150
UI-friendly string in the Vault's base language.
default_layoutType: BooleanIf true, this layout is assigned to all users unless another layout is specified in their assigned layout profile.
page_markupType: XMLString
Required
Max length: 64000
Defines page layout using XML.
activeType: BooleanIndicates whether the component is active.
descriptionType: String
Max length: 255
A description of the layout.
display_lifecycle_stagesType: BooleanFor objects with lifecycle stages configured, if true, Vault displays the Lifecycle Stages Chevron panel on all views for the object.
OperationSupport
Create*
Recreate*
Alter*
Drop
Rename
Describe
Generate Recreate
Queryable

Notes:

  • Create, Recreate, Alter: MDL Operation is supported, but the Component Type contains field(s) that use proprietary XML. Direct modification of the XML is not supported or recommended. Instead, creating and/or updating the component is better suited through the Admin UI.