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 June 11, 2021

The application maintains different data entities and relationships to support the requirements functionality. The document metadata and requirements metadata are of significant importance and constitute the main pillars of the data model.

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, and so on.

The most relevant properties


The document metadata identifier that is unique for each instance

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


Type of document that must match the unique identifier of one of the documents defined in the system.

For example, Passport


The label that is given to the document during uploading 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 out of the box attachments table (Data-WorkAttach-File)



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

For example, Uploaded-Collected


The 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 following records are created during the requirement cases creation and updated as the cases progress up to completion.


Requirement metadata identifier that is unique for each instance

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


Requirement identifier 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


The identifier that determines the context in which the requirement is satisfied

In the case of CLM, the system uses the customer identifier of the contracting party.

For example, 123123123


The earliest date on which one of the documents expire or delete or becomes invalid (the date 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 that are used to support relationships between data entities and additional functionality.

PegaReq-Data- Metadata-CommentsSupportingUsed to record comments by users made on documents and requirements.
PegaReq-Data- Metadata-ReqDocLinkLinkUsed to keep a link between documents in document metadata table and the requirements where those documents are used.
Index-PegaReq- Data-PartyRef Index

Index on the document metadata table by customer identifier PartyRefs

Used to find the documents associated with a customer.

Index-PegaReq- Data-DocumentAttributesIndexUsed to expose the attributes of a document obtained during data capture.

Extension points

Few extension points are created to support organizations that add additional properties to these tables.

Rule nameRule typeUsage
RNGCreateDocumentMetadata_extData transform

Used to set any additional property that your organization might require.

The properties expected in this table 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 the chapter Requirements definition.

RNGCreateReqDocLink_extData transformUsed to set additional properties in the 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