You are here: Reference > Rule types > Flow Actions > Standard flow actions (local only)

Standard Flow Actions (Local)

The Pega Platform contains dozens of standard flow action instances in the Work- class for you to use or copy and modify. You can reference them in your application or copy and modify them to meet your custom needs.

To select at runtime one of these flow actions in a user form, your access role must provide the AllFlowActions privilege or the ActionZzzzz privilege, where Zzzzz is the name of the standard flow action.

This table shows selected standard flow actions that can be used only as local flow actions, those that do not complete an assignment. Other standard flow actions can be used as either local flow actions or connector flow actions. They are not listed here. See Standard Flow Actions (Connector/Local).

Users can select one of these flow actions at runtime only if they hold the AllFlowActions privilege or the ActionZzzzz privilege, where Zzzzz is the name of the standard flow action.

Use this table as a starting point only, to identify flow actions that may be useful for your application. Do not rely on the second key part (property pyAction) the Short Description (property pyLabel) alone; review the entire flow action for suitability for your requirements. Two flow actions may have nearly identical function but distinct Short Description text, each suitable in context. Conversely, two flow actions may have similar Short Description text but provide different processing.

Except as indicated, all these flow actions have Work-. as the Applies To key part.

A

Flow Action

Purpose

More...
AddAttachments Add a file attachment and assign it to an attachment category. Attachment category
Work-Cover-.AddCovered Adds a covered work object to the current (covering) object. Override this standard flow action to specify the work type of the covered work object. cover
AddFlow Start a new flow execution for this work item.
AddMultipleAttachments Add multiple file attachments, with a category for each, in a single action. Attachment category
AddParty Add a party to a work item, as controlled by the associated work parties rule. work party
AddToCover Include this work item as belonging to a cover, another work item in a Work-Cover- class. This flow action supports a search for the appropriate cover and selection from search results. By default, not eligible for bulk processing. cover
AddtoFolder Create a Link-Folder instance associating this work item with a folder. Select the work pool, then select the folder work item. folder
pyAdjustAssignmentSLA

Prompts for an SLA and applies it to the current assignment. An audit note is added if it is present. There are two basic options, both of which can be used in bulk operations.

The Adjust times options allows you to adjusts goal and deadline times of assignments. Adjust by a fixed amount of time or by adding or subtracting an interval of time. The Re-execute escalation actions when the new goal/deadline are met check box appears only when the goal/deadline has passed. Select the option to repeat already executed actions when the new Goal and Deadline are met. If not checked, the next escalation action is computed according to the normal practice for service-level agreements.

The Change to a new SLA option lets you apply a different SLA to the assignment.

service-level agreement
pyAttachContent Attach a file , including an attachment category and a name, to a case. Supports browsing and drag and drop for the files to be attached.
AttachANote Type in a text note that becomes an attachment to the work item.
AttachAScreenShot Select one window from a list of windows on the Windows desktop, and then capture and attach a screen shot JPG image to the work item history, with an explanatory note.
AttachAUrl Attach a URL reference to the work object with an explanatory note.
AttachFromScanner Starts the Image Viewer tool to view or update a TIFF file from a scanner. About the Image Viewer

C

Flow Action

Purpose

More...

ChangeOwnerOrg Change the ownership of the work object — organization, division, or unit. By default, not eligible for bulk processing.
ChangeSatisfaction Change the value of root cause, customer satisfaction status, and work item status. By default, not eligible for bulk processing. customer satisfaction
ChangeWorkSLA Update the service-level agreement and related fields (goal and deadline date/times, urgency adjustments) for work object and current assignment. service-level agreement

E to H

Flow Action

Purpose

More...

EditAttachment Create a version of a file attachment using a workstation program based on the file type of an attachment. (For example, if the file type is XLS, the program is Microsoft Excel.) By default, this flow action is not eligible for bulk processing. file attachment
Flows Presents the Start a new process button, allowing the user to select and start an additional flow execution on this work item.

I to Z

Flow Action

Purpose

More...

RequestAssistance Allows users to request that a co-worker enter a note attachment.

Add the RequestAssistance flow action to call the RequestAssistance flow (on the same work item). Connect completion of that flow to the original (or another) assignment in the first flow.

RejectSample Enter a text note (property .pyDetail). Does not update work item status. This action used in applications created by the (basic) Application Accelerator.
RemoveFromCover Remove the work item from the cover. cover
RemoveFromFolder End the association of the work item with a specific folder work item. folder
Save Update the work item without completing the assignment, saving changes to various property values. Validation occurs.
SelectRecipientsAndAttachments Select multiple To, CC, and BCC recipients for email correspondence.
SendCorrespondence Select the recipient party. The recipient must be a valid choice when assignments are transferred in bulk. This flow action calls the BuildCorr flow. By default, not eligible for bulk processing. work party
pyTransferAssignment Transfer an assignment to another operator, work queue, manager, work group, operator in a specified work group. Advanced options to specify escalation actions, due dates, update status, and instructions. This flow action keeps the context of the current assignee. For instance, the logged in user using this action is the current assignee, not the reporting manager to whom the assignment is being transferred.
pyUpdateCase

Dynamically search for and add properties that you want to update. The flow action opens up with empty list. You can override the standard pyUpdate data transform in the case type class and set properties that you want to automatically set/view along with the default values. Those properties are shown by default when this flow action is displayed.

Requires pyAllowUpdateAction privilege for Work-

UrgencyUpdate Update the work item urgency. urgency
VerifyProperty Cause the system to start backward chaining to obtain the value of property pyResolutionCost. (To experiment with backward chaining, copy this rule and change the GoalProperty activity parameter to the property that applies in your situation.) backward chaining
VerifyPropertywithListing Similar to VerifyProperty, but can present the user with a listing of possible values to choose from for the missing property. backward chaining