Back Forward How to complete and use the History tab of a rule form

  Show all 

Rule forms include a History tab with a uniform layout.

  Completing the History tab

Complete two fields:

Field

Description

Full Description

Optional. Enter text describing this rule instance. The data appears in a column in a list display.

NoteFor list view and summary view rules, this field may contain Reference directives or <pega:reference> JSP tags. The Full Description text becomes a V5 report title. See More about List View rules.

NoteFor class rules, this field may not be blank.

Usage

Optional. Enter text for later reference describing any special considerations, usage, or other facts about this instance.

The system maintains these fields automatically:

Field

Description

Full History  
Add

Read-only. System-maintained date, time, Operator ID and System ID of the user who created this rule.

Update

Read-only. System-maintained date, time, and Operator ID of the user who most recently saved this rule.

Move

Read-only. System-maintained date, time, and Operator ID of the user who most recently uploaded this rule into this Process Commander system's database, using the Import Archive facility.

NoteThe skim operation (> System > Tools > Refactor RuleSets> Skim a RuleSet ) BYRNB 2/26/10 records its use in the Add date and time field, not the Update date and time. If this rule was created through the Skim operation, the Update date and time can be earlier than the Add date and time. This is expected. B-21448 Rejected

  Using the History Details button

Click  History Details   to see the Save history of this rule in a new window. From the History window, you can

See Working with the rule History Details display.

  Adding custom fields

C-650Optionally, you can associate a set of names and values with a rule. These names and values can document development decisions or provide a means of locating the rules later. (Process architects and managers may alter the value of a previously entered name-value pair, but cannot add or delete Custom Field names.) B-13748 Rejected KHATV 04/20/05

Using this optional facility, you can associate an array of arbitrary Name and Value pairs with the rule. Later, using the Find by a Custom Field search (part of the Advanced Search tool), you can quickly locate all rules you or you colleagues have tagged with a specific field or value. B-16610 can't delete

You can also upload an entire file (for example, a Word document file, Visio VSD file, or a JPG image containing a diagram) as the value of a Custom Field. Process Commander links the uploaded file permanently with this rule.

NoteThe Custom Fields array is not visible the first time you open a rule. To access this array immediately after you create a new rule with New or Save As, close the rule form and then reopen the rule form.B-11017 Rejected

Custom Fields dialog box — Update or delete using the top portion

Click  Update   to add or change the Custom Fields associated with a rule. (This button appears only on rules you can update, and only on rules that are saved.)

A table in the top portion of the Custom Fields dialog box contains one row for each existing field. Columns identify the field name, field value, and type (Text or File):

Click  Apply   to complete the changes and close the Custom Fields dialog box.

Custom Fields dialog box — Add a new field using the lower portion

Use the lower part of the Custom Fields dialog box to add a new field to the system.

  1. Click  Add Field .
  2. Enter a Name for the field, or choose an existing name from the list below the Name field. Use only letters and digits in the Name.
  3. For a Text type, enter a Value for this field, or click the magnifying glass icon () to choose a value from those values previously applied to this field.
  4. For a File type, select File in the Type selection box. Select a radio button to indicate whether you want to upload a file from your workstation or LAN, or to select from files previously uploaded for this field name. In the upload case, use Windows facilities to navigate to the file, which may be of any file type.
  5. Click  Add .
  6. Click  Apply   to complete the changes and close the Custom Fields dialog box.
  7. Finally, click the Save toolbar button () to save the modified rule form.

Changing the display of Custom Fields

Advanced featureYou can modify the appearance of this area. See Pega Developer Network articlePDN PRKB-17693: How to allow developers to review or update Custom Fields.

Database table

By default, rule history instances (of the class History-Rule) are stored in the PegaRULES database as rows of the pr4_history_rule table.

Related topics History- base class

UpDesigner Studio basics