Skip to content

Class: metadata

Layout rules streamline the data entry process by dynamically hiding irrelevant fields and sections on an object record detail page based on business needs.

AttributeMetadataDescription
displayed_as_required_fieldsType: String
Max length: 1500
Multi-value
Lists the fields Vault will display as required (with yellow background color and "*") when the layout rule evaluates to true.
displayed_as_readonly_fieldsType: String
Max length: 1500
Multi-value
Lists the fields Vault will display as read-only when the layout rule evaluates to true.
hide_controlsType: String
Max length: 1500
Multi-value
Indicates the custom control to hide in the layout rule.
hide_fieldsType: String
Max length: 1500
Multi-value
Indicates the fields to hide in the layout rule.
hide_sectionsType: String
Max length: 1500
Multi-value
Indicates the sections to hide in the layout rule.
hidden_pagesType: String
Max length: 1500
Multi-value
Lists the pages Vault will hide when the layout rule evaluates to true.
hide_layoutType: BooleanIf set to true, Vault hides this layout when the layout rule evaluates to true.
focus_on_layoutType: BooleanIf set to true, Vault displays this layout when the layout rule evaluates to true.
expressionType: String
Required
Max length: 3900
A valid expression.
activeType: Boolean
Required
Indicates whether the component is active.
orderType: NumberThe relative order of the layout rules on the Layout Rules list page.
descriptionType: String
Max length: 255
A general description of the Layout Rule.
labelType: String
Required
Max length: 40
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.