You are here: Reference > Standard rules > Activity rules > Activity rules - for flows

Standard activities for use in flows (interactive)

The Pega Platform includes hundreds of standard activities. Of these, several dozen are likely to be directly referenced in your application. Below are selected standard activities that you can reference in flows that use harnesses for user input and display.

For an activity in the Work- class or a class derived from Work-, the Activity Type field (on the Security tab) of an activity determines whether it can be used in a flow shape. A value of Utility, Rule Connect, Assign, Notify, or Route indicates that the activity can be referenced directly in a flow task of the corresponding type.

See Standard activities of type Activity for other important standard activities.

Assignment activities

These standard Work- activities have an Activity Type of Assign. They can be used in the Assignment task, represented by the Assignment shape Utility .

Name

Purpose

ExternalFinal

Creates an external assignment, an instance of the Assign-External class (or a subclass of this class), part of the Directed Web Access facility.

WorkListFinal

Creates a normal assignment (Assign-Worklist class) added to a user's worklist.

WorkBasketFinal

Creates a normal assignment (Assign-Workbasket class) added to a workbasket. If the workbasket doesn't exist, the assignment can be routed to the current user.

At runtime, if the DoNotPerform parameter is checked for WorkList or WorkBasket in the Assignment Properties panel, the activity will not overwrite the newAssignPage page, allowing a pre-existing page to be performed instead. This option is useful for performing an assignment on a spun-off work item.

Integrator activities

Integrator task activities have an Activity Type of Rule Connect. They can be used in the Integrator task, represented by the Integrator shape Integrator .

Because these tasks involve external systems, no standard rules have this type.

Notify activities

These standard Work- activities have an Activity Type of Notify. You can reference a notify activity in the Properties panel for an assignment shape.

Name

Purpose

Notify Final Send an email message as correspondence to a party identified through a parameter.
NotifyAll Final

Send a single email message to each work party identified in the work item.

NotifyAssignee

Send an email message to the Pega Platform user who received the assignment. If the assignment is in a workbasket rather than a worklist, an email message goes to the first operator listed in the Contacts array of the Workbasket tab.

NotifyAllAssignees

Send an email message to the Pega Platform user who received the assignment. If the assignment is in a workbasket rather than a worklist, an email message is sent to each operator listed in the Contacts array.

NotifyPartyFinal Send an email message as correspondence to a party identified through a parameter, but only send when a threshold urgency level is reached or exceeded.

Route activities

These standard Work- activities have an Activity Type of Route. Each uses information in an Operator ID data instance to send the assignment to a substitute operator if the assignment is to be completed during a period when the first operator selected is unavailable.

You can identify a router activity in the Properties panel for the Assignment shape.

Name

Purpose

SampleToSkilledGroupList Demonstrates a simple use of the standard getAvailableSkilledOperatorsList() function See Intelligent routing.
ToAgentWorkbasket

Routes the assignment into a workbasket (that is accessed and processed by an agent).

ToAssignedOperator

Routes the assignment to the worklist of the operator identified in the pyAssignedOperator property, after checking that operator's availability.

ToCorrPartyRole

Route the assignment to a party referenced in correspondence, found on the pyCorrPage page.

ToCorrWorkGroupManager

Routes the assignment to the worklist of the first operator found through a sequence of tests:

  1. If a correspondence page named pyCorrPage is present on the clipboard, choose the operator who created the correspondence.
  2. If an assignment page named newAssignPage is present, choose the operator identified in the pyAssignedOperatorID property on that page.
  3. If the activity parameter identifies a workbasket, choose the manager of the work group to which that workbasket belongs.
  4. If there is a current operator (the work item is not being processed by an agent), choose the manager of the work group of that operator.
  5. In all cases, check operator availability and use the substitute if the selected operator is not available.
ToCostCenterManager

Routes the assignment to the worklist of the Cost Center manager (not the manager) of a user's organization unit.

ToCreateOperator

Route the assignment to the user who entered the work item.

ToCurrentOperator

Routes the assignment to the worklist of the user who is accessing the work item (property pxRequestor.pyUserIdentifier), or the substitute, after checking that operator's availability.

ToCustomer

Route to a work party who is identified as a customer (work party role equal to Customer). This routing can support Directed Web access.

ToDecisionMap

Route to the result of a map value.

ToDecisionTree

Route to the result of a decision tree.

ToDeferredWorkbasket

Uses a map value RoutingRoles to identify a workbasket for current operator's organization that serves to hold deferred work items. Conventionally, that workbasket is named Deferred@org.com.

ToDefaultWorkbasket

Routes the assignment to the default workbasket of the work group that this user belongs to. This is not necessarily a workbasket with "default" as part of the workbasket name.

ToLeveledGroup

Supports load balancing within a work group. Finds operators in the work group who hold the required skills and are available. From those, chooses the operator who has the least urgent work. Routes to the manager of the work group if the first list is empty.

This skills-based routing rule examines the skills of each operator in a work group to find a match. To reduce processing demand, avoid this approach in situations where work groups may contain hundreds of operators.

ToNewWorkParty

Routes to a designated party already present in the work object, or to an operator identified in a parameter if the designated party is not present. Adds the operator as a work party of type Data-Party-Person.

ToOrgUnitManager

Routes the assignment to the worklist of the manager of a user's organization unit.

ToOverallSLA

Routes the assignment to the workbasket named default@zzzz.yyy, where zzzz.yyy identifies the name of the organization that this user belongs to.

ToQAWorkbasket

Uses a map value named RoutingRoles to identify a workbasket that serves the current operator's organization to hold work items for quality assurance testing. Conventionally, that workbasket is named QA@org.com.

ToPolicyOverride

Supports policy overrides, by routing an assignment to the administrator of the current organization. Override to designate other operators as reviewers.

ToProblemFlowOperator

Routes the assignment to an available operator who is designated to respond to flow errors. See flow error.

ToSkilledGroup

Routes to a randomly selected operator within a specific work group who: (1) is scheduled to be available between the time the assignment starts and is due and (2) has the minimum skill proficiencies to complete the assignment.

This skills-based routing rule examines the skills of each operator in a work group to find a match. To reduce processing demand, avoid this approach in situations where work groups may contain hundreds of operators.

ToSupportBasket

Uses a map value named RoutingRoles to identify a workbasket that serves the current operator's organization to hold work items relating to support. Conventionally, that workbasket is named Support@org.com.

ToSupportLead

Uses a map value named RoutingRoles to identify an operator in the current operator's organization who is designated as a lead support person.

ToWorkbasket

Routes the assignment to a workbasket identified in a parameter.

ToWorkGroupManager

Routes the assignment to the worklist of the manager of the work group that this user belongs to.

ToWorklist

Routes the assignment to the worklist of a specific user, identified in a parameter.

ToWorkParty

Routes the assignment to the worklist of a work party in the work item (if that operator is available), identified through a parameter.

Utility activities

These standard Work- activities have an Activity Type of Utility. The pyTaskStatus property is the output result of these activities.

Reference these activities in a Utility shape Utility .

Name

Purpose

AddHistory

Add a history instance to the history of a work item, depending on the value of a system setting rule named FilterHistory and a similar decision tree named FilterHistory. See History-Add method.

AddNotetoHistory

Adds a history instance with memo text from the value of the pyNote property.

AddToFolder

Adds the current work item to an existing folder, creating a Link-Folder object and updating the work item history to record this addition.

CheckIfNew

Test whether a work item has an ID assigned.

CorrAttachFinal

Supports CorrUpdate. Links the correspondence item on the page named pyCorrPage as an attachment to the work item.

CorrCheckForError

Checks for messages on the pyCorrPage page.

CorrCreateFinal

Intermediate activity. Retrieves the correspondence rule. Determines the party's contact preference and address, based on a party role. Called by CorrNew. Calls CorrUpdate.

CorrFail Final

May record in work item history that a correspondence operation has failed.

CorrNew Final

Send correspondence (that requires no user interaction), and save it as an attachment to the work item. For email output, can send all work item attachments or selected work item attachments as email attachments. The optional Priority parameter allows the outgoing mail to be marked as high or low priority in certain email client programs, such as Microsoft Outlook.

CorrQuickStartFinal

Supports the SendCorrespondence standard flow, alternative to CorrNew for correspondence requiring verification.

CorrSend Final

Places the correspondence item (on page pyCorrPage) into a queue to be sent out by an agent, or sends it out immediately, depending on a parameter.

CorrVerifyFinal

Examines the correspondence rule to determine whether verification is required; if required, sets the pyTaskStatus property in the work item to the value VerificationRequired.

DuplicateSearch

Search for other work items that might be duplicates of this work item.

FindFulfillBasket
Final

Supports the standard example flow Work-.StandardRequest. Uses a map value RoutingRoles to identify a workbasket for fulfillment.

GenerateID

Computes a work item ID for a new work item.

ProblemFlowThrowException

See flow error.

RandomSelection

Sets the pyTaskStatus to one of two text values (RandomSelected and RandomNotSelected) randomly, based on a percentage value 0 to 100 you input as a parameter. This allows a portion of work items to be routed to specific groups, or for quality control sampling.

ResolveFinal

Updates various properties needed for reporting, when a work item becomes resolved.

UpdateStatus

Changes the status of a work item (not the status of an assignment), and adds a record of this change to the history of the work item.

About Activity rules
Standard rules index