Skip to main content

Automation Metadata

Overview

Define metadata related to process automation

  • Object Validation Rules
  • Workflow Rules
  • Field Updates
  • Workflow Notifications
  • Record Modifications (Create, Update, Delete)
  • Approval Processes
  • Process
  • Flow

Object Validation Rules object_validation_rules

object_validation_rules.validationRule.yml
Used for storing validation rules configured on the object. The validation rules are mainly used to verify whether the object data meets specific rules. When a user's modification to a field of the object does not meet the validation rules created by the user, the user's input cannot be saved.

name: test
active: true
description: Description for object validation rules
error_condition_formula: 1==1
error_message: Error message prompt
Field NameField TypeField Meaning
nametextRule Name
object_namemaster_detailBelonging Object
activebooleanEnabled
descriptiontextareaDescription
error_condition_formulatextareaError Condition Formula
error_messagetextareaError Message

Workflow Rules workflow_rule

object_name.workflow.yml
Used for storing workflow rules configured by administrators in the process automation settings.

rules:
- name: test
active: true
description: Description information
formula: 1=1
label: Test Workflow Rule
object_name: testobject__c
trigger_type: onCreateOrTriggeringUpdate
updates_field_actions: []
workflow_notifications_actions: []
fieldUpdates: []
notifications: []
Field NameField TypeField Meaning
object_namelookupObject
nametextAPI Name
labeltextDisplay Name
activebooleanEnabled
trigger_typeselectEvaluation Condition
formulatextareaFormula
updates_field_actionslookupField Updates
workflow_notifications_actionslookupWorkflow Notifications
descriptiontextareaDescription

Field Updates action_field_updates

object_name.workflow.yml
Used to store field update information configured by administrators in the process automation settings.

fieldUpdates:
- name: fieldupdate
description: Description
field_name: name
formula: '{ ''Full Name'' }'
label: Field Update Test
object_name: testobject__c
operation: formula
reevaluate_on_change: true
target_object: testobject__c
undirect: true
Field NameField TypeField Meaning
nametextAPI Name
labeltextDisplay Name
object_namelookupObject
target_objectlookupObject to be Updated
field_namelookupField to be Updated
operationlookupType of New Field Value
formulatextareaFormula
literal_valuetextSpecified New Field Value
notify_assigneebooleanNotify Assignee (only when modifying owner)
descriptiontextareaDescription
reevaluate_on_changebooleanRe-evaluate Workflow Rules after Field Change
undirectbooleanTrigger Object Triggers, Workflow Rules, Field Validation Rules

Workflow Notifications workflow_notifications

object_name.workflow.yml
Used to store workflow notification information configured by administrators in the process automation settings.

notifications:
- name: worktalk
assigned_user_field: []
body: '{ ''Hahaha'' }'
label: Workflow Notification Test
object_name: testobject__c
title: '{ ''Title Formula'' }'
Field NameField TypeField Meaning
nametextAPI Name
labeltextDisplay Name
object_namelookupObject
titletextareaTitle Formula
bodytextareaBody Formula
assigned_userslookupSpecify Specific Users
assigned_user_fieldlookupSpecify User Field on the Object

Note: The Workflow Rules, Field Updates, and Workflow Notifications are in the same file!

Approval Processes process_definition

Used for storing the approval process information configured by administrators in the application settings.

name: process_definition
label: Approval Processes
hidden: true
icon: approval
enable_inline_edit: false
Field NameField TypeField Meaning
nametextAPI Name
labeltextDisplay Name
object_namelookupObject
descriptiontextareaDescription
ordernumberSerial Number
activebooleanEnabled
entry_criteriatextareaSpecified Entry Conditions
record_editabilityselectRecord Editability Property
allow_recallbooleanAllow Submitter to Cancel Application
initial_submission_record_lockselectLock Record
initial_submission_updates_field_actionslookupField Updates
initial_submission_workflow_notifications_actionslookupWorkflow Notifications
final_approval_record_lockselectLock Record
final_approval_updates_field_actionslookupField Updates
final_approval_workflow_notifications_actionslookupWorkflow Notifications
final_rejection_record_lockselectLock Record
final_rejection_updates_field_actionslookupField Updates
final_rejection_workflow_notifications_actionslookupWorkflow Notifications
recall_record_lockselectLock Record
recall_updates_field_actionslookupField Updates
recall_workflow_notifications_actionslookupWorkflow Notifications
Permission Attributesuseradmin
allowCreatefalsetrue
allowDeletefalsetrue
allowEditfalsetrue
allowReadtruetrue
modifyAllRecordsfalsetrue
viewAllRecordstruetrue