Disclosurerule

Class: metadata

This component type is specific to Clinical Operations Vaults and supports the Veeva Disclosures feature of the CTMS and eTMF applications.

Disclosure Rules control the user actions that trigger Vault to create Disclosure records for supported registries, and the timing for those records.

Learn more about Disclosure Rules in Vault Help.

Attribute	Metadata	Description
`label`	Type: String Max length: 60	UI-friendly string in the Vault's base language.
`active`	Type: Boolean	Indicates whether the component is active.
`assessment_value`	Type: String Max length: 1500	Read-only. Indicates whether the Disclosure record should be submitted to the health authority.
`authority`	Type: String Required Max length: 1500	Read-only.The health authority for the Disclosure, for example, ClinicalTrials.gov.
`compliance_date_shift`	Type: Number Required	Read-only. The number of compliance date shift units by which to shift the Compliance Date. For example, if the Compliance Date is 01/01/2035, setting `compliance_date_shift` to `6` and `compliance_date_shift_units` to `months` moves the Compliance Date to 07/01/2035.
`compliance_date_shift_units`	Type: Enum Required Allowed values: days months years	Read-only. The unit of time by which to shift the Compliance Date. For example, if the Compliance Date is 01/01/2035, setting `compliance_date_shift` to `2` and `compliance_date_shift_units` to days moves the Compliance Date to 01/03/2035.
`country`	Type: String Required Max length: 1500	Read-only. The Study Country for which the Disclosure Rule is applicable.
`disclosure_subtype`	Type: String Required Max length: 1500	Read-only.The Disclosure Subtype for which the Disclosure Rule is applicable.
`disclosure_type`	Type: String Required Max length: 1500	Read-only.The Disclosure Type for which the Disclosure Rule is applicable.
`due_date_shift`	Type: Number Required	The unit of time by which to shift the Due Date. For example, if the Due Date is 01/01/2035, `setting due_date_shift` to `2` and `due_date_shift_units` to `days` moves the Due Date to 01/03/2035.
`due_date_shift_units`	Type: Enum Required Allowed values: days months	The unit of time by which to shift the Due Date. For example, if the Due Date is 01/01/2035, setting `due_date_shift` to `2` and `due_date_shift_units` to `days` moves the Due Date to 01/03/2035.
`help_text`	Type: String Required Max length: 1500
`milestone_level`	Type: String Max length: 1500	Read-only. The Milestone Level that triggers the Disclosure Rule.
`milestone_type`	Type: String Max length: 1500	Read-only. The Milestone Type that triggers the Disclosure Rule.
`object_key`	Type: Component Required	Read-only. The object for the Disclosure Rule.
`rule_type`	Type: Enum Required Allowed values: Scheduled Event_Based
`rules_version`	Type: String Required Max length: 1500	Read-only. The Rules Version for the Disclosure Rule.
`start_date_shift`	Type: Number
`trigger_or_sys_action`	Type: String Required Max length: 1500	Read-only. The event or action that triggers the Disclosure Rule.
`workflow_initiated`	Type: Component	Read-only. The workflow that will be initiated for the Disclosure.

Supported Operations

Operation	Support
Create
Recreate
Alter
Drop
Rename
Describe
Generate Recreate
Queryable