Skip to main content

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

Data entities and tables

Updated on February 16, 2021

The application maintains different data entities and relationships to support the requirements functionality. There are two of them that are of significant importance as they constitute the main pillars of the data model: document metadata and requirements metadata.

The following sections describe those tables, as well as briefly enumerate those built to complete the functionality.

Document metadata table

Every document is represented in the system by an entry in the document metadata table (PegaReq-Data-Metadata-Document). The table contains information about the document type, associated parties, attributes, etc. These are some of the most relevant properties available.


Document meta data id (unique for each instance).

For example, 52d4c5de-e2d6-41fb-ab15-b8d50ed975b3


Type of document. It should match the unique identifier of one of the documents defined in the system.

For example, Passport


Label given to the document when uploading it into the system

For example, My Passport


List of customer identifiers of associated related parties. In this initial version of the functionality, only one party is maintained.

For example, 65657656


pzInsKey of the document in the OOTB attachments table (Data-WorkAttach-File)



Status of the document in the system: Uploaded, Uploaded-Collected, Uploaded-Rejected.

For example, Uploaded-Collected


Date on which the document becomes stale

For example, Dec 31st 2020

Requirements metadata table

Every satisfied requirement in the system is recorded in the requirement metadata table (PegaReq-Data-Metadata-Requirement). The records in this table are created at the time of the requirement cases creation and updated as the cases progress up to completion.

These are some of the most relevant properties:


Requirement meta data id (unique for each instance).

For example, 52d4c5de-e2d6-41fb-ab15-b8d50ed975b3


Requirement ID as defined in the design time

For example, ProofOfAddress


Requirement Name as defined in the design time

For example, Proof of Address


Requirement case pyID

For example, REQ-123


Requirement case pzInsKey

For example, PEGAFS-WORK R-85707


Status of the requirement: New, InProgress, Resolved-Completed

For example, Resolved-Completed


Name of the scenario active at the time of resolution

For example, Default


Identifier that determines the context in which the requirement was satisfied. In the case of CLM, the system uses the customer identifier of the contracting party.

For example, 123123123


Earliest date on which one of the documents expire or delete or becomes invalid. This is for the document, not the requirement SLA.

For example, Dec 31st 2020

Relationships and supporting tables

In addition to the main two metadata tables, there are some additional tables used to support relationships between data entities and additional functionality.

PegaReq-Data- Metadata-Comments SupportingRecord comments by users made on documents and requirements.
LinkTable that keeps a link between documents in document metadata table and the requirements where those documents have been used.
IndexIndex on the document metadata table by customer identifier (PartyRefs). Used to find the documents associated to a customer.
IndexIndex used to expose the attributes of a document obtained during data capture.

Extension points

There are few extension points that are created to support organizations that added additional properties to these tables.

Rule nameRule typeUsage
RNGCreateDocumentMetadata_extData transformUse this rule to set any additional property that might be required by your organization. the properties expected in this table are those that describe the document and somehow drive the lifecycle and processing of the documents. To extend the properties captured for a document, see Defining document extended attributes in chapter Requirements definition.
RNGCreateReqDocLink_extData transformUse this rule to set additional properties in requirement document link table

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