Workflow Behaviors

Summary

Workflow Behaviors allow many different types of functionality to be attached to a Workflow Action button. They are often used to send notifications and trigger 3rd party integrations.

Overview

Workflows provide a powerful way of describing a data collection and review process, but real-world implementations need to do much more than that to be useful. Workflow Behaviors allow those data entry forms to be extended in many different ways, such as:

Sending email notifications to alert people in a change in status
Triggering other Workflow Actions, to chain business events together
Updating data attributes of the current Workflow that were not present on the data entry form (usually used in conjunction with Template attributes or comparison rules to implement custom business rules)
Updating other Workflows, to implement business scenarios that cut across multiple people or applications
Triggering 3rd party integrations

Behaviors can be attached to these aspects of a Workflow:

Workflow Actions
Workflow Steps (for scheduled execution)
Workflow Completion Status (for execution when the Workflow reaches a terminal state with a specific status)

Behavior triggers

Behaviors can be "triggered" in multiple ways:

Workflow Action Trigger: Behaviors can be attached to specific Actions and are executed whenever the Action is performed (either through the UI or programatically)
Completion Status Trigger: Behaviors can be attached to the terminal states (either successful or unsuccessful) and are executed whenever the Workflow is moved into that state
Scheduled Interval Trigger: Behaviors can be attached to specific Workflow Steps and are executed on a recurring basis (daily, monthly, etc) by the nightly "Scheduled Task" automation

Conditional execution

As of 10.4, Behaviors can be conditionally executed based on a Comparison Rule. See Conditional Behaviors

Behavior Types

(Note: some Behaviors apply only to specific Workflow Types)

For JSON argument structure and field reference, see Behavior Arguments JSON Reference.

Behavior	Function / Notes	Supported Triggers	Supported Workflows

Behavior	Function / Notes	Supported Triggers	Supported Workflows
Add Member Role to Print Queue `ADD_MEMBER_ROLE_TO_PRINT_QUEUE`	Adds the "owning Member Role" (which is different for each Workflow type) to a Print Queue, so that one or more printed documents will be generated. The target queue can be specified explicitly, or the queue name can be derived from a Workflow Attribute.	Workflow Action Completion Status Scheduled Interval	Create Activity Complete Activity Complete Learning Plan Grant / Edit Role
Call External API `CALL_EXTERNAL_API`	Calls an external API and stores the result in a specified Attribute	Workflow Action Completion Status Scheduled Interval
Call Pearson VUE APIs `CALL_PEARSON_VUE_APIS`	Sends candidate and eligibility data to Pearson VUE using the v2 API integration. Extends Call External API.	Workflow Action Completion Status Scheduled Interval
Claim PSI Atlas Exam Results `CLAIM_PSI_ATLAS_EXAM_RESULTS`	Claims exam results from PSI Atlas and stores disposition, score, and other result data in attributes.	Workflow Action Completion Status Scheduled Interval	Complete Activity
Create or Update Seat Assignment `CREATE_OR_UPDATE_SEAT_ASSIGNMENT`	Creates or updates a seat assignment record, with per-field source strategies for offering code, seat number, capacity, and status.	Workflow Action Completion Status Scheduled Interval	Create Offering
Generate PDF `GENERATE_PDF`	Evaluates a System Template, converts the result to a PDF, and stores the file in an S3 File Library or an S3 Upload Attribute.	Workflow Action Completion Status Scheduled Interval	All
Issue or Replace Credly Badge `ISSUE_DIGITAL_BADGE_CREDLY`	Issues a digital badge through the Credly Acclaim platform.	Workflow Action Completion Status Scheduled Interval	Create Activity Complete Activity Complete Learning Plan Grant / Edit Role
Perform Workflow Action Behaviors `BULK_ACTIVITY_ACTION` · `PERFORM_ACTION_ON_ALL_PARENT_LEARNING_PLAN_INSTANCES` · `PERFORM_ACTION_ON_LINKED_LEARNING_PLAN_INSTANCE` · `WORKFLOW_STEP_ACTION`	Triggers a Workflow Action programmatically on a set of related Workflow instances without requiring a user to click a button. Several variants are available, differing in what objects are targeted: all Activity Instances on a Learning Plan, a linked Learning Plan Instance, all parent Learning Plan Instances, or the current Workflow on a scheduled interval.	Workflow Action Completion Status Scheduled Interval	All (Complete Activity only for parent/linked LPI variants)
Run Stored Procedure `RUN_STORED_PROCEDURE`	Immediately executes a custom Stored Procedure. Note: the changes made by this procedure might not be immediately visible to other Behaviors that were triggered at the same time, depending on which entities are currently in memory.	Workflow Action Completion Status Scheduled Interval
Send Email Behaviors `SEND_A_GROUP_EMAIL` · `SEND_EMAIL_TO_ASSIGNEE` · `SEND_EMAIL_TO_EMAIL_ADDRESS` · `SEND_EMAIL_TO_MEMBER` · `SEND_EMAIL_TO_OFFERING_ATTENDEES`	Sends an email notification from a Workflow. Several variants are available, differing only in how recipients are identified: by Role, by Workflow Assignee, by Email Address Attribute, by Member record, or by Offering Seat Assignment.	Workflow Action Completion Status Scheduled Interval	All (Create Offering only for Offering Attendees variant)
Send Exam Eligibility to Pearson VUE `SEND_EXAM_ELIGIBILITY_TO_PEARSON`	Sends an "Authorization to Test" notification to Pearson VUE, which establishes a candidate record and allows the member to schedule their exam.	Workflow Action Completion Status Scheduled Interval
Send Exam Eligibility to Prometric GEE `PROMETRIC_GEE_TEST_AUTH`	Sends an "Authorization to Test" notification to Prometric's Generic Eligibility Engine, which establishes a candidate record and allows the member to schedule their exam.	Workflow Action Completion Status
Send Exam Eligibility to PSI Atlas `SEND_EXAM_ELIGIBILITY_TO_PSI_ATLAS`	Sends an "Authorization to Test" notification to PSI's "Atlas" system, which establishes a candidate record and allows the member to schedule their exam.	Workflow Action	Complete Activity
Send Exam Eligibility to Prolydian `SEND_EXAM_ELIGIBILITY_TO_PROLYDIAN`	Sends an "Authorization to Test" notification to Prolydian's system, which establishes a candidate record and allows the member to schedule their exam.	Workflow Action	Complete Activity
Send to Learning Hub `SEND_TO_LEARNING_HUB`	Publishes a Workflow's data to the Learning Hub	Workflow Action	Complete Activity
Send to Queue `SEND_TO_QUEUE`	Adds a custom message to a message queue for out-of-band processing. Commonly used to integrate with 3rd party APIs that do not have "first-class" support in LearningBuilder. This is an advanced configuration feature and often requires custom programming in the Integration Hub to process the messages.	Workflow Action Completion Status Scheduled Interval
Synchronize Linked Attributes `SYNCHRONIZE_LINKED_ATTRIBUTES`	Copies attribute values between a learning plan instance and its owning member role in a specified direction.	Workflow Action Completion Status Scheduled Interval	Complete Learning Plan
Update Address Attribute From Profile Address `UPDATE_ADDRESS_ATTRIBUTE_FROM_PROFILE`	Updates an Address Attribute, populating it from a specified Profile Address.	Workflow Action Completion Status Scheduled Interval	Create Activity Complete Activity Complete Learning Plan Grant / Edit Role
Update Cycle and Reporting Dates for Learning Plan Instance `UPDATE_LEARNING_PLAN_INSTANCE_DATES`	Updates the Cycle and Reporting Dates on a Learning Plan Instance	Workflow Action Scheduled Interval	Complete Learning Plan
Update Member Role Attribute `UPDATE_ROLE_ATTRIBUTE`	Updates a Member Role attribute matching specified criteria. Supports Multi-Instance Member Roles.	Workflow Action Completion Status Scheduled Interval	Create Activity Complete Activity Complete Learning Plan Grant / Edit Role
Update Member Role Attribute for Activity Instance `UPDATE_ROLE_ATTRIBUTE_FOR_ACTIVITY_INSTANCE`	Updates a Member Role Attribute on all `Member Roles` that own a Learning Plan Instance that contains the triggering Activity Instance. This can be used to copy data from an Activity Instance to its owning Member Role(s).	Workflow Action Completion Status Scheduled Interval	Complete Activity
Update Member Role Attribute for Learning Plan Instance `UPDATE_ROLE_ATTRIBUTE_FOR_LEARNING_PLAN`	Updates Member Role Attributes for the Member Role that owns a Learning Plan Instance	Workflow Action Completion Status Scheduled Interval	Complete Learning Plan
Update Owner Profile `UPDATE_OWNER_PROFILE`	Updates properties of an underlying `Member`, setting them from specific attributes on a `Member Role`	Workflow Action Completion Status Scheduled Interval	Grant / Edit Role
Update Workflow Instance Attribute `UPDATE_WORKFLOW_INSTANCE_ATTRIBUTE`	Updates a specified Attribute on the Workflow's "Write-To" entity	Workflow Action Completion Status Scheduled Interval
Update Workflow Instance Status `UPDATE_WORKFLOW_INSTANCE_STATUS`	Can modify the `Completion Status` and `Current Step` properties of a `Workflow Instance`. Multiple Behaviors can be added to a Save action, each with different Conditional Behavior rules, to dynamically modify the Workflow status.	Workflow Action	Create Activity Complete Activity Complete Learning Plan Grant / Edit Role