You are here: Reference > Standard rules > Flow Action rules > Standard flow actions (connector)

Atlas — Standard Flow Actions
Connector and Connector/Local

About Flow Actions

The Pega 7 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.

The table below lists important standard flow actions that can complete an assignment, known as connector flow actions, and those that can be either connector or local flow actions. A Y in the Use column indicates that this flow action can be used in both Local and Connector situations. See also Standard Flow Actions (Local).

Use this table only as a starting point 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.

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.

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

A

Flow Action (pyAction)

Use

Purpose

More...

ActionStub Y

Placeholder action with no input requirements.

 
Approve Y

Enter a note, record the user's approval of some previous assignment or question.

 
Assign Y

Send the assignment to another operator, by selecting first a work group and then the operator within that work group.

work group
AttachandHold Y

Generate and attach Word correspondence.

About Word Template rules

C

     
CancelAssignment C

Complete the current assignment and display the Confirmation harness.

 
ChangeClass Y

Change the work type (class) of the work item to a different type in the same work pool, re-editing property values as required. This can be used to correct an incorrect work type. For example, a work item initially recorded with a SuspendDelivery work type may actually be a CancelSubscription work type.

work type
Classify N

Change the work type of the current work item to another work type in the current application (work pool) by selecting that work type from a selection box. For example, a work item initially entered as an Unclassified work type may, after more information becomes available, be classified as a Renewal work type.

work type
ConvertAttachment
toPDF
Y

Converts an existing work item attachment that has a DOC file type, created by Microsoft Word, into a new work item attachment with a PDF file type.

Select the attachment category containing the DOC file to start the conversion. The newest file attachment in that category is selected. Conversion may take several seconds.

Conversion occurs on the user's Windows workstation using a Windows print driver from Amyuni Technologies. This driver is installed upon first use of this feature; it remains installed but is not available to other workstation applications. This feature requires the open authoring ActiveX control prOpenAuthoring, and may require limited administrative privileges for the download/installation. For more information, see Working with PDF Forms and Documents, a PDF file available in the Integration area of the PDN.

Alternatively, your system can use PegaDISTRIBUTION Manager 3.3.5 and the standard Utility activity named Work-ConvertAttachmentToPDF to perform this conversion offline.

 
CorrPrompt Y

Prompt for correspondence fields.

 
CorrVerify N

Verify previously created but unsent correspondence.

 

E to H

     
EditCategorized
Attachment
Y

Create a version of a Microsoft Word file attachment that has an attachment category.

attachment category
EngageExternal Y

Start a new flow on this work item that creates an assignment to an external party.

How to provide external assignments through directed Web access
EngageManager Y

Initiate a new flow on a work object that creates an assignment to the manager of the assignee.

 
EngageStaffmember Y

Initiate a new flow execution on work item that creates an assignment for another user.

 
EnterInformation Y

Allows the user to enter a note.

 
EnterInformation
External
Y

Similar to EnterInformation, but allows an external user to enter a note.

directed Web Access
Finish N

Save a work item without validation; the validate activity is not called.

 
GetAppointmentList Y

Allows users to query the Microsoft Outlook calendars of other operators. Typically you use GetAppointmentList and SendMeetingRequest (see below) together. The operators would use GetAppointmentList first to determine whether another operator is available at a specific time and then use SendMeetingRequest to make the appointment.

Users must have Outlook installed on their workstations and there's a one-time setup step. The first time a user selects either GetAppointmentList or SendMeetingRequest, Pega 7 Platform uses an ActiveX control (PegaOutlookAddInCaller) to register with Outlook. The user must then restart Outlook. See PDN article Integrating with Outlook calendars.

 
@baseclass.
GoBack
C

Submits the form immediately, without requiring any user inputs or confirmation. By default, not eligible for bulk processing.

 

I to R

     
Notify Y

Generate correspondence (notifications) to a party in a work item, allowing the user to select a correspondence rule from a list that includes only those compatible with the party's contact preferences.

contact preferences
NotifyExternal N

Generate correspondence (notifications) to a party external to Process Commander.

 
NotifyQuick Y

Initiate correspondence (notifications) using a standard, quick form for rapid text entry. Can be sent to a party involved in the work item, or to any email address.

 
PickLanguage Y

Select a language for the work object.

 
PortletAction Final Y

A template rule for flow actions for portlets, configured to generate portlet-compliant HTML.

template rule
Previous  

Jump to the most recent task completed earlier in the flow execution that is marked as an entry point.

entry point
PreviousOperator S  

Return to the most recently completed assignment, and restore that assignment to the worklist of the operator who last updated the work item, regardless of whether the assignment was originally on a worklist or in a workbasket.

 
Reject N

Reject this work item from further consideration, resolving it with a status of Resolved-Rejected.

resolution
RemoveSLA N

Ends execution of the OverallSLA flow. Not useful in other flows.

Automatically setting case-wide goals and deadlines
Resolve N

Complete the current assignment, resolving work item with a status of Resolved-Completed.

resolution
ResolveAsDuplicate N

Complete the current assignment, and resolve the work item with a status of Resolved-Duplicate.

duplicate
ResponseVerified N

Affirm that the previous response to an information request is satisfied.

 
RetryProblemFlow Final N

Retry the last step of a now-fixed flow error.

flow error

S to Z

     
SampleEmailToCustomer Y

Sample email message.

 
SearchForDuplicates  

Search for potential duplicates. Users can review the search results to mark any that are truly duplicates. If appropriate, set a ticket to resolve this current work item as a duplicate.

duplicate
SelectCorrTemplate Y

Select a correspondence rule to be used.

correspondence
SelectCorrType Y

Select a correspondence type, such as email.

correspondence type
SendMeetingRequest Y

Allows users to send Microsoft Outlook meeting requests to other operators. Typically you use GetAppointmentList and SendMeetingRequest (see below) together. The operators would use GetAppointmentList first to determine whether another operator is available at a specific time and then use SendMeetingRequest to make the appointment

Users must have Outlook installed on their workstations and there's a one-time setup step. The first time a user selects either GetAppointmentList or SendMeetingRequest, PRPC uses an ActiveX control (PegaOutlookAddInCaller) to register with Outlook. The user must then restart Outlook. See PDN article Integrating with Outlook calendars.

 
SetTicket Y

Turn on ("raise") a ticket for this object with an explanatory note.

ticket
StandardTemplate Y

Empty flow action, used as a template rule.

template rule
TakeOwnership Y

Change ownership of the work item to the user's organization, division, and unit.

 
TransferTo
Workbasket
Y

Transfer this assignment into a workbasket.

workbasket
Verify N

Record an affirmation by this user that prior work on this work item is correct.

verify
Withdraw Y

Set (turn on) a ticket on the work object causing the system to resolve it as withdrawn, including a reason for the withdrawal.

ticket

UpAbout Flow Actions
UpAtlas home