Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Requirements definition

Updated on April 28, 2021

The definition of the documentary requirements is articulated through the three main data entities that are requirement sets, requirements, and documents.

Pega Client Lifecycle Management for Financial Services Implementation Guide Pega Client Lifecycle Management for Financial Services Implementation Guide Pega Client Lifecycle Management for Financial Services Implementation Guide

The maintenance of these three data entities can be performed from the following locations:

Requirements Portal
The portal allows users to maintain requirements set, requirements, and documents in a user-friendly manner. It is available by default for the standard CLM administrative access groups and can be added to other access groups as required (look for RequirementsPortal portal).
Dev Studio
Developers can manage the documentary requirements from Dev Studio by accessing the three data entities, all available under RecordsRequirements.

Users can configure most of their documentary requirements by using the forms available from these two points. However, some advanced capabilities should be enabled to take additional steps that are described in the following sections.

Configuring ruleset and base class for the portal

The Requirements Portal helps users to maintain the requirement sets, requirements, and documents.

The requirement sets and requirements are implemented in the system as rules that must be associated with a specific application, ruleset, ruleset version, and class. At run time, these values are determined by the configuration loaded through D_ReqConfiguration.

Use the available extension point LoadConfiguration_Ext to set the correct values.


Ruleset, where the new and updated rules are stored

For example, UPlusRequirements.


Ruleset version, where new and updated rules are stored

If you want to create or modify the rules, unblock the ruleset version.the ruleset.

For example, 01-01-01.


Name of the application that belongs to the ruleset

For example, uPlus.


The requirements application by default uses the PegaReq-Data-ReqVerify- class.

If you want to use a different class, set its class name in this property

Defining document extended attributes

The second stage in the processing of a requirement is data capture. In that stage, the user performs two basic operations. The first operation confirms that the collected document is in good order, and the second captures the date that the document might require according to its type.

The definition of the attributes required for each specific document type is done in two different places.

Expiration or stale date
During the definition of a document type, either from the Requirements Portal or from the Dev Studio, users can specify the expiration and stale date of the document that must be collected. When these options are selected, the data capture stage automatically ensures that the system captures the data as per configuration.
Extended attributes
The developer must configure any other attributes required for a given document type by completing the following steps.
  1. Create a new class under PegaReq-Data-DocLib to represent the document type. For example, if you need to create attributes for a Passport document type, create a class like PegaReq-Data-DocLib-DocPassport.
  2. Define the attributes as properties under the new class or directly on the PegaReq-Data-DocLib class, which lets you later reuse properties across different document types.
  3. Create under the new class a section with the DocumentAttributesView name. This section should contain the properties that you created and embedded in the data-capture stage for documents of this type.
  4. Create under the new class a data transform with the SetDocAttributeRelevance name. Take the base version available at PegaReq-Data-DocLib as a reference.
  5. Modify SetDocAttributeRelevance to add one entry per required attribute to the DocumentPage.DocRelevanceAttributeList list. For example, if you need to capture for your Passport the nationality and the passport number, create in this data transform two entries in the DocRelevanceAttributeList.
  6. Run the SaveAttributestoDocument activity to register the configuration that is created in the document definition. Provide the following two parameters:
    • DocId - Document ID (for example, Passport)
    • DocumentClass - Document Class (for example, PegaReq-Data-DocLib-DocPassport)

After completing the changes, the new section appears in the data-capture stage for the documents of the selected type. The defined attributes are captured through that section and automatically stored along with the document. The information is stored in two different places:

Document metadata table
Attributes are stored for later use in the BLOB of the entry for the document in the document metadata table.
Attributes index
The attributes are also made available through a declare-index on the document metadata table. The index populates a database table that financial institutions can use to find documents using their attributes.

The activity opens the definition of the document identified by DocId and invoke SetDocAttributeRelevance to register the attributes.

While the persistence of attributes in the document metadata table is essential for the good behavior of the functionality, the attributes indexes are not currently in use. If your organization is not planning to implement any functionality based on this table, it can be disabled and, that way, reduce the overall database footprint. The following when rules can be used to disable the functionality.

Rule nameRule typeUsage



WhenSet the when rules to false to disable the declare-index and avoid the generation of entries in the attributes index table.

If, on the contrary, you want to use the index of the attribute, but you also would like to make changes in the way the index is generated, you can make some adjustments.

Rule nameRule typeUsage


Data transformExtension point for consuming applications to define application-specific logic to extract Name value pairs from DocAttributePage and populate Attribute list, which is used for indexing attributes

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us