Agents rule form
|
Field |
Description |
Scheduled Agents |
The order in which you specify agents does not create a sequence. Each agent activity runs individually on its own interval schedule, as a separate requestor thread. |
Agent Name |
5.4 Proj-911 Identify the name of the agent. Typically developers use the same name for the agent and the agent activity. Select a name that is unique within the list of agents in this agents rule. Click the arrow to expand the row and configure the agent activity. |
Pattern |
C-1183Select one of the following to specify the schedule type for the agent activity:
The value you enter in this section can be overridden in the generated agent schedule instances. For information about configuring the interval or schedule for this agents rule, see Pega Developer Network article PRKB-25048 How to set agent schedule intervals. |
Interval (secs) |
If the Pattern field is set to
C-1183 If the Pattern field is set
to Completing the Recurrence dialog box.1. Enter a time in the Start field. 2. Specify the time zone in the time zone field. Be sure to use the long designation rather than the three-letter acronym; for example, use "America/New_York" rather than EST. Otherwise you will need to edit the schedules twice a year to accommodate the change to and from Daylight Savings Time — for example, change EST to EDT in the spring, and then back to EST again in the fall. 3. Configure one of the options in the Pattern section. 3. Click OK to close the dialog box. The values you entered do not appear on the Schedule tab. The values you enter in the Recurrence dialog box can be overridden in the generated agent schedule instances. |
Queue Mode |
PROJ-911 5.4 Indicates whether the agent uses the agent queue capability ( introduced in V5.4) to process items from the agent queue. This feature allows the agent to temporarily skip over items that fail — for example, because a needed resource is locked — and try again later to process the item later.
As a preferred approach in new
development, choose |
Enabled? |
Select to indicate this agent is to run whenever the system is running. In most cases, select the checkbox. Clear the checkbox to disable the agent at system startup. Disabling agents at system startup is useful when debugging the agent, or to implement optional features. B-19204 This option defines the default behavior of this agent. You can override this checkbox value in the generated agent schedule instances. |
Class |
Click the icon at the left of a row to access additional fields for the row. Specify the Applies To key part of the agent activity. In most cases this is the class of the work objects that the agent is processing. |
Activity Name |
Specify the name of the activity that provides the processing for this agent (the agent activity). B-18390 |
Params |
5.4 Proj-911 Click to provide values for input parameters for the activity. |
Max Records |
PROJ-911 5.4 For agents of the This value is the maximum number of items to process. If Max Records is 30 and there are only 20 entries in the agent queue when the agent wakes, the agent processes the 20 entries and sleeps; it does not wait for an additional 10 entries. |
Auto Queue Management |
PROJ-911 5.4 For agents of the When this option cleared, the queue items for this agent do not persist. That is, when an agent attempts to process an item, that item is removed from the queue and the agent gets one chance to process it. If it fails, the item is not put back in the queue for another attempt. |
Field |
Description |
Agent-Wide Settings | C-1852 R-18663 5.1 REVISED |
Enable this agent |
Specifies whether the Agent Manager master agent is to generate agent schedule data instances (Data-Agent-Schedule class) for this rule when it checks for new agents rules. Agent schedules are not generated unless this option is selected. You can override this value in the generated agent schedule instances. |
Interval (seconds) |
Provides a default value for all agents listed in the rule
that are set to have a Pattern of
|