Skip to content

Qualityexternalnotificationtemplate

Class: metadata

This component type is only available in Quality Vaults with QMS enabled.

Defines a Notification Template, which determines the recipients and other configuration options for the associated Quality External Notification.

AttributeMetadataDescription
labelType: String
Max length: 60
UI-friendly string in the vault’s base language.
activeType: BooleanIndicates whether the component is active.
can_add_or_remove_documentsType: BooleanIf true, users can add or remove documents from the notification before sending.
can_add_or_remove_participantsType: Boolean
Required
If true, users can edit the recipients list for the notification before sending.
document_link_fieldType: SubcomponentThe text field on the supported object to contain the document package URL.
document_reference_fieldsType: Subcomponent
Multi-value
One or more document reference fields on the supported object. Vault includes all referenced documents in the document package.
download_optionType: Enum
Allowed values:
  • SOURCE
  • PDF
  • BOTH
  • NONE
Indicates the document rendition type(s) a recipient can download. If set to NONE, recipients cannot download the document.
expiry_periodType: NumberThe number of days the document package URL will remain available.
help_contentType: String
Max length: 255
UI-friendly help string.
notification_templateType: Component
Required
The Notificationtemplate configured for this Quality External Notification.
object_fields_on_documentType: Component
Multi-value
The document field referencing the target object.
quality_external_notificationType: ComponentReference
Required
The associated Qualityexternalnotification.
recipientType: SubcomponentSpecifies a single Person object reference field to receive notifications.
recipient_rolesType: String
Max length: 255
Multi-value
Specifies one or more application roles to receive notifications.
recipientsType: Subcomponent
Multi-value
Specifies the Person object reference field(s) to receive notifications.
target_objectType: Component
Required
The object associated with the Quality External Notification.

Qualityextnotificationtemplatedistgroup

Section link for Qualityextnotificationtemplatedistgroup
AttributeMetadataDescription
labelType: String
Max length: 60
UI-friendly string in the vault’s base language.
activeType: BooleanIndicates whether the component is active.
quality_distribution_groupType: SubcomponentReference
Required
The associated Qualitydistributiongroup.
quality_external_notificationType: ComponentReference
Required
The associated Qualityexternalnotification.
OperationSupport
Create
Recreate
Alter
Drop
Rename
Describe
Generate Recreate
Queryable