Job

Class: metadata

Vault's job scheduler provides a simpler, streamlined way for Admins to create a batch operation and schedule it to repeatedly execute.

Learn about Jobs in Vault Help.

Attribute	Metadata	Description
label	Type: String Required Max length: 1500	UI-friendly string in the Vault's base language.
trigger_date	Type: Expression Max length: 4000	(Date Based Object Operation and Date Based Document Operation jobs only) The object record or document’s Date or DateTime field, as of the job’s run date, that Vault evaluates each time the job runs.
active_after_clone	Type: Boolean	Determines if the job will be set to an active state when the cloned Vault is created. If no value is specified, the default value is false.
usages	Type: Enum Multi-value Allowed values: WORKFLOW	If specified, the Job is available for use in a workflow Job step. Cannot be used for Scheduled Data Export or EDL jobs.
auto_complete_workflow_step	Type: Boolean	If true, the Job automatically completes the corresponding workflow Job step that started the Job. The Job specified in the Job step must not have this attribute set to true. Can only be true when usages contains WORKFLOW.
month_repeat_type	Type: Enum Allowed values: dayOfTheMonth dayOfTheWeek	Day of the month or week for a scheduled job.
week_day	Type: Enum Allowed values: Sun Mon Tue Wed Thu Fri Sat	Day of the week.
repeat_on_days	Type: Enum Multi-value Allowed values: Sun Mon Tue Wed Thu Fri Sat	The day(s) of the week to repeat the job on. For example, 'Mon','Wed','Fri'.
timezone	Type: String Max length: 1500	Timezone as used in the TZ variable. For example: America/Los_Angeles. If omitted or blank, the default value is the Vault time zone.
hourly_interval	Type: Number	For jobs where schedule is set to hourly, the number of hours to wait before repeating the job. Allowed values are 1, 2, 3, 4, 6, 12.
schedule	Type: String Max length: 1500	The frequency of a scheduled job. Options: Manual Once Hourly Daily Weekly Monthly
active	Type: Boolean Required	Indicates whether the component is active.
priority	Type: String Max length: 1500	Indicates job priority. For example, normal
type	Type: String Max length: 1500	Indicates job type. For example: Task Reminder Notification Date Based Document Operation
owner	Type: String Max length: 1500	The group or user that owns the report job.
day_of_month	Type: Number	Specify the day of the month for a monthly report.
time	Type: String Max length: 1500	The scheduled time of the report job. Format = hour:min hour: 24 hour clock min: 00-60 For example, 22:30.
week_number	Type: Number	Week number for a monthly report that runs on a "day of the week."

Changestatejobaction

Section link for Changestatejobaction

Vault's job scheduler provides a simpler, streamlined way for Admins to create a batch operation and schedule it to repeatedly execute.

Attribute	Metadata	Description
label	Type: String Required Max length: 1500	UI-friendly string in the Vault’s base language.
primary_action	Type: Boolean	The primary operation that the job completes. Always set to true.
related_doc_conditions	Type: String Max length: 1500 Multi-value	The set of conditions that must be met for the job to execute on any related documents.
notify_on_status_condition	Type: Boolean	Always set to true.
trigger_date_target	Type: String Max length: 1500	Defines the date field to be evaluated against the trigger date.
relationship_types	Type: String Max length: 1500 Multi-value	Defines which document relationship type to run the primary action on.
conditions	Type: String Max length: 1500 Multi-value	The set of conditions that must be met for the job to execute on any records.
terminate_existing_workflows	Type: Boolean	Indicates whether to cancel existing workflows to perform action.
override_checkout_state_change	Type: Boolean	If true, allow the state change action to proceed even when a minor version of the document is checked out. Only available when the configured Current State is the lifecyle’s configured steady state type and the destination_state is the lifecycle’s configured obsolete state type.
document_version	Type: Enum Allowed values: absolute_latest latest_steady_state	Determines which document version the job will run on.
destination_state	Type: String Max length: 1500	Defines the lifecycle state to set.

Sendnotificationjobaction

Section link for Sendnotificationjobaction

Vault's job scheduler provides a simpler, streamlined way for Admins to create a batch operation and schedule it to repeatedly execute.

Attribute	Metadata	Description
label	Type: String Required Max length: 1500	UI-friendly string in the Vault's base language.
primary_action	Type: Boolean	The primary operation that the job completes. Always set to true.
related_doc_conditions	Type: String Max length: 1500 Multi-value	The set of conditions that must be met for the job to execute on any related documents.
notify_on_status_condition	Type: Boolean	Always set to true.
trigger_date_target	Type: String Max length: 1500	Defines the date field to be evaluated against the trigger date.
relationship_types	Type: String Max length: 1500 Multi-value	Defines which document relationship type to run the primary action on.
conditions	Type: String Max length: 1500 Multi-value	The set of conditions that must be met for the job to execute on any records.
recipients	Type: String Max length: 1500 Multi-value	Defines the notification recipients based on a list of roles on the affected records.
template	Type: String Max length: 1500	Defines the notification template to be used when sending a notification as a result of the job.

Sendobjectnotificationjobaction

Section link for Sendobjectnotificationjobaction

Vault's job scheduler provides a simpler, streamlined way for Admins to create a batch operation and schedule it to repeatedly execute.

Attribute	Metadata	Description
label	Type: String Required Max length: 1500	UI-friendly string in the Vault's base language.
primary_action	Type: Boolean	The primary operation that the job completes. Always set to true.
conditions	Type: String Required Max length: 1500 Multi-value	The set of conditions that must be met for the job to execute on any records.
object	Type: String Required Max length: 1500	Defines the Vault Object the job will run on. Only records in this Object can be affected.
recipients	Type: String Max length: 1500 Multi-value	Defines the notification recipients based on a list of roles on the affected records.
template	Type: String Max length: 1500	Defines the notification template to be used when sending a notification as a result of the job.

Changeobjectstatejobaction

Section link for Changeobjectstatejobaction

Vault's job scheduler provides a simpler, streamlined way for Admins to create a batch operation and schedule it to repeatedly execute.

Attribute	Metadata	Description
label	Type: String Required Max length: 1500	UI-friendly string in the Vault's base language.
primary_action	Type: Boolean	The primary operation that the job completes. Always set to true.
conditions	Type: String Required Max length: 1500 Multi-value	The set of conditions that must be met for the job to execute on any records.
object	Type: String Required Max length: 1500	Defines the Vault Object the job will run on. Only records in this Object can be affected.
terminate_existing_workflows	Type: Boolean Required	Indicates whether to cancel existing workflows to perform action.
destination_state	Type: String Required Max length: 1500	Defines the lifecycle state to set.

Noopjobaction

Section link for Noopjobaction

Vault's job scheduler provides a simpler, streamlined way for Admins to create a batch operation and schedule it to repeatedly execute.

Attribute	Metadata	Description
label	Type: String Required Max length: 1500	UI-friendly string in the Vault's base language.
primary_action	Type: Boolean	The primary operation that the job completes. Always set to true.
related_doc_conditions	Type: String Max length: 1500 Multi-value	The set of conditions that must be met for the job to execute on any related documents.
notify_on_status_condition	Type: Boolean	Always set to true.
trigger_date_target	Type: String Max length: 1500	Defines the date field to be evaluated against the trigger date.
relationship_types	Type: String Max length: 1500 Multi-value	Defines which document relationship type to run the primary action on.
conditions	Type: String Max length: 1500 Multi-value	The set of conditions that must be met for the job to execute on any records.
recipients	Type: String Max length: 1500 Multi-value	Defines the notification recipients based on a list of roles on the affected records.
template	Type: String Max length: 1500	Defines the notification template to be used when sending a notification as a result of the job.

Objectnoopjobaction

Section link for Objectnoopjobaction

Vault's job scheduler provides a simpler, streamlined way for Admins to create a batch operation and schedule it to repeatedly execute.

Attribute	Metadata	Description
label	Type: String Required Max length: 1500	UI-friendly string in the Vault's base language.
primary_action	Type: Boolean	The primary operation that the job completes. Always set to true.
conditions	Type: String Required Max length: 1500 Multi-value	The set of conditions that must be met for the job to execute on any records.
object	Type: String Required Max length: 1500	Defines the Vault Object the job will run on. Only records in this Object can be affected.

Httppostjobaction

Section link for Httppostjobaction

Vault's job scheduler provides a simpler, streamlined way for Admins to create a batch operation and schedule it to repeatedly execute.

Attribute	Metadata	Description
label	Type: String Required Max length: 1500	UI-friendly string in the Vault's base language.
primary_action	Type: Boolean	The primary operation that the job completes. Always set to true.
session_granted_by	Type: String Max length: 1500	Defines which user to "Run as".
external_url	Type: String Max length: 1500	Defines (as a link) what URL is accessed when the job executes the External URL Call job action.
run_as_user	Type: String Max length: 1500	Defines the user account the Vault uses to complete an external URL call job.
post_session_creds	Type: Boolean	Indicates whether to post session credentials via form data with key "Session.id".

Sdkbatchjobaction

Section link for Sdkbatchjobaction

Vault's job scheduler provides a simpler, streamlined way for Admins to create a batch operation and schedule it to repeatedly execute.

Attribute	Metadata	Description
label	Type: String Required Max length: 1500	UI-friendly string in the Vault's base language.
primary_action	Type: Boolean	The primary operation that the job completes. Always set to true.
job_metadata	Type: String Required Max length: 1500	Reference to the Jobmetadata component of the job to be run.
parameters	Type: String Max length: 1500	Defines Generate Document from Workflow Job configuration. Learn more in Vault Help.

Edlmatchjobaction

Section link for Edlmatchjobaction

Vault's job scheduler provides a simpler, streamlined way for Admins to create a batch operation and schedule it to repeatedly execute.

Attribute	Metadata	Description
label	Type: String Required Max length: 1500	UI-friendly string in the Vault's base language.
primary_action	Type: Boolean	The primary operation that the job completes. Always set to true.
conditions	Type: String Max length: 1500 Multi-value	The set of conditions that must be met for the job to execute on any records.

Rmsintegrationjobaction

Section link for Rmsintegrationjobaction

Vault's job scheduler provides a simpler, streamlined way for Admins to create a batch operation and schedule it to repeatedly execute.

Attribute	Metadata	Description
label	Type: String Required Max length: 1500	UI-friendly string in the Vault's base language.
primary_action	Type: Boolean	The primary operation that the job completes. Always set to true.
conditions	Type: String Max length: 1500 Multi-value	The set of conditions that must be met for the job to execute on any records.

Flashreportjobaction

Section link for Flashreportjobaction

Vault's job scheduler provides a simpler, streamlined way for Admins to create a batch operation and schedule it to repeatedly execute.

Attribute	Metadata	Description
label	Type: String Required Max length: 1500	UI-friendly string in the Vault's base language.
primary_action	Type: Boolean	The primary operation that the job completes. Always set to true.
report_name	Type: String Max length: 1500	Defines the name of the report.
include_report_in_email	Type: Boolean	Indicates whether to include a copy of the report in the notification.
collapse_groups	Type: Boolean	If true, a flash report will expose only group level information in emails.
send_notifications_on_completion	Type: Boolean	Always set to true.
only_send_notifications_if_result	Type: Boolean	Indicates whether to send a notification when no results are returned.
send_notifications_to_group_by_users	Type: Boolean	If true for flash reports grouped by user fields, Vault distributes reports to the users in report resuts. Users only see the report results associated with them.
enable_flash_refresh	Type: Boolean	If true, a flash report may be refreshed by users.
send_standard_email_to_shared_users	Type: Boolean	If true, Vault sends standard email notifications to manually added report users.
custom_flash_email	Type: Boolean	If true, allows you to customize the email using the values of custom_flash_email_subject and custom_flash_email_body.
custom_flash_email_subject	Type: String Max length: 1500	The subject for the custom notification email when custom_flash_email is true.
custom_flash_email_body	Type: String Max length: 1500	The body for the custom notification email when custom_flash_email is true.

Schedulededcjobactions

Section link for Schedulededcjobactions

Vault's job scheduler provides a simpler, streamlined way for Admins to create a batch operation and schedule it to repeatedly execute.

Attribute	Metadata	Description
label	Type: String Required Max length: 1500	UI-friendly string in the Vault's base language.
primary_action	Type: Boolean	The primary operation that the job completes. Always set to true.
edcAsyncPayload	Type: JSONString Max length: 32000	For internal Veeva use only.

Scheduleddataexportjobaction

Section link for Scheduleddataexportjobaction

Vault's job scheduler provides a simpler, streamlined way for Admins to create a batch operation and schedule it to repeatedly execute.

Attribute	Metadata	Description
label	Type: String Required Max length: 1500	UI-friendly string in the Vault's base language.
primary_action	Type: Boolean	The primary operation that the job completes. Always set to true.
selected_entities	Type: LongString Required Max length: 32000	A comma-separated list of all selected entities to export.
data_storage_option	Type: Enum Required Allowed values: VAULT_FILE_STAGING CUSTOM_S3_BUCKET	If set to VAULT_FILE_STAGING, the email or in-app notification when the job is complete includes a link to download exported files from the staging server. If set to CUSTOM_S3_BUCKET, Vault sends the exported files to an external storage service.
enable_full_data_export	Type: Boolean Required	If set to true, enables full data export option and the job exports all data for the selected entities. You can only enable the full data export option once every 30 days. After executing as true, the system sets this parameter back to false. The default value is false.

Documentperiodicreviewjobaction

Section link for Documentperiodicreviewjobaction

Vault's job scheduler provides a simpler, streamlined way for Admins to create a batch operation and schedule it to repeatedly execute.

Attribute	Metadata	Description
label	Type: String Required Max length: 1500	UI-friendly string in the Vault's base language.
primary_action	Type: Boolean	The primary operation that the job completes. Always set to true.
conditions	Type: String Max length: 1500 Multi-value	The set of conditions that must be met for the job to execute on any records.

Supported Operations

Section link for Supported Operations

Operation	Support
Create
Recreate
Alter	*
Drop
Rename
Describe
Generate Recreate
Queryable

Notes:

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