Skip to content

Docatomicsecurity

Class: metadata

Atomic security for documents provides more granular control, based on lifecycle state and role, over who can perform specific lifecycle user actions like changing document state and starting a workflow. For example, the Editor role may be able to start the Review workflow, but not the Expedited Approval workflow.

AttributeMetadataDescription
labelType: String
Max length: 60
UI-friendly string in the Vault's base language.
activeType: BooleanIndicates whether the field is active.
document_lifecycleType: Component
Required
Indicates the lifecycle that atomic security applies to.
stateType: String
Required
Max length: 1500
Indicates the lifecycle state that atomic security applies to.
AttributeMetadataDescription
labelType: String
Max length: 60
UI-friendly string in the Vault's base language.
activeType: BooleanIndicates whether the field is active.
roleType: String
Required
Max length: 1500
Indicates the role override that the permission applies to.
typeType: Enum
Required
Allowed values:
  • hide__v
  • view__v
  • execute__v
Indicates the permission type.
workflow_actionsType: Enum
Multi-value
Allowed values:
  • cancel
  • addparticipants
  • removecontent
  • emailparticipants
  • updateworkflowduedate
Indicates the active workflow action that the permission applies to.
workflow_task_actionsType: Enum
Multi-value
Allowed values:
  • cancel
  • reassign
  • updateduedate
Indicates the active workflow task action that the permission applies to.
AttributeMetadataDescription
labelType: String
Max length: 60
UI-friendly string in the Vault's base language.
activeType: BooleanIndicates whether the field is active.
roleType: String
Required
Max length: 1500
Indicates the role override that the permission applies to.
typeType: Enum
Required
Allowed values:
  • hide__v
  • view__v
  • execute__v
Indicates the permission type.
lifecycle_actionsType: String
Max length: 1500
Multi-value
Indicates the user action that the permission applies to.
OperationSupport
Create
Recreate
Alter*
Drop
Rename
Describe
Generate Recreate
Queryable

Notes:

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