Security tab on the Activity form
Use the Security tab to specify the activity type and optionally to restrict which users (or other requestors) can execute the activity. This optional security supplants restrictions based on RuleSet and version.
You can specify zero, one, or more than one privilege to restrict access. Order is not significant. At runtime, any match between a privilege listed and those a user possesses allows users to execute this rule.
| Field | Description | ||||||||||||
| Restrict Access | |||||||||||||
| Allow direct invocation from the client or a service |
Select to allow users to start this activity directly through user input processing, for example through a Submit button or a
pyActivity=
element in an URL. Clear this if this activity is to be started only from another activity, through a Call, Branch, or other means.
For example, select the box for a service activity, or if this activity is called by an AJAX event from a form.
At run time, if the box is not selected and a user attempts to start this activity by user input, the activity does not run and returns a method status of
For most activities, leave this box cleared to promote security of your application. Unless needed by your design, allowing activities to be started from a URL or other user input — whether the requestor is authenticated or a guest — may let users bypass important checking, security, or setup. | ||||||||||||
| Require authentication to run |
Select to require that only authenticated requestors can start this activity.
Clear to allow guest users to run this activity, if they meet other security and access criteria. Guest users — unauthenticated requestors — typically have access to rules in the RuleSets provided in the PRPC:Unauthenticated access group, as referenced in the Requestor type instance named pega.BROWSER. In most cases, clear this check box if the activity is for an agent. Agents are not true authenticated users and by default cannot run activities that are restricted to authenticated users. However, this check box is ignored by agents for which the Bypass activity authentication check box (on the Security tab is checked; they can run activities regardless of the Authenticate? value. Identify privileges in this array to restrict which users and other requestors can execute this activity. At runtime, if the user does not possess an access role that — through an Access of Role to Object rule — provides access to one of the identified privileges, the execution of the activity fails. | ||||||||||||
| Privilege Class | Optional. Identify the Applies To key part of a class to use at runtime to locate a privilege rule. Normally this is the same as the Applies To key part of this activity. | ||||||||||||
| Privilege Name | Optional. Identify the name for a privilege in that class (or an ancestor class). The class you enter and the name must together identify a privilege (using rule resolution including class inheritance.) | ||||||||||||
| Usage | |||||||||||||
| Activity Type |
Determine whether and how this activity can be referenced in other rules. For an activity that is not to be referenced in a flow, choose one of these values:
|
Select
Notify,
Rule Connect,
Assign,
Route, or
Utility
if the class of the activity inherits from the Work- base class and you designed and implemented the activity to be referenced in a flow shape. See
How to create activities for use in flows
for more details on these choices:
Choose
Notify
for a notification activity. For example, a notify activity can send an email message to someone conveying news of the assignment.
|
Choose
Assign
for an assignment activity, one that creates an assignment.
|
Choose
Route
for a router activity, one that determines which user worklist or work queue is to receive an assignment.
|
Choose
Utility
for a utility activity, one that automates processing without user interaction.
|
Choose
Rule Connect
for an activity that operates without user interaction and calls a connector rule to interface with an external system.
|
Do not choose
Validate
or
Assembler
for this field.
Previous topic Best practices for writing activities for background jobs Next topic Defining the local variables for an activity