50.pega Government Platform '24 1 2024-07-20-17-54-02
50.pega Government Platform '24 1 2024-07-20-17-54-02
'24.1
20 July 2024
CONTENTS
Get started___________________________________________________________________________ 10
Release notes________________________________________________________________________ 11
Constellation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Traditional application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Issues addressed (Traditional application). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Known issues (Traditional application). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Known issues (Constellation). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Deprecated and withdrawn rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Deprecated rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Withdrawn rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Product overview____________________________________________________________________ 58
Product overview for Theme Cosmos. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Application intake features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Manage information features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Case reviewer features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Association management framework. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Entity profile views. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Investigative case management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Pega Government Platform case types and workflows. . . . . . . . . . . . . . . . . . . 80
Roles and portals. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Primary data entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Time management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Further reading. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Product overview for Constellation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Person. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Business. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Business components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Subject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Interview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Interview template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Evidence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Association management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Government journeys. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Incident. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Investigative Case Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Roles and portals. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Install________________________________________________________________________________ 151
Installation guide for Traditional application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Completing the prerequisite tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Backing up your system. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Installing the application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Importing common application file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Importing common government application file. . . . . . . . . . . . . . . . . . . . . . 154
Importing Pega Government Platform application file. . . . . . . . . . . . . . . . . 154
Creating a system administrator operator. . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Creating operator accounts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Updating event listeners. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Optional: Importing the sample data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Optional: Enabling sample operator accounts. . . . . . . . . . . . . . . . . . . . . . . . 159
Optional: Installing sample application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Installation guide for Constellation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Completing the prerequisite tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Backing up your system. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Installing the application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Importing common application file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Importing common government application file. . . . . . . . . . . . . . . . . . . . . . 163
Importing Pega Government Platform application file. . . . . . . . . . . . . . . . . 164
Creating a system administrator operator. . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Configuring OAuth 2.0 and setting the application URI. . . . . . . . . . . . . . . . . 166
Elasticsearch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Performance mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Event life cycle changes in Pega Government Platform. . . . . . . . . . . . . . . . . . 190
IACAuthentication service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
IACAuthentication activity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Changes to entity search data pages in Pega Government Platform. . . . . . . 191
Updating case edit actions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Changes to Registration.js. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Changes to Unique ID generation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Queue processor for sending emails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Security policies for password validation in user registration. . . . . . . . . . . . . 195
History and Field audit for entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Skip entity persistence in entity flows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
New declare indexes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Changes to VIS.JS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Activity plan life cycle changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Backward compatibility for Program configuration. . . . . . . . . . . . . . . . . . . . . 198
Time management lifecycle changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Moving countries and states. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Implement__________________________________________________________________________ 200
Implementation guide for Theme Cosmos. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Preparing for implementation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Creating a new application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Setting application utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Configuring your application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Updating dynamic class referencing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Integrating with third-party apps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Connecting system of record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Person entity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Add Person case type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Evidence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
Investigative Case Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546
Associations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
Managing reference data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561
Integrating PGP with CS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
Hotfixes______________________________________________________________________________ 568
Hotfixes for 8.x. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
Hotfixes for 7.x. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
Resources____________________________________________________________________________ 585
Pega Certification and Licensing for Government hotfixes. . . . . . . . . . . . . . . . . 585
Hotfixes for Pega Certification and Licensing for Government 8.x. . . . . . . . . 585
Hotfixes for Pega Certification and Licensing for Government 7.x. . . . . . . . . 587
Release notes
• Release notes
Product overview
Setup
Implement
Release notes
Pega Government Platform (PGP) release 24.1 provides a new constellation offering,
enabling customers to build their government solutions in constellation by using PGP
assets. Additionally, PGP 24.1 offers an upgraded PGP Theme cosmos and UI kit,
incorporating the latest Pega platform capabilities.
PGP 24.1 constellation offering provides the Pega Common Data Model with
specializations tailored to government requirements and includes entity management
of person and business for accelerated implementations. It also offers pre-built
functional business components, for example, interviews and evidences, for plug-and-
play solutions development, association and relationship management for managing
connections between entities and cases, and an Investigative Case Management (ICM)
solution template catering to various investigation domains such as fraud, criminal
investigation, regulatory practice, and child welfare.
PGP offers all its features in highly reusable, configuration-friendly, and assembly-ready
patterns.
Pega Government Platform 24.1 brings in enhanced accessibility and user experience
based Pega Platform 24.1 offerings.
For more information and a list of additional documents available for this release, see
the Pega Government Platform product page.
Entity management
The Pega Government Platform (PGP) Constellation provides prebuilt processes for
managing people and business entities, which can accelerate implementations. The
platform includes entity management, which offers data models and capabilities for
capturing all relevant details of a person, business, or branch. It also includes potential
duplicate checks, persistence mechanisms, and a 360-degree view of business and
person entities. This streamlines the process of managing entity data across various
use cases.
Person
Person entity feature in PGP Constellation enables users to easily capture, view, and
edit individual details in various use cases, such as associating victims, suspects, and
witnesses in investigations, managing customer information, and creating profiles for
tax filing. The feature includes reusable assets like capture person, view person, edit
person, and a search and select landing page, streamlining the process of managing
individual data across multiple applications.
Business
Business entity feature in PGP Constellation enables users to capture, view, and edit
business details in various use cases, such as associating businesses with cases,
managing licenses, and handling vendor information. The feature includes reusable
assets like capture business, view business, edit business, add branch, and a landing
page, streamlining the process of managing business data across multiple applications
and accelerating implementation.
Business components
The Pega Government Platform (PGP) Constellation offers pre-built functional business
components to accelerate solution development. These configurable modular
functional blocks can be introduced in any case type, streamlining various processes.
Incident
Subject
The subject case feature in PGP Constellation enables in managing subject data
efficiently in diverse use cases. Users can create subjects of type Person and Business,
associate them with microjourneys like Investigation, and capture, view, and edit details
of various entities and items. The 360-degree UI allows for effortless creation, editing,
and association of subjects with investigations, streamlining case management and
data handling processes.
Interview
The interview case type in PGP Constellation enables streamlining the process of
preparing, conducting, and managing interviews in various use cases, such as
investigation cases and recruitment management. The feature includes reusable assets
like interview case type, interview question landing page, interview question set
(template) landing page, interview list view tab, and interview detail view. Users can
create interviews, assign interviewers with suggested questions, and review notes on
conducted interviews, enhancing the overall interview management process.
Evidence
The Pega Government Platform (PGP) features an Investigative Case Management (ICM)
solution template, designed to manage a wide array of investigation types across
various domains, such as fraud, criminal investigation, regulatory practice, and child
welfare. This comprehensive and adaptable template leverages PGP's models and
components to cater to diverse investigative needs.
ICM offers an all-in-one solution for incident intake, interview conduct, evidence
collection, subject management, case and entity association management, and 360-
degree investigation views. Additionally, ICM provides audit trails, case management,
and collaboration among investigation teams, streamlining the investigative process for
organizations.
Association management
The Pega Government Platform (PGP) Constellation offers an improved Association and
Relationship Management framework, enabling users to manage associations among
different entities and cases during government business processes. The reusable
framework supports entity-to-entity, entity-to-case, and case-to-case relationships.
While visualization is not included in the 24.1 release, the framework is designed to
accommodate future visualization capabilities with level indicators for association
depth.
For each issue, a reference number is provided, and the prefix of the reference number
indicates the issue type. You can use the reference number of an issue in your related
conversations with Pega Support.
INCs
Customer-reported incidents. For example, INC-183895.
SRs
Support requests, which were used instead of incidents in older releases. For
example, SR-D79601.
ISSUEs
Pega-identified issues. They might or might not be related to customer-reported
incidents. For example, ISSUE 654263 (which might also be written as just 654263).
SEs
Sustenance engineering activities. For example, SE-60265.
Starting Q2 2021, all customer-reported issues are logged as INCs. You can view INCs
that you logged in the My Support Portal. INCs logged by other Pega customers, and all
other issue types (SR, ISSUE, and SE), are available in Pega internal tracking systems, in
addition to these release notes.
Pega Government Platform release 24.1 has no fixed issues for this release.
Tip: You can look up Pega Platform resolved issues in the Pega Platform
Resolved Issues.
For example:
Note: To submit new issues or find out more about known issues, or to request
a hotfix, go to the Pega Product Support Community. Look up or subscribe to
your Support Requests (SRs) in My Support Portal. Make sure that you refer to
the issue ID (SR, BUG, or FDBK) in all communications.
Note: To submit new issues or find out more about known issues, or to
request a hotfix, go to the Pega Product Support Community. Look up or
subscribe to your Support Requests (SRs) in My Support Portal. Make sure that
you refer to the issue ID (SR, BUG, or FDBK) in all communications.
BUG - 853769 Localization - Email subject and The fix is anticipated in 24.2
contents are not localized. from platform.
BUG - 858411 Upon case submission, the session The fix is anticipated in
becomes unresponsive. Due to this patch release 24.1.1 from
issue, we cannot create Incident and platform.
Investigation cases.
BUG - 852951 Localization - Picklist sourcing from The fix is anticipated in 24.2
prompt values are not localized. from platform.
BUG - 853673 Localization - "JSON has not been Resaving of view and
synced" console error. localization rules.
The following table lists the count of deprecated and withdrawn rules for every release
in Pega Government Platform.
'24.1 0 0
'23 70 28
8.8 2 4
8.7 7 67
8.6 4 48
8.5 35 165
8.4 0 31
8.3 13 37
8.2 5 34
8.1 3 2
• Deprecated rules
• Withdrawn rules
Deprecated rules
This page lists the list of deprecated rules of Pega Government Platform for 8.x
releases.
The following table lists the deprecated rules of Pega Government Platform for '23
release.
The following table lists the deprecated rules of Pega Government Platform for 8.8
release.
The following table lists the deprecated rules of Pega Government Platform for 8.7
release.
The following table lists the deprecated rules of Pega Government Platform for 8.6
release.
The following table lists the deprecated rules of Pega Government Platform for 8.5
release.
The following table lists the deprecated rules of Pega Government Platform for 8.3
release.
The following table lists the deprecated rules of Pega Government Platform for 8.2
release.
The following table lists the deprecated rules of Pega Government Platform for 8.1
release.
Withdrawn rules
This page lists the list of withdrawn rules of Pega Government Platform for 8.x releases.
The following table lists the withdrawn rules of Pega Government Platform for '23
release.
The following table lists the withdrawn rules of Pega Government Platform for 8.8
release.
The following table lists the withdrawn rules of Pega Government Platform for 8.7
release.
The following table lists the withdrawn rules of Pega Government Platform for 8.6
release.
The following table lists the withdrawn rules of Pega Government Platform for 8.5
release.
The following table lists the withdrawn rules of Pega Government Platform for 8.4
release.
The following table lists the withdrawn rules of Pega Government Platform for 8.3
release.
The following table lists the withdrawn rules of Pega Government Platform for 8.2
release.
The following table lists the withdrawn rules of Pega Government Platform for 8.1
release.
The following sections describe key functional areas and features of the application that
you can use as-is or extend to meet your business needs.
• Time management
• Further reading
A process that captures basic person information, validates it, and checks for the
presence of duplicate information.
A process that captures detailed person information like ethnicity, race, communication
preferences, and so on, validates it, and checks for the presence of duplicate
information.
Business information
A process that captures business information like legal name, trade name, office
location, communication details, and so on, validates it, and checks for the presence of
duplicate information.
Facility information
A process that captures facility information like facility name, contact details, location,
and so on, validates it, and checks for the presence of duplicate information.
Vehicle information
A process that captures vehicle information like model, make, registration number,
garage location, owner details, and so on, validates it, and checks for the presence of
duplicate information.
Household information
A process that captures household information like household name, type, description,
location, members of the household, and so on.
A generic component that saves entity related information and data object information
in the system of record.
Capture experience
Capture training
Capture location
Consent agreement
a check box to signify agreement, and a field to provide a signature. Pega Government
Platform extends Pega App Studio to provide additional business configuration
capabilities for the consent agreement.
Item Information
A process that captures basic person information, validates it, and checks for the
presence of duplicate information.
Manage education
A process that manages the education details of a person and stores those details in
the system of record.
Manage experience
A process that manages the experience details of a person and stores the details in the
system of record.
Manage training
A process that manages the training details of a person and stores the details in the
system of record.
Manage location
A process that manages the location details of an entity and stores the details in the
system of record.
Manage facility
A process that manages the facility entity details and stores the details in the system of
record.
Manage vehicle
A process that manages the vehicle entity details and stores the details in the system of
record.
Manage household
A process that manages the household entity details and stores the details in the
system of record.
A process that manages the members of household entity. When you add a new
member or remove an existing member from a household, a new household is created,
and the existing household becomes inactive.
Manage item
A process that manages the item details and stores the details in the system of record.
A process that manages the item basic details and stores the details in the system of
record.
Manage business
A process that manages the business details and stores the details in the system of
record.
A process that manages the person basic details and stores the details in the system of
record.
A process that manages the person details and stores the details in the system of
record.
A process that manages the multiple person details and stores the details in the system
of record.
Time entry
Program configurator
A Program configurator is a tool allowing agencies to manage and customize the needs
of the customer for programs like regulatory and integration, Citizen services,
immigration-oriented programs more effectively and efficiently by interacting with
constituents and corporate entities. The program Configurator software gives you
greater flexibility and reduces the proliferation of items for uniquely configured
program.
• A program configurator allows you to make use of the PGP application features
with the ability to Configure profiles for individual constituents and corporate
entities. It also allows you to configure the PGP Case Reviewer Features to help the
application request case type to review the program throughout the life cycle.
These case – review features such as Upload and verify documents, review
checklist, evaluate to name a few aids the case review process that can be reused
and customized in the application request case type to meet your business needs.
• The application request case type enables users to apply for any program or any
of its descendants and takes you through steps to achieve end to end process of
intake vs the review of the program so configured earlier. The application request
case type allows business users to streamline application processes such as
capturing image of a program, entity details, enables you to apply for a program
or any of its descendants, for example, a license. Using application request, you
can bring all the services of your organization under one case type. The
application request case type allows business users to streamline application
processes, such as capturing entity details, document intake, consent agreement,
and so on from start to finish. The business managers can review and approve the
attached or uploaded documents, review the checklist, evaluate the process, and
approve the application.
• The program configurator has an ability to view the programs and its descendants
with separate views. To save time, you can reuse dynamic views, which are
standard forms that your application automatically manages for each program
that you define.
• Provide seamless and simple processes for constituents, businesses, and agency
employees
• Reduce processing and minimize touch points to provide straight-through
processing
Program definition
You can use Program definition to define and manage programs and licenses for
various entities available in PGP (Pega Government Platform) such as person, business,
item, vehicle, and facility. To introduce a new program or license in the system, users
can create a new Program definition case type from the Case manager portal. From the
Program definition landing page, you can search or view a program or a license.
• Edit program
• Copy program
Program finder
In Pega Government Platform™, Program finder is a questionnaire case type that you
can use as prescreening for programs. This prescreening would help users identify the
eligible programs and licenses they can apply for. Government agencies often use
prescreening for programs to provide the list of eligible programs for which an
applicant is eligible.
The Program finder case in Pega Government Platform™ comes with set of sample
questions, based on the responses provided to the questions, the system displays a list
of programs and licenses for which the user is eligible. Users can select from the
eligible programs and apply for the same.
Applies to Theme Cosmos. Verify document component allows the users to view the list
of the uploaded documents and provides an option to approve or reject the
documents. Users can opt to either approve or reject each document with comments. It
also enables the business users to configure the change of stage on rejection.
Applies to Theme Cosmos. Nearby location component allows users to view the list of
nearby cases, nearby places and the nearby entities that are issued on a map based on
the radius input calculated based on the location address provided in the application.
The displayed results can be selected for further processing. This component can be
added as a step in any case type and the location source, nearby results can be
configured easily from App Studio.
Evaluate process
Applies to Theme Cosmos. Evaluate process helps an evaluator or reviewer evaluate the
application against various criteria that is important to your organization. After the
application is evaluated, the system calculates a total evaluation score based on a
weighted formula and recommends one or more next actions to take.
Pega Government Platform extends Pega App Studio to provide additional business
configuration capabilities for evaluation criteria.
Review checklist
Applies to Theme Cosmos. Review checklist is a process through which a reviewer can
review the application against various checklist items. The progress can be tracked by
selecting the check boxes that correspond to items as they are completed.
Pega Government Platform extends Pega App Studio to provide additional business
configuration capabilities for review checklist.
Add interview
Applies to Theme Cosmos. Add interview is a component that allows users to add
interviews by selecting question templates, entering questions and responses in text
areas, and adding participants, locations, attachments, and other details.
Add evidence
Applies to Theme Cosmos. Add evidence is a component that allows users to add
evidence details, such as category, description, attachments, captured by, and location.
Assessment
Applies to Theme Cosmos. The Assessment configuration feature enables the user to
configure the SLA score against each response and interpretation based on the final
score.
Conduct assessment enables the user to conduct assessment in any case as a local
action and go through the process of completing the answers for the assessment
questions, save and return to complete the assessment. Also, on completion view the
score, interpretation of the assessment.
Assessment component can also be used as a step in any of the stages of a new case
type.
Activity plan
Applies to Theme Cosmos. An Activity Plan is a framework for tracking Goals and Tasks
assigned to operators associated to an instance of a Case. The Activity plan component
can be applied to various business use cases, including procurements, and
investigation applications.
Activity plan templates expedite the process of creating a new activity plan. The
templates are pre-configured activity plans containing all the details required to
implement the activity plan. Activity Plan templates may be used to construct reusable
collections of goals and tasks. A reusable template may be associated with a Case, and
its goals and tasks may be configured for the specific Case.
Activity plan configuration enables users to configure activity plan templates that
consist of goals, tasks, and SLA definitions. The user’s Activity plan edit accessibility
helps the user to update the Goals and tasks and sequence them based on priorities
using the SLA’s. Also, the existing activity plans can be deactivated if the template is not
required.
An activity plan template Landing Page enables users to create activity plan templates
with goals and tasks as a template which can be used for further processes. The users
can edit the goals and tasks which can be further used in the investigation case type
either by selecting the existing or creating a custom activity plan for the same. The
users can also deactivate an Activity plan if the template is no more required. An activity
plan so launched in the investigation case type can be appended with additional goals
and tasks. This allows the users to add existing Goals or tasks, or custom create them.
The component provides support for initiating activity plans using existing templates or
creating custom templates based on the use case. The component provides support for
initiating a sequential plan or parallel plan as required. The system allows you to make
necessary changes to the existing plan before initiation. It also provides the option to
assign goals and tasks to individual users by selecting from the existing list of users or
work queues. In the case of sequential plan, once a sequence is set, the goals and tasks
within the plan will be created as per the sequence. The next task or goal will be
assigned only after the previous one is resolved. This feature can be used by selecting
the Sequential checkbox while creating an activity plan template or any custom activity
plan case at run time.
Activity plans can be initiated for any of the existing cases through local and case-wide
actions. The case owner can assign tasks and goals to team members or work queues,
and the execution can be monitored as per the configuration. Once all the tasks and
goals within an activity plan are complete, the plan will be resolved. The case owner can
also resolve the activity plan by forced closure if it is not required or is invalid.
The Activity Plan Usage tab displays the list of plan templates that are used during
creation of Activity plan case from Investigation or any other case. This tab also
provides details on usage count, status of the plan and if the plan used is existing or
custom. Users also have an option to convert custom plan to template.
Entity merge
Applies to Theme Cosmos. Entity merge is a feature that enables the users to merge the
data properties of potential duplicates of Person entity or Business entity and create a
single Master record. The duplicate entities are marked as inactive and all the
properties selected by the user are retained in the Master entity.
The properties that need to be displayed for merging can be pre-configured by the
users from option provided under PGP configuration in App Studio.
Applies to Theme Cosmos. The attachment component feature saves file and URL
attachments as data items to the entities. It supports attaching multiple file types, such
as Word, PDF, Excel, and so on. The features serve as tools to help manage critical
attachments stored against any entity, such as person, business, facility, vehicle, and so
on.
Applies to Theme Cosmos. Mobile Offline features such as conduct interview, evidence,
case notes and completion of the tasks in activity plan can be completed on mobile in
offline mode. The data gets synced with the case once the users are online again.
Internationalization
Case report
Applies to Theme Cosmos. A case report is a detailed report of the data that is captured
in the case type. You can now generate a Report of Investigation in both PDF and
Microsoft Word formats. You can also incorporate tabular data into a Report of
Investigation.
Pega Government Platform provides a generic association framework that allows you to
associate objects to each other and manage all the associations that are linked to the
entities in the system.
Entity to entity
Case to case
Entity to case
Victim of an accident, beneficiary to a grant. Below are some of the entity to case
associations available in PGP.
Case to entity
Subject of an investigation (person, business, vehicle, or facility). Below are the some of
the case to entity associations available in PGP.
This feature enables a case worker to preview entities associated. This feature allows to
quickly preview the content on a separate panel without opening it. This allows you to
display the most important information, so users can navigate and manage their
entities much more efficiently.
PPega Government Platform provides agencies with the ability to create, update, and
view profiles for individual constituents in the form of editable widgets, which provide
the ability to edit existing information. Each profile includes personal information,
demographics, associations, employment, history, and communication details..
Pega Government Platform provides the ability to create, view, and manage business
entities and the details of their employees, branches, associations to constituent
profiles, and communication details in the form of editable widgets.
As part of this release, custom access in the request access feature is not supported in
Cosmos and will be taken as part of next release.
Conduct Investigation
A field investigator can then conduct the investigation with many tools such as subjects,
Interview, evidence, Activity Plan, Assessment to name a few. By using a quick-create
utility designed for speedy data capture, field investigators can establish and update
cases. The drag-and-drop abilities of Pega Government Platforms enable the
association of entities and situations for better analysis and visualization.
The Investigation case type also allows the field investigator to generate a report at the
end of the investigation. This allows the investigator to capture the data captured using
different tools used to conduct investigation.
At the completion investigation case by captures details using different tools, the field
investigator can complete the stage to review the checklist and change the status of the
case accordingly.
The investigation case type provides user to log Time for the case and provides
investigation owner, supervisor with time tab which gives a summary of time entry logs
of the case.
The case report component enables you to generate a report of a case which contains
the data that is captured using various other components that are available in the
system. This helps you analyze the information from a single place.
You can generate a Report of Investigation in both PDF and Microsoft Word formats.
You can display the data such as external organization, subject, evidence, and
assessments from various sections in a tabular format. The ROI component is flexible,
allowing you to choose to include the data such as external organization, evidence,
subject, interviews, assessments, and digital signature from various sections to be a
part of the end report.
Investigation report
This feature enables the operators to create reports and expose them to supervisors.
Each operator can view the touch point reports and view their course of work over the
period of time. These reports are only restricted to the work done in the Investigation
case type.
These reports allow you to monitor in real-time the efficiency and success. You can view
how often an operator has worked on an investigation case type and how long it takes
to complete the tasks on an average, for example, over the last year.
Pega Government Platform includes end-to-end event case management that enables
organizations to improve the resolution process. It provides the following capabilities:
• Initiate events
• Review events
• Resolve events
• Event intake – enables the intake worker to capture event details and category,
and to send it for review.
• Initiate investigation cases – enables the ICM agents and supervisors to initiate
investigation cases through an event or standalone cases.
• Case acceptance through email – enables the ICM agents to accept the
investigation cases directly through E-mail.
• Subjects case management – enables the ICM agents to create subjects, and to
associate subjects to investigation cases or known entities.
• Conduct interviews – enables the ICM agents to conduct interviews on subjects
and to add interviews to an investigation case.
• Capture evidence – enables the ICM agents to add evidence and capture all the
details for an investigation case and associate it with subjects.
• Add case notes – enables the ICM agents to add case notes that are related to any
investigation to the investigation case.
• Add activity plan – enables the ICM case owner to add an activity plan to an
investigation case and assign tasks to the team members
• Create assessment – enables the ICM agents to conduct assessments for entities
that are related to any investigation case.
• Quick creates – enables the ICM agents to create subjects and investigation cases
on mobile and hand-held devices.
• Generate report of investigation – enables the agents and supervisors to generate
a report of an investigation by selecting the contents to be included in the
document.
• Team management – enables the ICM agents (case owners) to manage the team
members for an investigation case.
• Manage associations – enables the agents and supervisors to manage all the
associations that are related to an investigation case, subject case, event case, and
entities.
• Persona based dashboards – ICM agents, supervisors, and intake specialists have
specific dashboards that enable them to track events, investigations, team, work,
and workload.
• Access management – enables the ICM agents to request read and write access,
and to approve access as read, write, or custom access.
• Case and object visualizations – enables the view of all the associations in a visual
representation, which gives a 360-degree view of all the tied objects.
• Audit trails and timeline views – enables the view of the activities in any case in a
visual timeline view or list view.
• View of investigation case – enables the view of all details related to an
investigation case in a 360- degree UI to get a complete picture of the case.
• Transfer ownership – Investigation owner can transfer ownership of an
investigator to an office or an user based on the requirement. A user has the
option to view the investigation details and can accept the ownership or reject it
so that the investigation can retransfer the ownership to someone else.
Complaints management
• File complaints – enables constituents to create complaint cases and provide all
related details.
• File anonymous complaints – enables constituents to file an anonymous
complaint.
• Review complaints – enables managers to review the complaint cases and take
necessary action.
• Persona based dashboards – Complaints workers and managers have specific
dashboards that enable them to view complaint status, workload, team members,
and work lists.
Procurements management
• Add marketing details – enables the market analyst to add and capture details for
the marketing related to new procurement.
• Define advertisements – enables the procurement officer to define advertisement
details for a procurement.
• Vendor bidding – enables the vendors to submit bids against the listed
procurements.
• Multi-personnel evaluation – enables multiple levels of evaluation for the
submitted bids.
• Award bid process – enables the supervisor to award a bid based on the
evaluation score and system recommendation.
• Ask questions – enables the end users to submit questions.
• View answers – enables the end users to view the existing questions and answers
on the portal.
• Persona based dashboards – Procurement officers, supervisors, and market
analysts each have specific dashboards that enable them to view procurement
status, team workload, team members, and work lists.
User registration
Constituents can register and obtain an online account through Pega Government
Platform to access services provided by agencies without the need to come into an
office or call the agency. After registering, users can manage their own operator ID and
password. The user registration process utilizes Pega’s authentication and authorization
services, which you can integrate into your agency’s security infrastructure.
PGP User PGP users can view urgent work, add new
entities to the system, manage the entity
information, and view reports from the PGP
Case worker dashboard via the Pega
manager portal.
ICM agent
The ICM agent works on the investigation
cases as the investigator or investigator
analyst and uses the templates of the PGP
Case worker dashboard and Pega manager
portal with reports specific to investigations.
ICM supervisor
The ICM supervisor reviews events and
assigns work to the ICM agents and uses the
templates of the PGP Manager dashboard
and Pega manager portal with reports
specific to investigation case summaries.
Supervisor also has an ability to configure
assessments.
Procurement Officer
The procurement officer creates the
procurement plan, enters advertising details,
and answers vendor questions about the
procurement. They use the templates of the
PGP case worker dashboard and Pega
Complaints User
The complaints user can file a complaint
from their self-service portal as a
constituent.
Communication Pega
Contains information
pertaining to
communication
Time management
Applies to Theme Cosmos. Capture and track daily employee time against time codes
and projects. The Time Management application is a low-code solution that helps in
tracking and reporting time for users as per applicable standards and guidelines.
Time entry
This case type provides users with a process to log time with details like project code,
time code, reference id (case id), hours, and so on. These logs are reviewed by the team
manager in the review step.
The Time Management feature supports cascading approval for time entries. You can
control the routing of approvals based on the configuration of the time management
project.
Based on the selected approvals for a project in data records, Time entry is routed to
different levels of approvals accordingly. If all the routing paths are enabled the
approval action goes first to the Work Group Manager, then to the Time Code Approval,
and to the Project owner Approval.
If a user is logged into time for the first time (on the current day), they can copy the
projects, activities, and references by selecting the latest entry check box. This action
will copy the latest submitted time logs to the present-day logs.
A Touch point report that lists the cases along with their description is provided to the
users when an action is performed.
Manage time
In My Timesheet users can search for time entry logs with search criteria such as start
day, end day, project, activity, and reference. The reference id is provided as a link with
which users can view the case for which they have logged time.
Team managers are provided with Team Timesheet along with My Timesheet. In Team
Time sheet, managers can view the logs of team members all together or view the logs
of specific team member with Operator search criteria.
Time management supports key roles associated with your day-to-day use of the
application. The following table lists the key access roles with their descriptions.
User Users can log time entries and view their own logs. Managers
can view their team’s entry logs (if they managing any teams)
along with their own logs.
Admin Admin has access to view the time entries of all the users .
Further reading
Applies to Theme Cosmos. Get more information about Pega Government Platform.
• Features
Features
Applies to Constellation. The Pega Government Platform (PGP) offers a comprehensive
platform with customizable functional areas and features to meet specific business
requirements for government agencies.
• Entities
• Business components
• Government journeys
Entities
Applies to Constellation. The Pega Government Platform (PGP) includes pre-
configured, persistent data classes known as entities that model commonly used data
elements in government processes. These entities serve two purposes: entity instances
persist in a data store, and entity data classes act as types for embedded pages to
support case processing on the PGP.
• Person
• Business
Person
Applies to Constellation. Effortlessly manage the data of constituents with the Person
entity feature of Pega Government Platform (PGP). Capture, view, and edit details of
constituents, search for a constituent, and view their information.
Person entity
Persona Action
Investigation officer Associate victim, suspect, or eyewitness to a hit and run case.
Taxpayer Create your own profile on the department of tax site and use
the details to file tax returns every year.
Reusable features
Case type
• Person case type
View
• 360-person view
• Search person
• People landing page
The Person case type enables you to create or edit a person's profile in the system, with
options to input details such as name, communication details, and more. The system
saves the person's record along with relevant data, such as communication details,
communication preference, security questions, and more in the database. Additionally,
the system checks for duplicate records based on defined criteria.
The system saves the person's record in the database along with relevant data,
including their address, communication details, communication preferences, security
questions, and more. The system also checks for duplicates based on defined criteria
when creating a person. You can use the Person case type when creating a person as a
child case of a process or as a standalone case, such as online self-registration.
Create person
You can edit an existing person's details, update the person data, and submit the
changes. The Edit person process is the same as the Create person, with pre-populated
details of the person for making the necessary changes.
360-person view
The 360-degree view provides essential information, including the name, address, and
ID. Pega constellation screens consist of three sections: the Summary view (left pane),
Detail view (main section), and widgets (right section). By clicking on the email or phone
number in the summary panel, you can directly open an email or make a call.
Additionally, you can view a person's associations by clicking on the associations in the
summary panel.
360-person view
Search person
The SearchPerson view in PGP enables users to search and select individuals who
already exist in the system. Use this feature across many case types as required.
You can search for an existing person using first name, last name, or Date of Birth
(DOB). The system displays the results (contact ID, first name, last name, DOB, address
summary) based on the search criteria entered. Check implementation guide to
enhance search criteria with more fields.
Search person
If a person is not found during the search, you can create a new person by selecting the
Create new option. This action will display a screen to capture the basic details of the
person. Enter the required details and save. The system will validate the entered
information and check for any duplicate records.
The landing page of PGP Person entity displays the list of people added to the system.
The landing page view is also called as Person list view.
To view the list of People and Business entities added to the system, click Entities in the
left pane of App Studio.
Search for a person by entering their first name or last name. The search results will
display the person's first name, last name, contact ID, date of birth, and address
summary. You can filter the results by applying a filter within each column or search a
text across all the columns.
Search functionality
The Basic Person flow is a reusable tool that captures essential information about an
individual and associates it with the relevant case type. It is also used as part of another
micro-journey to gather information about constituents.
For example, a case worker at government department can use the basic person flow
to search for a person's record and create a new record (if no record found) during the
process of issuing a driver's license.
• Flow - The person details are permanently stored in the database and used in
other scenarios.
• Flow Action - The person details are not persisted in the database. These details
are temporarily stored and used for viewing purposes.
Business
Applies to Constellation. Pega Government Platform (PGP) provides a business entity
feature that enables easy management of business data. You can capture, view, and
edit business details, search for a business, and view its information.
Persona Action
Procurement head View all vendor businesses eligible for office supplies.
Update the better business bureau about the new
branch opened in Massachusetts.
Reusable features
Case type
• Business case type
View
• 360-business view
• Search businesses
The business case type in the system enables you to easily create or edit a business
profile. You can input details such as trade name, legal name, and contact information,
which are then saved in the database. Additionally, the system checks for duplicates
based on defined criteria when you create a new business.
You can edit an existing business details, and submit the changes. The Edit business is
the same as the Create business, with pre-populated details of the business for making
the necessary changes. Create business case type is ideal for seamless management of
business profiles. You can use business case type when creating a business as a child
case of a process or as a standalone case.
You can capture the contact person when creating a business by either selecting an
existing person or creating a new person.
• Existing: You can search for an existing person using first name, last name,
National ID, or DOB. Enter the search crtiteria to view the results such as contact
ID, first name, last name, DOB, National ID, and address.
New: You can create a new person by selecting the Create New option. This will
display the basic person flow. Enter the required details and save. The system
validates the entered details and checks for duplicity. With this option, system
creates a new person along with business.
• Not applicable:If you don’t want to associate a contact person for the business,
select Not applicable.
Review request
Business goes through an approval process before creation. The status of a new
business request is Pending-approval. In this stage, you can review the request and
take necessary action.
• Approve: Approve the request if the details entered are valid and take further
action.
• On hold: Hold a request (if the provided business details are incomplete or not
correct) and revisit to take further action.
• Reject: Reject the business (if the provided business details are incomplete or not
correct).
Edit Business
You can edit an existing business detail, update the business data, and submit the
changes. The Edit Business case type is the same as the create business case type with
pre-populated details for making the necessary changes.
Add branch
Add your business's branch details by using the Add branch option. You can input
details such as branch name, branch ID, relationship type, open date, number of
employees, business phone, email, fax, address, contact person, and more in the
database. You can view the list of all the branches from the Branches tab on the left
pane (Summary panel).
Add branch
360-business view
Pega Government Platform (PGP) enables you to view all the details related to a
business profile in a 360-degree view. Select the business case type to view all the
details of a created business profile.
Pega constellation screens have three sections - summary view (left pane), detail view
(main section), and widgets (right section). You can directly open an email or call by
clicking on phone in the summary panel. You can also view associations of a business
by clicking on associations in summary panel.
360-business view
Search business
Pega Government Platform (PGP) provides SearchBusiness view to search and select an
existing business. You can use this view in different case types based on the
requirement. For detailed information on implementing SearchBusiness view, refer to
business entity in Implementation guide.
You can search for an existing business using legal name, trade name, email, or phone
and get the required results. Check implementation guide to add fields for search
criteria.
You can create a new business if the business details are not found in the system on
search. When there is no record, the system populates basic business information
window to enter the required details. Enter the details and the system validates to
check for duplicate record.
The Pega Government Platform (PGP) Business entity landing page displays a list of
businesses that have already registered with business entity. To know more about a
particular business listed on the landing page, you can select the business name to view
its profile. The profile page provides detailed information about the business such as its
name, legal name, trade name, employer ID, and contact information.
Click Entities from the left pane, the system displays list of people and businessess
added to the system. The landing page view is also called as Business list view. You can
filter the results within each column or search a text across all the columns.
Capture basic business details and associate them with the required case type. The
system checks for duplicates when you enter the required details. If the business
details do not exist, you can create a new business. You can search for an existing
business or add a new business to capture basic information.
Basic business is a reusable feature, that offers view and flow action to capture details,
and flow to persist the details. The view can be reused in any case type where business
details are captured, instead of rebuilding each time. For example, applying for aviation
exemption request for an organization to fly a drone.
Basic business flow and flow action can be used in different scenarios as explained
below:
• Flow - Use basic information flow when capturing and persisting data at the same
step within the case. For example, when applying for an aviation exemption
request for an organization to fly a drone, you can use this flow to capture the
organization's details and persist the data.
• Flow action - Use flow action when capturing, validating, and persisting business
details at a later stage. For example, when applying for an aviation exemption
request for an organization, eligibility needs to be verified before granting
approval. In this use case, you capture the organization's details, validate them,
and then persist the data. Flow action can be used in these types of scenarios.
Business components
Applies to Constellation. The Pega Government Platform (PGP) is a comprehensive
platform designed for government agencies to streamline their operations and deliver
better services. The platform includes several business components that work together
to give a complete solution to government agencies.
• Subject
• Interview
• Evidence
• Association management
Subject
Applies to Constellation. Pega Government Platform (PGP) enables users to create
subjects of type Person and Business. You can associate subjects to their microjourneys
like Investigation, for streamlined and efficient case management.
You can easily create subjects within an investigation case or as standalone entries for
later association. Effortlessly capture, view, and edit details of diverse entities and items
for seamless data management.
The following are the sample use cases of Subject case type.
Persona Action
Reusable features
Case type
• Subject
View
• 360-subject view
Flow
• Create subject
You can create new subjects using Subject case type. While creating a subject, you can
associate it to a Person or business.
In the Create Subject window, select person or business option and select any of the
three options to create a subject.
Subject
• New: Choose New to associate a new person or business with the subject. Enter
the basic person or business information to add a new person or business.
• Unknown: Choose Unknown if you are unsure about details of the person or
business. Enter a short description and proceed further.
Note: When the Unknown is selected, the subject status is Pending Association. You
can associate a person or business with the subject at any time by selecting Change
Association.
Next, select subject role. The following are the available subject roles for Person and
Business.
Role Options
Person
• Person of Interest
• Victim
• Witness
• Suspect
Business
• Area of interest
• Suspicious organization
• Target
Subject
Edit Subject
User can edit an existing subject and modify the subject role or details. To change
details of associated Person or Business, you can use Edit Person or Edit Business as
defined in Person and Business sections. You can change association to a different
Person or Business using Change identification.
Edit subject
Associate to Investigation
360-Subject view
PGP allows users to view all the details related to the subject in a 360-degree UI to get a
complete picture of the case. Once a subject is created, select the subject case type to
to view all the details of that subject including demographic information,
communication details.
360-subject view
Other actions
Click the three dots on the left pane of the subject screen. You can perform the
following actions:
Note: During the process of change identification, you can also create a
new person or business. You can change identification only within the
same entity.
3. Manage associations - This option enables you to view the list of associations
linked to the subject case. For more information, refer Manage associations in
Association case type.
Create subject
The Create Subject component can be accessed from any case. If the component is
invoked from a case other than the subject case, the created subject becomes the child
case, and an association link is established between the subject and the primary case.
This link can be managed through Manage associations.
Related subjects list: You can invoke related subjects list view in any case type. The
view displays the list of subjects associated to a case. You can configure the subjects tab
to view the list of associated subjects. For more information on configuring the subjects
tab, refer implementation details.
Interview
Applies to Constellation. The Interview case type allows you to capture or record details
of any interview conducted. You can initiate an interview by capturing the details such
as participants, location, time, and attachments. The system saves the details in the
system of record. The case type can be invoked from other case types such as
investigation.
The Pega Government Platform (PGP) interview case can be easily configured in your
business process. Interview allows to initiate, conduct, and close the interview. You can
use interview template to have pre-defined questions, capture response, and add final
notes after conducting the interview.
You can also launch the Interview case type as a standalone case or in another case.
Persona Action
Investigation case supervisor Interview the suspect of a hit and run case
Reusable features
Case type
• Interview case type
View
• 360-interview view
Flow
• Create interview
Interview case type is used to create or edit an interview case in the system. This case
type provides an option to capture the interview details such as selecting the interview
template, primary interviewer, scheduler type (immediately or later), and the
participants list.
Interview template is used to create customized templates. For more information, refer
Interview template.
Note: Upon selecting later in scheduler type, you can select the date and time
for creating the interview.
Create interview
Edit interview
Edit an interview by using the Edit interview feature, which you can use to add another
participant, update the values that are captured, and so on.
Interview status
Once the interview is created, the status is Pending acceptance.In this stage, you can
review the interview and take necessary action. The available actions are:
• Update interview
• Cancel interview
Start interview
Once the interviewer is ready, select start the interview. A list of questions are displayed
(depending on the selected template while creating the interview). Capture the
responses and click Submit.
Update interview
You can update the interview details such as adding another participant, update the
values that are captured, and so on. If any participant is excluded or included into the
participants list, an email notification is sent about the update to the participant.
Cancel interview
You can cancel the interview if you no longer want to proceed further with the interview
case.
Conduct interview
Capture feedback
Once the interview details are entered, you can capture the feedback of the interview or
capture any notes required to the interview and resolve the interview case.
capture feedback
360-Interview view
PGP enables you to view all the details related to an interview in a 360-degree UI to get
a complete picture of the case. After an interview is created, all the details of the
interview, such as interview name, report type, incident date and time, and reporter
information, are displayed.
360-interview view
Create interview
The Create interview component can be accessed from any case. If the component is
invoked from a case other than the interview case, the created interview case becomes
the child case, and an association link is established between the interview and the
primary case. This link can be managed through Manage associations.
Related interviews list view can be invoked in any case type. The view displays the list of
interviews associated to a case. You can configure the interviews tab to view the list of
associated interviews. For more information on configuring the interviews tab, refer
implementation details.
Interview template
Pega Government platform’s interview template feature offers a range of tools and
features that enables you to create customized templates with list of questions to be
asked during interview and prompts to ensure accurate and complete information
gathering. With our tailored templates, you can improve efficiency and decision-making
for specific case types or scenarios.
Persona Action
Reusable features
Case type
• Create interview template
View
• 360-interview template view
• Template landing page
The landing page of the PGP interview template displays the list of all templates added
to the system. Click Templates from the left pane, and the list of templates added to
the system is displayed. Use the search template feature to search for templates. The
landing page view is also called the list view.
Create template
This feature offers the option to input template name, description, feature (for which
the template is created), status (active/inactive), and an option to add the questions.
The system saves the provided details along with relevant data. Once the template is
created, its status is set to active, by default. The created template appears in the
dropdown menu while creating an interview.
Edit template
You can edit an existing template, modify details, and submit changes. The Edit
template is the same as the create template with pre-populated details for making the
necessary changes.
Edit template
360-template view
PGP enables you to view all the details related to the template in a 360-degree UI. After
the guidance is created, all the details are displayed such name, feature, description,
and questions.
360-template view
Evidence
Applies to Constellation. Investigative Case Management (ICM) application allows
agents to efficiently add evidence. They can capture relevant details by creating an
evidence case directly from the investigation.
In the Evidence case type, you can capture details of evidence that can serve as
evidence. You capture location, and attachments related to the evidence based on the
type of evidence. The captured details and attachments are persisted in the system of
record.
Persona Action
Investigation officer
Associate the evidence to the investigation
Reusable features
Case type
• Create evidence
View
• 360-evidence view
Flow
• Create evidence
Create evidence for an investigation case with the provision of details such as evidence
type, name, description, and location details, and attachments, if any. Any evidence
created during an investigation is automatically linked to that investigation.
Create evidence
Edit evidence
Edit evidence allows to update an existing evidence detail, and submit the changes. The
edit evidence is the same as the create evidence case type, with pre-populated evidence
details for making the necessary changes.
Edit evidence
360-Evidence view
360-evidence view
Create evidence
The Create evidence component can be invoked from any case type. If the component
is invoked from a case other than the evidence case, the created evidence becomes a
child case, and an association link is established between the evidence and the primary
case. This link can be managed through Manage associations.
The related evidence list view can be accessed from any case type. This view displays a
list of evidence associated with a case. You can configure the Evidence tab to view the
list of associated evidence. For more information on Configuring evidence tab, refer to
the implementation details.
Association management
Applies to Constellation. Association management is a powerful, extensible out-of-the-
box (OOTB) framework for managing the relationships between different entities and
cases. The visual output offers high business value to customers looking to manage
complex relationships in case life cycles.
The Pega Government Platform (PGP) provides a generic association framework that
allows you to associate objects with each other and manage all the associations that
are linked to the entities in the system.
Persona Action
Restaurant license approver manager Check the history of all owners and their
prior businesses and violations by owners
and their businesses, before approving.
Persona Action
Let's examine the associations created when a car accident is reported and two
individuals are injured. In this scenario, two individuals are associated with the incident:
car accident, the driver of the car as the subject, and the injured individual as victim.
The following are the possible associations that can be captured in this scenario:
• Entity to entity: The driver (person entity) and the victim (person entity) involved
in the car accident
• Entity to case: The car driver (subject case) associated to the victim (person
entity)
• Case to case: The car driver (subject case) associated with the car accident
(incident case)
Reusable features
Case type
• Manage associations
View
• Associations list view
Manage associations
You can manage the associations through the context of individual entities or cases and
from the generic manage association feature that is available in Pega Government
Platform.
Manage associations
The Associations list view in Pega Government Platform (PGP) displays all the
connections between entities. This view is customizable to show various association
types, it is easily accessible through manage associations.
Government journeys
Applies to Constellation. PGP supports end-to-end processes to deliver better services,
handle cases more efficiently, and reduce costs. These journeys streamline government
processes and improve operations efficiency.
• Incident
Incident
Applies to Constellation. Government agencies, their employees, constituents report
many incidents or events such as theft, disturbance, and narcotics. for further action by
suitable authorities. Pega Government Platform (PGP) offers an "incident" case type to
register, process the reported incident and help government organizations improve the
resolution process.
• Initiate incident
• Review incident
• Resolve incident
The incident feature of Pega Government Platform (PGP) enables you to manage
incident lifecycle. It allows you to capture, view, and act on incidents. An automatic
email is sent out to reporter, when an incident is created, or an action is taken on the
incident.
The following are the sample use cases for incident case type:
Persona Action
Reusable features
Case type
• Incident case type
View
• 360-incident view
This case type offers the option to input incident details, including the event incident
name, date and time, report type (lead, tip, or Incident), reported activity, incident
location, and reporter information. The system saves the incident details along with
relevant data. Once the incident is created, its status is set to New, and it is assigned to
a work queue by default.
From the event screen, possible actions include follow, edit details, and change stage.
Incident
Edit Incident
You can edit an existing incident, modify the incident details, and submit the changes.
The Edit Incident case type is the same as the create event case type with pre-
populated details for making the necessary changes.
Edit incident
Once the incident is created, the status of the incident is "Pending-review". In this stage,
you can review the reported incident and take necessary action.
• Approve: Approve the incident if the details entered are valid and act accordingly.
• Open an investigation
• Issue a warning
• No Action needed
• Invalid incident
• Duplicate incident
Review incident
Associate an incident with another incident that may be related. Search for potentially
related incidents and associate them with the current incident. In this case, the status
of the duplicate incident is set to " Resolved-Rejected" and only one incident will remain
active.
360-Incident view
PGP enables you to view all the details related to an incident profile in a 360-degree UI
to get a complete picture of the case. After an incident is created, all the details of the
incident, for example, incident information and reporter information, are displayed.
360-incident view
The landing page of the PGP incident case type displays the list of incidents added to
the system. Click Incidents from the left pane, and the list of incidents added to the
system is displayed. Use the search incident feature to search for incidents in the
system based on their basic information. Search for incidents by using inputs, for
example, Name, Incident ID, Report type, State, and City.
The ICM application is meant for a different set of users, such as Investigators, ICM
agents, and more. Use the application to manage the entire life cycle of an
investigation.
The following are the business examples for investigation case management:
Persona Action
FBI agent
Investigate an incident and work on the
following items:
Persona Action
Reusable features
Case type
• Investigation case type
View
• 360-investigation view
The Investigation case type in the system enables easy creation of investigation cases.
This case type provides an option to input details such as investigation name, case
open date and time, reported activity, description, address details, external
organizations, and more. The system also checks for duplicates based on defined
criteria when creating an investigation case. You can use this case type as a standalone
case.
Create investigation
Edit investigation
You can edit an existing investigation case, modify the investigation details, and submit
the changes. The edit investigation case type is the same as the create investigation
case type with pre-populated details for making the necessary changes.
Edit investigation
360-Investigation view
360-investigation view
Other actions you can perform on this screen: Click the three dots on the left pane
of the investigation screen. You can perform the following actions:
• Manage associations - This option enables you to view the list of associations
linked to the investigation case. You can also add a new association for the
investigation case. For more information, refer Manage associations in Association
case type.
• Create Subject - This option enables you to create a subjectfor the investigation
case. It automatically creates association between subject and investigation case.
For more information on subject case, refer Create subject in Subject case type.
• Create Evidence - This option enables you to create an evidence case for the
investigation case. It automatically creates association between evidence and
investigation case. For more information on evidence case, refer Create evidence
in Evidence case type.
• Create Interview - This option enables you to create an interview case for the
investigation case. It automatically creates association between interview and
investigation case. For more information on interview case, refer Create interview
in Interview case type.
Create Interview
• Generate Case Summary - This feature allows you to generate a summary of the
investigation case using GenAI. The summary includes details of the investigation
case as well as any cases created from it (such as interviews, evidence, and
subjects) based on your selection.
1. Choose the desired summary template from the available options: Judicial,
Law Enforcement Agency, or Internal Review.
2. Select the details to include in the case summary.
3. Click Generate AI to create the case summary.
Case summary
4. Once the case summary is generated, choose the document type from the
available options (PDF or Word). You can find the saved case summary in the
attachments.
The landing page of investigation displays the list of investigations added to the system.
Click Investigations from the left pane, the list of investigations added to the system are
displayed. The landing page view is also called the Investigation list view.
ICM agent
The ICM agent is responsible for reviewing
the nuances of the incident and conducting
the investigations using the tools provided.
They use the Investigation application to
manage and track cases, gather evidence,
and collaborate with other investigaton
agents and stakeholders.
ICM supervisor
The Investigation Supervisor is responsible
for ensuring adherence to laws and
regulations. They use the Investigation
application to monitor and review cases,
Install
• Installation guide for Traditional application
Patch releases are available through Pega’s standard software delivery process.
You can request software through Pega Software Distribution or by contacting
GCS.
3. Apply any required hotfixes by using the Hotfix Manager. For more information,
see Applying hotfixes. To review the Pega Government Platform hotfixes without
using the Hotfix Manager, see the Pega Government Platform Hotfix page.
Note: The deployment process modifies both the data schema and the rules
schema. Use a backup procedure that preserves both schemas.
Make sure that you complete the prerequisites for this application installation.
If operators are not available, follow these steps to create operators from the above
tables in your Pega Government Platform application.
1. Log in to Pega Platform by using the administrator credentials, and switch to the
respective applications and create the corresponding operators listed above.
2. In the header of Dev Studio, click Create > Organization > Operator ID.
3. Enter the Operator ID from the corresponding column in the Operators table and
click Create and open.
4. Add the Access group from the corresponding column in the Operators table.
5. Click the Work tab. Under Organizational unit, click Update.
6. Click PGPGov > Government > Operations, and then click Submit.
7. Add the Work group from the corresponding column in the Operators table.
8. On the Security tab, add the starting activity to execute from the corresponding
column in the Operators table.
9. Click Update password, enter a new password, and then click Submit.
10. Click Save to save the rule.
To update these listeners with requestor login credentials, complete the following
steps.
1. In the header of Dev Studio, click Configure > Integration > Email > Email
Listeners.
2. Click the PGPEventEmailListener listener name.
3. On the Email listener page, navigate to the Requestor login section and update
the password of PGPEventListener, which was created in Creating operator
accounts.
4. Save the record.
5. Repeat the previous steps for the following event listeners:
• ICMEventEmailListener
• RequestAccessApproval
• InvestigationAcceptEmailListener
To import the sample data for Pega Government Platform, complete the following
steps.
1. In the header of Dev Studio, click Configure > Application > Distribution > Import.
2. Select the /SampleData/PegaGP_SampleData.jar file from your distribution media.
3. Follow the wizard instructions to import the sample data.
1. In the header of Dev Studio, click Configure > Org & Security > Authentication >
Operator Access.
2. In the Disabled operator's section, select the check box next to the operator ID to
enable.
3. Click Enable selected.
The Enable Operator dialog is displayed.
4. Click Submit to confirm that you want to enable the selected operator ID.
5. Click OK to close the dialog box.
1. In the header of Dev Studio, click Configure > Application > Distribution > Import.
2. Select the /OptionalComponents/PegaGP_Sample_App.jar file from your
distribution media, and then follow the wizard instructions.
3. When the import is complete, click Done.
Patch releases are available through Pega’s standard software delivery process.
You can request software through Pega Software Distribution or by contacting
GCS.
3. Apply any required hotfixes by using the Hotfix Manager. For more information,
see Applying hotfixes. To review the Pega Government Platform hotfixes without
using the Hotfix Manager, see the Pega Government Platform Hotfix page.
Note: The deployment process modifies both the data schema and the rules
schema. Use a backup procedure that preserves both schemas.
Make sure that you complete the prerequisites for this application installation.
3. Enter a short description, for example, pgpsysadmin, and then click Create and
open.
4. In the Application Access section, enter two access groups PegaGovt:Authors
and PegaGovtICM:Authors.
5. Click the Work tab. Under Organizational unit, click Update.
6. Click PGPGov > Government > Operations, and then click Submit.
7. On the Security tab, click Update password, enter a new password, and then click
Submit.
8. Click Save to save the rule.
9. Login with the created operator for next steps.
1. To configure the security values, in the header of Dev Studio, click Configure >
Common Data Model > Server Configuration.
2. On the Server Configuration page, update the EndPointURI, ConstellationSvcURL,
and ConstellationPegaStaticURL settings with your server’s location.
You need not to configure the ConstellationSvcURL and ConstellationPegaStaticURL
DSS rules for Pega Cloud environments. Configure these settings only for on-
premises servers.
3. In the Select OAuth profiles to be configured section, select the checkboxes for
the profile names.
The OAuth authentication profiles that begin with CDM_OAuth display.
4. Click Submit.
5. Verify that the updates were successful, and then click Export OAuth config to
save a record of the client secret codes.
6. Log out and log back into the server.
To import the sample data for Pega Government Platform, complete the
following steps.
1. To match your application settings with the sample data set that you are going to
use, in the header of Dev Studio, click Launch portal > Data portal.
a. In the navigation pane of Data portal, click Administration > CDM - Entity
data filters.
b. In the CDM - Entity data filters section, in the Industry list, select the
industry for your application.
c. In the Origin list, select PegaSample.
d. In the Sample list, select S1.
e. Click Save.
2. To use the sample data in the Excel spreadsheet that is included with the Pega
software, export the sample spreadsheet by following these steps:
a. In the header of Dev Studio, click Records > Technical > Binary file.
b. Select the PGPSampleData.xlsx file.
c. Click Download file, choose a save location and click Save.
3. To import the sample contacts data, in the header of Dev Studio, click Launch
portal > Data portal.
a. In the navigation pane of Data Portal, click Create icon and Data utilities.
b. In the Manage Data section, in the Data Management action list, select
Upload Data.
c. Click Next.
d. Select PGPSampleData.xlsx file from the location where you saved the
sample spreadsheet.
e. Click Next and follow the instructions.
1. In the header of Dev Studio, click Configure > Application > Distribution > Import.
2. Select the /OptionalComponents/PegaGP_Sample_App.jar file from your
distribution media, and then follow the wizard instructions.
3. When the import is complete, click Done.
Update
• Completing the prerequisite tasks
Patch releases are available through Pega’s standard software delivery process.
You can request software through Pega Software Distribution or by contacting
GCS.
3. Apply any required hotfixes by using the Hotfix Manager. For more information,
see Applying hotfixes. To review the Pega Government Platform hotfixes without
using the Hotfix Manager, see the Pega Government Platform Hotfix page.
Important: Importing the new version of the application can require the
execution of column and declare-index population jobs. These jobs run in the
background, populating the new columns and declare-indexes that are
imported with the application, which requires the update of a large number of
records. In PostgreSQL installations, this large-scale update of records can
require additional temporary disk space, so ensure that there is enough disk
space available for the database to expand accordingly.
Note: The deployment process modifies both the data schema and the rules
schema. Use a backup procedure that preserves both schemas.
Redeploying the Pega Platform applications might delete these files from your
application server.
Make sure that you complete the prerequisites for this application update.
• Optimized properties
• Elasticsearch
• Performance mode
• IACAuthentication service
• IACAuthentication activity
• Changes to Registration.js
• Changes to VIS.JS
1. To configure the security values, in the header of Dev Studio, click Configure >
Common Data Model > Server Configuration.
2. On the Server Configuration page, update the EndPointURI, ConstellationSvcURL,
and ConstellationPegaStaticURL settings with your server’s location.
You need not to configure the ConstellationSvcURL and ConstellationPegaStaticURL
DSS rules for Pega Cloud environments. Configure these settings only for on-
premises servers.
3. In the Select OAuth profiles to be configured section, select the checkboxes for
the profile names.
The OAuth authentication profiles that begin with CDM_OAuth display.
4. Click Submit.
5. Verify that the updates were successful, and then click Export OAuth config to
save a record of the client secret codes.
6. Log out and log back into the server.
If operators are not available, follow these steps to create operators from the above
tables in your Pega Government Platform application.
1. Log in to Pega Platform by using the administrator credentials, and switch to the
respective applications and create the corresponding operators listed above.
2. In the header of Dev Studio, click Create > Organization > Operator ID.
3. Enter the Operator ID from the corresponding column in the Operators table and
click Create and open.
4. Add the Access group from the corresponding column in the Operators table.
5. Click the Work tab. Under Organizational unit, click Update.
6. Click PGPGov > Government > Operations, and then click Submit.
7. Add the Work group from the corresponding column in the Operators table.
8. On the Security tab, add the starting activity to execute from the corresponding
column in the Operators table.
9. Click Update password, enter a new password, and then click Submit.
To import the sample data for Pega Government Platform, complete the following
steps.
1. To match your application settings with the sample data set that you are going to
use, in the header of Dev Studio, click Launch portal > Data portal.
a. In the navigation pane of Data portal, click Administration > CDM - Entity
data filters.
b. In the CDM - Entity data filters section, in the Industry list, select the
industry for your application.
c. In the Origin list, select PegaSample.
d. In the Sample list, select S1.
e. Click Save.
2. To use the sample data in the Excel spreadsheet that is included with the Pega
software, export the sample spreadsheet by following these steps:
a. In the header of Dev Studio, click Records > Technical > Binary file.
b. Select the PGPSampleData.xlsx file.
c. Click Download file, choose a save location and click Save.
3. To import the sample contacts data, in the header of Dev Studio, click Launch
portal > Data portal.
a. In the navigation pane of Data Portal, click Create icon and Data utilities.
b. In the Manage Data section, in the Data Management action list, select
Upload Data.
c. Click Next.
d. Select PGPSampleData.xlsx file from the location where you saved the
sample spreadsheet.
e. Click Next and follow the instructions.
optional, and the sample data that is provided might not align with your business
needs.
To import the sample data for Pega Government Platform, complete the following
steps.
1. In the header of Dev Studio, click Configure > Application > Distribution > Import.
2. Select the /SampleData/PegaGP_SampleData.jar file from your distribution media.
3. Follow the wizard instructions to import the sample data.
To ensure a successful update of your application from Pega Government Platform 8.2
and earlier, review the topics in this section.
CAUTION: Do not use the integration layer with data tables as a source.
Note: Before executing the activities, be sure that you have admin operators
for each application pointing to the access group that is specified in the table.
To run the activities, launch the application that is specified in the table and access the
respective rulesets from the production rulesets of the access group.
classes
for the
Complain
ts
applicatio
n
After running the wrapper activities, clear all the node level data pages in all the
applications.
For example:
For example: if any changes are made to the PersonList report definition
(PegaPS-Int-Entity-Person), perform the same changes to the PersonList (PegaPS-
Data-Entity-Person) report definition in the implementation layer-specific ruleset.
Note: To find the report definition and response data transforms, refer to the
data page of the latest Pega Government Platform version.
Note: To find the new response mapping data transforms for the data pages,
refer to the latest Pega Government Platform version data pages.
For example:
For example:
For the sections that are overridden that use the StateList report definition (PegaPS-Int-
Config-State), replace the source by using the D_StatesList data page.
After upgrading your application, any customizations to the decision table in the
implementation layer must be also done in the Country data type. Customizations can
be performed by using the Internationalization menu, which is accessed from the Pega
Government Platform configuration in App Studio.
To ensure a successful update of your application from previous releases, Revisit the
following rule types that are overridden in implementation layers and which uses the
user level pages and make the necessary changes by referring to the corresponding
latest rule in the platform.
• Section
• Data transform
• Harness
• Activity
Optimized properties
A few properties are optimized in 8.6 for the PegaPS-Work-Event-Initiate, PegaPS-Work-
ICM-Subject-Initiate, and PegaPS-Work-ICM-Investigation-Initiate classes. In PGP 8.8, few
properties are optimized for PegaPS-Work-Program, PegaPS-Work-Program-License
classes. In PGP '23, a few properties are optimized for PegaPS-Work-ActivityPlan classes.
Follow the same for the implementation layer specific classes to avoid issues in running
the report definitions.
Elasticsearch
In Pega Government Platform 8.6, Elasticsearch is supported for improving the
performance of the application for Person, Business, Vehicle, Facility, and Entity data
classes and Investigation-Initiate work classes.
The existing list type data pages like D_PersonList, D_BusinessList, and so on of the
corresponding classes are added with a new data source to fetch the details using
Elasticsearch, and this is handled by a single DSS PGP/ElasticSearch which is by default
set to False. Change it to True to enable Elasticsearch.
You can configure the number of results that Elasticsearch returns by updating the
PGP/DefaultElasticResultCount DSS, which is by default set to 100 results.
Performance mode
In 8.6, a new DSS PGP/PerformanceMode is introduced to improve the performance of
loading the entity pages.
When this DSS is enabled to true (by default its set to false), the entity data pages use
Report definition instead of lookup to open the object.
Now entity data pages like D_Person, D_Business, and so on use data transform as the
source and the corresponding D_PersonLookup and D_BusinessLookup has multiple
sources defined, based on the setting which sets the data back to D_Person and
D_Business.
IACAuthentication service
Pega included IACAuthentication till the Pega Platform 8.6 release. Pega Platform 8.7
release does not include IACAuthentication, and the recommended approach is to use
web mashup. This effects user registration related features like Registration, and the
Forgot Password features of PGP Ui-Kit application. Implementation teams must make
necessary changes to adopt to the latest Pega Platform 8.7 release changes.
IACAuthentication activity
In Pega Government Platform 8.7, the IACAuthentication activity is withdrawn from
PegaPS ruleset. The IACAuthentication activity is moved to the UI Kit specific
PGPOverride ruleset, because the PGP application does not use the IACAuthentication
activity. Create a copy of this in your implementation ruleset if its being used in
implementation application built on Pega Government Platform application. In Pega
Government Platform'23, to enhance security, step 6 is modified in the
IACAuthentication activity to check for password validation all the time. For the
functionality to work, pass the password as parameter in the UserServices HTML
Fragment rule along with the existing app name parameter.
For enhancing security, a new step 6 is added in the IACAuthentication activity to check
for password validation. To skip this step, save the CreatePGPOperator application
setting with the owning ruleset PegaPS, to the implementation application ruleset, and
set the value to True.
If the search landing pages are updated in implementation layer or the data page is
being used elsewhere for OR scenario, update them by passing the value true to
UseOROperator parameter of the data page.
Data pages
D_PersonList
D_BusinessList
D_FacilityList
D_VehicleList
In Pega Government Platform '23, Edit case description is supported for Activity plan,
Goal, and Task cases. To enable Edit option for Activity plan, Task, and Goal cases which
are customized in implementation layer, add pyUpdateCaseDetails flow action to the
implementation layer case type.
Changes to Registration.js
In PGP 8.7, the goToLoginURL and showHomePage functions in Registration.js file
are updated to navigate the URL specific to the invoking application based on the
application alias and this is supported by adding a new parameter alias to both the
functions.
All the applications consuming these functions as-is need to send the alias parameter
to the function where it is being invoked using the Application.pyProductAlias property. If
the property is empty, set the alias on the application definition rule.
3. Select constant value as False to revert to earlier way of generating the Unique ID
and click Submit.
Follow these steps to set the QP instead of agent configuration setting to false:
Configuration setting
throw exception. This is applicable only if you are using the user registration feature in
PGP.
In addition, the Do not save property data option is enabled for the Confirm password
property, which captures the confirm password in text format.
This feature does not work as expected for auditing list properties like Address List for
the entity instances which are created before upgrade.
• BasicPersonalInformation
• PersonInformation
• BusinessInformation
• ManageVehicle
• ManageHousehold
• ManageFacility
• PegaPS-Work-Task
• PegaPS-Work-Goal
• PegaPS-Work-ActivityPlan
Changes to VIS.JS
In Pega Government Platform 8.8, we have updated the code in VIS.JS text file to refer
to the latest VIS-Network js. As a result, if the code is used in your implementation
layer, you must adopt the latest changes of it. In Pega Government Platform, as part of
adoption, we have added shakeTowards: "roots" as a value to the hierarchical layout
settings. Check EntityAssociationControl for reference.
Vis.JS file (deprecated in 8.8) is made available in release '23. You can use this file after
upgrading PGP from release 8.8 to '23. Check EntityAssociationControl for reference and
we highly recommend you follow the same approach in implementation layer.
Note: If the reopen stage is 1st alternate stage for task, then make sure that
the other case types like Goal, Activity Plan also have the reopen stage as 1st
alternate stage.
To convert the existing program and license data objects created from App Studio into
program definition cases for backward compatibility, you must perform the following
steps.
1. Log in to the pega environment by entering the administrator ID, for example,
[email protected] and the password that you used during installation.
2. In the header of Dev Studio, click Records > Technical > Activity
3. Search and open the rule, ConvertProgramDataToCase (cl;PegaPS-work,
RS:PgpCosmos).
Any implementation layer specific use cases and properties can be added to
extension Data transform provided in this activity.
4. Save as the ConvertProgramDataToCase_EXT data transform provided into
implementation to add additional properties or use cases.
5. Click Actions > Run
As part of this release, four columns are introduced. They are Enable Approval, Projec t
Approver, Time Code Approver, and Team Manager Approver. In release 8.8, the time
entry case was sent for approval to Team manager. After upgrading to latest version, if
existing project instances (created in 8.8) are selected while entering the time, the time
entry case will be automatically approved.
In order to use the functionality as release 8.8 or send time entry cases with old project
details to Team manager approval in latest version, follow the below steps:
1. Login to Pega environment with by entering the administrator ID. For example,
[email protected] and the password that you used during installation.
2. In the header of Dev Studio, click Records > Technical > Activity
3. Search and open the rule, RefactorProjectInstances (cl;PS-TimeMgmt-Data-Project ,
RS:TimeMgmt).
4. Click Actions > Run
Note: Alternatively, we can also manually check the Enable Approval and
Team Manager checkbox for each project instance in Project data type
from App Studio.
Implement
Pega Government Platform™ (PGP) is a low-code solution that allows business and IT
users to collaboratively build with model-based application design, ensuring the
complete solution meets end-user needs. This agile, secure, unified solution gives
agencies a tool for transformation without having to “rip and replace” existing
government systems.
• A low code platform that caters to the citizen developer through easy to re-use
components (UI, flow, user actions, and case types).
• Prerequisites
• Entities
• Features implementation
For information about installing your application, see the product installation guide.
This implementation guide presents tasks in the sequence in which they are commonly
performed; however, the sequence varies based on business priorities. Follow the
procedures in this guide to complete the tasks for the first minimum lovable product
(MLP) release. Also, use this guide during iterative releases as you configure and extend
more features on top of the MLP release.
Prerequisites
Applies to Theme Cosmos. To prepare the implementation environment and to create
your application, complete the following preparation tasks:
Patch releases are available through Pega’s standard software delivery process.
You can request software through Pega Software Distribution or by contacting
GCS.
3. Apply any required hotfixes by using the Hotfix Manager. For more information,
see Applying hotfixes. To review the Pega Government Platform hotfixes, see the
Pega Government Platform Hotfix page.
For more information about each step of the wizard, see Creating an application.
6. On the Name your application page, enter the name of the application, and then
click Advanced configuration.
7. In the Organization settings section, enter the Organization name, Division name,
and Unit name for this application.
The New Application wizard creates the application class structure for you based
on the organization settings that you enter. For more information, see Class layers
and Class hierarchy and inheritance.
If you have not already defined the organization entities (for example, if you have
not already defined the division), type the name of the new entity in the
appropriate field. The application saves the new values when you create the new
application.
Note: For the new application, the organization name cannot be PegaPS.
8. Click Save.
9. Click Create application.
Note: This process creates a set of access groups for the new application
as per your built-on application. Copy the access roles from the built-on
application access groups and add them to the corresponding
implementation access groups. Create your own operators, and then add
the appropriate access groups to operators.
After the implementation layer is created, perform the configurations described in the
following steps. Ensure that you are logged in as a developer.
When Application setup is run, it automatically runs the implementation layer steps
required for the apps built-on Pega Government Platform and it performs the following
actions.
• Overrides all node level data pages which are in the pattern inheritance of PegaPS-
Data-Context class to the implementation layer and sets the access group to the
implementation layer Admin Access Group. For example, if built-on
is PegaGP, PegaPS-Data-Context-Application is the class. If built-on is ICM then it also
considers PegaPS-Data-Context-ICM as well as per pattern inheritance.
• Updates the implementation Application Data class direct inheritance with the
data class of the base application.
Alternatively, teams can perform the above-mentioned steps manually if only a subset
of the steps is required.
Pega Government Platform uses configuration sets in the application to control the
behavior application, minimize the rule overrides and custom rule changes. The
settings are organized into Configuration sets that associate the settings with a
common element, such as an application feature or specific case type.
The following figure shows the configuration sets used for the Pega Government
Platform and Time Management applications:
Configuration sets
You can change the default value of these configuration sets to alter the behavior and
enable or disable any settings.
Help users who rely on screen readers get the information they need to complete
forms in your application. To add field names to error messages, follow these steps:
For example, the system displays an Error: Value cannot be blank message. After you
enable displayFieldNameInValidationMsg, the screen reader output is Error <First name>
cannot be blank.
For more information on steps to enable this setting, see Adding field names to error
message readouts.
Attribute-based access control (ABAC) and role-based access control (RBAC) are two
ways of controlling the authentication process and authorizing users.
The difference between ABAC and RBAC is that ABAC provides access rights based on
user, environment, or resource attributes, for example, a data page on the clipboard,
while RBAC provides access to resources or information based on user roles, such as an
Access Role or Access Role to Object rule. Essentially, RBAC controls broad access
across an organization, while ABAC takes a fine-grain approach.
Pega Platform provides rules that you can use to implement access control by using
values of attributes that are present on the clipboard:
Use the ABAC security feature in Pega Platform to mask sensitive data, such as
personally identifiable information (PII), so that any unauthorized users cannot see it.
In the following examples, the ABAC Access Control Policy rule is used to mask sensitive
data that is stored in Tax ID , Security question and Security answer
properties of an instance of a Person data entity so that an unauthorized user cannot
see the property values:
• A non-administrative end user can add, view, and update the Person entity
instances that they own, but they cannot view sensitive data of instances they do
not own.
• An administrative end user, such as an operator with the manager access role, can
add, view, and update all the sensitive data of any Person entity instances.
• A general case worker can add a new Person entity instances and enter the Tax
ID , Security question , and Security answer values, but they cannot
view or update the sensitive data properties after adding the entity.
Form - A view of your data that displays information or collects input from users
as they create, update, and resolve cases in your application. Open your case type
from the Application Explorer to access the options for configuring a form.
Search person
Update Person
The following content represents the ways to implement the attribute-based access
control.
To implement this example, two Access Control Policy rules were created:
• PropRead .TaxID
• PropRead .QuestionAndAnswers
To allow the grant of custom permissions, two Access Control Policy Condition rules
were created
• ViewTaxID
• ViewQuestionAndAnswers
Implementation teams need to review the new work classes and override
LoadClassContext of the respective application for any modifications or additions.
Similarly, the application level constant values are also updated as per the
implementation values. For any modifications or additions to them as per
implementation teams need to override LoadBusinessContext data transforms.
To integrate this feature in the application, perform the following steps in your
environment. Ensure that you are logged in as a developer.
Pega Government Platform also provides robust foundation to leverage data pages.
Data pages help retrieve data that is stored in any external system required for the
processing of case.
Using data pages separates the interface (i.e., the source of the data) from the data
model in your system. For your implementation, you can leverage data pages and
extend them to your layer. You can then change the data source to load the data from
its system of record using REST, SOAP, and so on.
Entities
Applies to Theme Cosmos. Pega Government Platform (PGP) includes a collection of
common government data structures that you can use to collect and persist data in
your application. Each entity contains a hierarchy of common scalar properties,
embedded page or page list properties, and data instances related by association
(foreign-key relationship).
• Person (PegaPS-Data-Entity-Person)
• Business (PegaPS-Data-Entity-Business)
Each Pega Government Platform entity data class has supporting case types to provide
standardized data management operations on the persistent datastore.
Add
Collect data and persist to database table.
Update
Edit data and persist to database table.
View
Present data that has been read from the database table.
Search
Collect criteria and retrieve matching instances from database table.
• Person entity
• Business entity
• Vehicle entity
• Household entity
• Facility entity
• Item entity
• Entity attachments
• Entity merge
Person entity
Applies to Theme Cosmos. Pega Government Platform(PGP) provides data support to
collect data about people in the form of Person entity.
The Person entity feature contains a persistent datastore and three supporting case
types to manage the Person entity datastore.
The Add Person case type checks for duplicate person entries and notifies about the
same. The case type persists the person record along with the supported data like
Capture a new field in the person intake screen. You can add a new data field or
property and extend the existing person intake screen.
1. In the Person data type, create a field, for example, Spouse Name.
2. Run the Person case type, and then navigate to the PersonBasicInfo view.
3. Click the Add icon, and then add the new field.
Result:
Add a new list item, for example, GrantsList and persist it.
1. In Dev Studio, in the PegaDATA database, create the Grant data type with the
following properties: pyID (Primary key), EntityID, and EntityType.
2. Add other properties that are related to the Grant, such as the grant name, expiry
date, and so on.
3. In the Person data type (PegaPS-Data-Entity-Person), create a field of type page list
of Grant data type class.
4. Update the PersitEmbeddedPage (PegaPS-Data-Entity-Person) activity with a new
step that loops the GrantsList property, and then invoke the activity SaveObject by
passing the EntityID and EntityType parameters similar to CommList.
You can make changes to the person data and submit them. The details persist after
the duplicate validation check ensures that there are no duplicates.
The D_Person data page fetches the entity details along with associated data like
address, communication, and so on.
You can update the existing list properties for the person entity. Fetch the grant details
to update the existing list of grants that are captured as a part of the Add Person
procedure.
Result:
The Update case populates the details and any changes made are persisted.
1. To add the field, navigate to the EntityDetails wrapper section and choose the
appropriate section to show the field, for example, the Entity details section.
Show the captured list, for example, GrantsList details in the person view.
Business entity
Applies to Theme Cosmos. Pega Government Platform provides data support to collect
data about business or organizations in the form of Business Entity.
The Business Entity feature contains a persistent datastore and three supporting case
types to manage the Business Entity datastore.
Add a business case type. Using the PegaPS-Work-Entity-Business-Add case type, you can
introduce a new entity of the type Business into the system.
The Add Business case type checks for duplicate business entries and notifies about the
same. The manager has the options: Approve, On hold, and Reject.
After the manager approves, the business details are persisted along with supported
data like address, communication, profile image, and so on.
Capture a new field in the business intake screen and persist it. You can add a new data
field or property and extend the existing business intake screen.
1. Create a field, for example, Parent Organization, in the business data type.
2. Run the Add Business case type and navigate to the BusinessBasicInfo view.
3. Click the Add icon and add the field created in step 1.
Result:
Add a new list item, for example, SubsidiaryList and persist it.
1. In Dev Studio, to add a new list item, create a data type Subsidiary in the
PegaDATA database and have the following properties pyID (Primary key), EntityID,
and EntityType.
2. Add other properties related to subsidiary like subsidiary name, incorporated
date, and so on.
3. In the Business data type (PegaPS-Data-Entity-Business), create a field.
a. In the Field name box, enter SubsidiaryList.
b. In the Type list, select Embedded data.
c. In the Data object list, select Subsidiary.
d. Click Submit.
5. Create a UI to capture the subsidiary details so that they persist after you enter
the data.
The Business flow supports updating the Business and Branch details as well.
You can make changes to the Business data and submit them. The details persist after
the duplicate validation check ensures that there are no duplicates.
The D_Business data page fetches the entity details along with associated data like
address, communication, and so on.
Fetch the subsidiary details to update the existing list of subsidiaries that are captured
as a part of Add Business. Update an existing list property, for example, SubsidiaryList.
Result:
The Update case populates the details and any changes made are persisted.
1. To add the field, navigate to the Basic details RO wrapper section and choose the
appropriate section to show the field, for example, the Main details RO section.
Show the captured list, for example, SubsidiaryList details in the business view.
Vehicle entity
Applies to Theme Cosmos. Pega Government Platform provides data support to collect
data about vehicles in the form of vehicle entity.
The Vehicle Entity feature contains a persistent datastore and three supporting case
types to manage the Vehicle Entity datastore.
The Add Vehicle case type checks for duplicate vehicle entries based on the Vehicle
Identification Number (VIN) and notifies about the same. The case type persists the
vehicle details along with the supported data like address, owner, profile image, lien
details, and so on.
Capture a new field in the vehicle intake screen and persist it. You can add a new data
field or property and extend the existing vehicle intake screen.
1. Create a field, for example, Purchase Date, in the vehicle data type.
2. Run the Vehicle case type and navigate to the Vehicle details view.
3. Click the Add icon and add the field created in step 1.
Result:
Add a new list item, for example, ServiceHistoryList and persist it.
1. In Dev Studio, to add a new list item, create a data type ServiceHistory in the
PegaDATA database and have the following properties pyID (Primary key), EntityID,
and EntityType.
2. Add other properties related to subsidiary like service center name, service date,
and so on.
3. In the Vehicle data type (PegaPS-Data-Entity-Vehicle), create a field.
a. In the Field name box, enter ServiceHistoryList.
b. In the Type list, select Embedded data.
c. In the Data object list, select ServiceHistory.
d. Click Submit.
5. Create a UI to capture the service history details so that they persist after you
enter the data.
The Update vehicle case type fetches the details of the Vehicle entity that needs to be
updated. You can make changes to the vehicle data and submit them. The details
persist after the duplicate validation check ensures that there are no duplicates.
The D_Vehicle data page fetches the entity details along with associated data like
address, lien, and so on.
Fetch the subsidiary details to update the existing list of subsidiaries that are captured
as a part of Add Vehicle. Update an existing list property, for example,
ServiceHistoryList.
The Details (PegaPS-Data-Entity-Vehicle) wrapper section contains all the vehicle related
views or sections.
1. To add the field, navigate to the Details wrapper section and choose the
appropriate section to show the field, for example, the Vehicle header RO section.
Show the captured list, for example, ServiceHistoryList details in the vehicle view.
Household entity
Applies to Theme Cosmos. Pega Government Platform provides data support to collect
data about households in the form of Household Entity.
The Household Entity feature contains a persistent datastore and three supporting case
types to manage the Household Entity datastore.
Adding a new household is a three step process. In the Household information step, the
basic details like name, type of household, name, description, and start date are
captured. In the next step, address details are captured and in the last step details of
the household members are captured, and then all the details are persisted.
Note: Unlike other Pega Government Platform entities, household does not
have any duplicate validation check.
Capture a new field in the household intake screen and persist it. You can add a new
data field or property and extend the existing household intake screen.
1. Create a field, for example, Is Remote location in the household data type.
2. Run the Household case type and navigate to the Capture household information
view.
3. Click the Add icon and add the field created in step 1.
Result:
Add a new list item, for example, HouseholdItemsList and persist it.
1. In Dev Studio, to add a new list item, create a data type HouseholdItems in the
PegaDATA database and have the following properties pyID (Primary key), EntityID,
and EntityType.
2. Add other properties related to subsidiary like item name, cost, purchased on, and
so on.
3. In the Vehicle data type (PegaPS-Data-Entity-Household), create a field.
a. In the Field name box, enter HouseholdItemsList.
b. In the Type list, select Embedded data.
c. In the Data object list, select HouseholdItem.
d. Click Submit.
5. Create a UI to capture the household item details so that they persist after you
enter the data.
Note: In this case type, you can update only the basic household details, but
not the members of the household. The Manage Members case type supports
updating household members.
The Update household case type fetches the details of the Household entity that needs
to be updated. You can make changes to the household data and submit them. The
details persist after you submit.
The D_Household data page fetches the entity details along with associated data, like
Address.
Fetch the household details to update the list of item details in a household that are
captured as a part of Add Household. Update an existing list property, for example,
HouseholdItemsList.
Result:
The Items list details are available for the user to update in the update case.
When you try to update existing members of a household by adding a new member or
by updating the details of an existing member, the current household becomes inactive
and a new household gets created with active status with the updated list of members.
1. To add the field, navigate to the Details wrapper section to show the field, or
navigate to the Case details section.
Show the captured list, for example, HouseholdItemsList details in the household view.
Facility entity
Applies to Theme Cosmos. Pega Government Platform provides data support to collect
data about facilities in the form of Facility Entity.
The facility Entity feature contains a persistent datastore and three supporting case
types to manage the Facility Entity datastore.
After you add a new facility and successfully submit, the details of the facility are
persisted along with supported data, for example, Address.
Note: Unlike other Pega Government Platform entities, facility does not have
any duplicate validation check.
Capture a new field in the facility intake screen and persist it. You can add a new data
field or property and extend the existing facility intake screen.
1. Create a field, for example, Permission Date in the facility data type.
2. Run the household case type and navigate to the Facility Information view.
3. Click the Add icon and add the field created in step 1.
Result:
Create duplicate check fields and update them with new fields.
5. Create a post processing activity for FacilityOverview (PegaPS-Work) and invoke the
new CheckDuplicate activity as a first step in the activity with the step page
as .Facility and in the second step, send a warning message when the
property value .Facility.IsDuplicate is true.
Add a new list item, for example, InspectionList and persist it.
1. In Dev Studio, to add a new list item, create a data type Service in the PegaDATA
database and have the following properties pyID (Primary key), EntityID, and
EntityType.
2. Add other properties related to inspection like inspected by, inspected on, and so
on.
3. In the Facility data type (PegaPS-Data-Entity-Facility), create a field.
a. In the Field name box, enter InspectionList.
b. In the Type list, select Embedded data.
5. Create a UI to capture the facility details so that they persist after you enter the
data.
The Update facility case type fetches the details of the Facility entity that needs to be
updated. You can make changes to the facility data and submit them. The details
persist after you submit.
The D_Facility data page fetches the entity details along with associated data, like
Address, Communication, and so on.
Fetch the facility details to update the list of item details in a facility that are captured as
a part of Add Facility.
The Details (PegaPS-Data-Entity-Facility) wrapper section contains all the facility related
views or sections.
1. To add the field, navigate to the Details wrapper section and choose the
appropriate section to show the field, for example, the Facility header RO section.
Show the captured list, for example, InspectionList details in the facility view.
Search entities
Applies to Theme Cosmos. Search for information across multiple record types. The
search entities feature returns real-time results in entity data.
You can directly access the search page of an entity from the navigation panel. Each
entity has its own landing page for search. You can build a landing page for an entity
using the associated harness.
The following table shows the list of harnesses for each entity:
The following table shows a list of data pages and report definitions that you can use
for each entity search from the landing pages.
Each harness contains two areas, the header area and the content area. The Content
region holds the section which shows the entities in a grid. The following are the
sections for each entity:
Complete the following steps to introduce new search criteria for an entity:
1. Open the data page and the report definition of the entity.
2. Add the new search criteria as a parameter.
3. Update the filer logic of the report definition with the appropriate relationship.
4. Add the property in the Edit columns list of the report definition.
5. In the section, pass the search text to the newly added parameter of the data
page. If you cannot view the parameter, reselect data page.
6. Add the property as a column to the table in the section.
Item entity
Applies to Theme Cosmos. Pega Government Platform provides data support to collect
data about item in the form of Item Entity.
The Item Entity feature contains a persistent datastore and three supporting case types
to manage the Item Entity datastore.
The Add Item case type checks for duplicate item entries and notifies about the same.
The case type persists the item, record along with the supported data like item values,
subitem details, and item location.
Capture a new field in the item intake screen. You can add a new data field or property
and extend the existing item intake screen.
1. In the Item data type, create a field. For example, Short name.
2. Run the Item case type, and then navigate to the ItemInfo view.
3. Click the Add icon of Short name, and then you can see the field.
Result:
Duplicate check for the item is always enabled. You can enable/disable the duplicate
check from the configuration in App studio. If duplicate check is disabled, On creation
of new item, duplicate check will not be happened and vice versa.
1. Login to Pega Government Platform with admin credentials and switch to App
studio.
Add a new list item, for example, SellerList and persist it.
1. In Dev Studio, in the PegaDATA database, create the SellerList data type with the
following properties: pyID (Primary key), EntityID, and EntityType.
2. Add other properties that are related to the SellerList, such as the Seller name,
decription, and so on.
3. In the Item data type (PegaPS-Data-Entity-Item), create a field of type page list of
SellerList data type class.
4. Update the PersitEmbeddedPage (PegaPS-Data-Entity-Item) activity with a new step
that loops the SellerList property, and then invoke the activity SaveObject by
passing the EntityID and EntityType parameters similar to IdentifierList.
You can make changes to the item data and submit them. The details persist after the
duplicate validation check ensures that there are no duplicates.
The D_Item data page fetches the entity details along with associated data like item
values, subitems, and so on.
You can update the existing list properties for the item entity. Fetch the SellerList details
to update the existing list of SellerList that are captured as a part of the Add Item
procedure.
Result:
The Update case populates the details and any changes made are persisted.
The EntityDetails (PegaPS-Data-Entity-Item) wrapper section contains all the item related
views or sections.
1. To add the field, navigate to the EntityDetails wrapper section and choose the
appropriate section to show the field, for example, the Entity details section.
Show the captured list, for example, SellerList details in the item view.
If you want to create a new item which is similar to the existing item with some minor
changes, then instead of creating a new item and filling up all the details, in a single
click you can copy the details to the new case.
Click Action > Copy from the item screen which you want to copy. A new item case
screen pops up with the item details from which you performed the action.
Entity attachments
Applies to Theme Cosmos. Attach documents to the entity profile. You can view,
download, update, or delete these documents at anytime.
In government applications, various entities hold different documents which you can
view or refer in other cases. For example, a Person entity can have a passport, a birth
certificate, and so on, attached to their profile. If required, you can refer these
attachments in the license case.
• Entity attachments offers support for entities like person, business, facility,
vehicle, and household.
• When you add a new attachment, PGP creates a new document case (CL:
PegaSocial-Document) .
• The AttachmentRefID property of the entity is set as the parent instance handle key
of the document case. Using AttachmentRefID, the entity view screen displays the
attachments of an entity.
Hold documents for the entities of a new entity type in the implementation layer.
2. Before persisting the entity, set the AttachmentRefID property. Set this property in
step 3 of the PrepareObject (CL:PegaPS-Data-Entity) data transform.
Note: If this setting is not getting called for your new entity, then before
persisting, set the AttachmentRefID property to
‘ @toUpperCase(.pxObjClass)+" "+.EntityID ‘
3. Similarly, during the fetching of entity details, set the AttachmentRefID. In the data
transform of the new entity's lookup datapage, set AttachmentRefID to
‘ @toUpperCase(.pxObjClass)+" "+.EntityID ‘. Refer FetchPersonDetails (CL:PegaPS-
Data-Entity-Person) step 2.
The following are some of the features of entity history and field audit:
• The history of an entity shows details such as by whom and when it is updated/
added and the case where this action is performed.
• Field Audit of an entity shows previous values and current values of a property
along with time and user.
For example, the following images show the history and field audit of a person entity.
Entity history
Field audit
The next step is to create a report definition for history in entity history-data class, save
as PersonHistory(CL:History-PegaPS-Data-Entity-Person), and add the report to
D_EntityHistory” data page as a source.
Similarly, create a report definition for field audit in entity history-data class, save as
PersonFieldAudit (CL:History-PegaPS-Data-Entity-Person), and add the report to
D_EntityFieldAudit data page as a source.
For field auditing, create a declare trigger on data-class of the entity, set Trigger when
an instance is dropdown to Saved. Under Trigger activity, set Name to
TrackSecurityChanges and set Execute dropdown to immediately. And create
pyTrackSecurityChanges data transform with data-class of the entity and add fields to
audit.
Applies to Theme Cosmos. For example, to audit a new field, say .EyeColor, for Person
Entity open pyTrackSecurityChanges (CL:PegaPS-Data-Entity-Person) data transform and
add .EyeColor in target, add label for EyeColor in source.
To audit page list property fields like country in Addresslist (Page list Property), follow
the image.
Field audit
Entity merge
Applies to Theme Cosmos. Entity merge in Pega Government Platform allows you to
merge two or more entities into a single entity which acts as a master.
Architecture
• Configuring Scalar and List merge attributes (Properties) in the design time.
Merge attributes can be configured from App Studio by navigating to the PGP > Merge
entities landing page.
Merge Entities
In the Merge entities case type, user can select only one of the values for scalar
attributes from of the selected entities to be the value of the master entity record.
For list attributes, Users can select any record to be part of the master entity without
any restriction.
To support merging of an entity, 2 properties are added to the entity data model and
corresponding columns are also added to the respective entity database table.
For example, let’s assume below are the entities before merge
PERSON-1 -- --
PERSON-2 -- --
Now user selects PERSON-1 as a master entity and wants to merge PERSON-2 into
PERSON-1, up on completion, the entities will have the following data to the above
mentioned two properties.
PERSON-1 Active --
Along with the above values to support the unmerge functionality, the Master entity
would have the details that it possesses before the merge in the Snapshot (PegaPS-
Data-Snapshot) embedded page of the entity.
The design of merging the list items like Address has a different way of handling the
merge compared to merging of entities.
For handling the merge of list items 2 properties are introduced to the data model.
◦ Active: Used to activate the list items that are selected from the master
items.
• RefID
For example, let us assume below are the addresses of the entities in the system.
In the above scenario, one address from each entity is selected by the user and below
are the address details after the merge.
Below is the explanation for each address how its handled in the above scenario.
1. Address-1: This originally belongs to master entity and it has been selected by the
user, so the status is set to Active.
2. Address-2: This originally belongs to master entity and it has not been selected by
the user, so the status is set to MasterInactive (this is not shown in master profile
going forward)
3. Address-3: This originally belongs to duplicate entity, so the status is set to
Inactive.
4. Address-4: This originally belongs to duplicate entity, so the status is set to
Inactive.
5. Address-5: This is a new address added to master by cloning the Address-3 which
is a selected address from the duplicate entity and the status is set to Active. The
RefID property is set to the value Address-3 to indicate that it is cloned from
Address-3.
The key concept is all the selected list items from the duplicate are cloned with new ID’s
and added to the master.
• Development steps
• Rule inventory
processes. The PGP entities are persistent data classes that come pre-configured as a
part of PGP.
• Person
• Business
• Vehicle
• Facility
• Household
1. Entity instances are persisted to a data store like any local data type or data table
2. Entity data classes are used as a type for embedded pages defined on the PGP
work ancestor to support case processing
Applies to Theme Cosmos. An entity data class (Data- class) is managed (curated) in an
independent data store (database table) by the Add, Update, View and Search case types
(Work- classes).
Applies to Theme Cosmos. An entity data class is also used as a type for embedded
pages incorporated into the PGP work ancestor. These embedded pages are used by
the PGP component processes to implement PGP features.
PGP Entities follow a pattern of Persistent Data curated by Business Processes. This
pattern allows for the possibility that in a customer implementation the entity
datastore may be mapped to customer resource that is external to Pega and PGP. In
this pattern a persistent datastore descended from PegaPS-Data-Entity is added,
updated, viewed, and searched by Case Types descended from PegaPS-Work-Entity.
PGPImp-DemoPGP-Data-Entity-Item
• PGPImp-DemoPGP-Work-Entity-Item-Add
• PGPImp-DemoPGP-Work-Entity-Item-View
• PGPImp-DemoPGP-Work-Entity-Item-Search
• PGPImp-DemoPGP-Work-Entity-Item-Update
• Catalog the new Entity’s rules in Relevant Records so they will appear in the App
Studio smart prompts
• Configure whether case types will appear on +Create nav
Development steps
Applies to Theme Cosmos. While it is possible to do some of this work in App Studio,
the approach discussed here is based on a Dev Studio experience. App Studio hides
some development details, like class names and rulesets, in order to present a
development environment that can focus on case types and business processes, but for
this exercise we need full control over those details.
Applies to Theme Cosmos. Create a persistent data type and supporting rules for the
new entity.
Add an abstract data class to the implementation layer to leverage the Enterprise Class
Structure pattern and provide extension points for reusable rules common to the Entity
implementation layer data types.
1. Use Data types > Data types > Add data type wizard to create the new Item data
type and supporting rules.
a. Set the Label as Item
b. Add an appropriate Description for the class
c. Under Advanced set the parent class to PGPImp-DemoPGP-Data-Entity
d. Submit to create the new Item data type
2. Configure the Item data type
a. Use the Data model tab, add properties to the Item data type
1. EntityID of type Text
2. pyID of type Text
3. Add additional properties as needed
b. Under the Sources tab Create a local source
c. Select pyID as the Key (Use as key)
d. Submit to create a local source for the Item data type
Build the basic data layer UI rules to present the data of the new Item data type.
Applies to Theme Cosmos. Add a Page property to the implementation layer work
ancestor of type PGPImp-DemoPGP-Data-Entity-Item to hold an Item instance during case
management processes. Create a new Page property .Item of type PGPImp-DemoPGP-
Data-Entity-Item with Applies-To PGPImp-DemoPGP-Work.
1. Use Create > Data Model > Property to add a new property
a. For the Label use Item
b. For the Apply to use PGPImp-DemoPGP-Work
c. Create and open
d. Change the Property type to Single Page
e. Select PGPImp-DemoPGP-Data-Entity-Item as the Page definition
f. Save the rule.
Applies to Theme Cosmos. Switch to App Explorer (App) and show PGPImp-DemoPGP-
Data-Entity-Item. Review all the rules created for the Item data entity.
Applies to Theme Cosmos. When a new implementation layer is generated by the New
Application Wizard it only creates descendants for the selected concrete classes.
Manually add the missing abstract work classes to leverage the Enterprise Class
Structure pattern and provide extension points for reusable rules common to the Entity
and Item implementation layer work types.
Choose the case type name carefully as it will be used to form the work class name for
the case type. After the case type has been created, you may choose to change the
pyLabel for the case type rule to something more specific.
The lists of ancestor classes to choose from may not show recently added abstract
classes unless you have logged out since they were added or otherwise reset the cache.
In PGP the Add case type for Entities collects data from the operator in a Page
embedded on the work class. At an appropriate step in the case life cycle a PGP Persist
component is placed which writes out the data from the embedded page on the work
to a persistent data class using the persistence configuration from the Database Table
rule for the embedded page’s class.
1. Use Case types -> +Add a case type to create a new case type named Add (plan to
change the label for the case type rule later)
a. Expand the Advanced section and specify the ancestry
In PGP the Update case type for Entities solicits changes to the entity data from the
operator and captures these changes in a Page or Page List embedded on the work
class. At an appropriate step in the case life cycle a PGP Persist component is placed
which writes out the data from the embedded page on the work to a persistent data
class using the persistence configuration from the Database Table rule for the
embedded page’s class.
1. Use Case types > +Add a case type to create a new case type named Update (plan
to change the label for the case type rule later)
a. Expand the Advanced section and specify the ancestry
1. Use PGPImp-DemoPGP-Work-Entity-Item as the directed ancestor
2. Use PGPImp-DemoPGP-Work-Entity-Item as the patterned ancestor
2. Create a Workflow for the case type
3. In the default Create stage
a. Use +STEP to add a Collect Information step under the Create stage
b. Name the step Edit Item Details
c. From the step parameters panel (right) click Configure the View
1. In the View Configuration add the Item field as a field group
2. Select ItemDetail from the View dropdown to use it as the View for the
Item field group
4. Use +STAGE to add a new stage named Review
a. Use +STEP to add a Collection Information step under the Review stage
named Review Item Details
b. From the step parameters panel (right) click Configure the View
1. In the View Configuration add the Item field as a field group
2. Select ItemDetailRO from the View dropdown to use it as the View for
the Item field group
c. Use +STEP > …More > Processes and select Persist object
d. From the step parameters panel (right) configure the Persist object
component
1. For Type use Entity
2. For Property use “.Item” (double quotes are significant)
5. Change the case type rule label for PGPImp-DemoPGP-Work-Entity-Item-Update
from Update to Update item
6. Save the case
7. Edit the pyDefault data transform rule for the Update work type to set the initial
values on the .Item page from lookup data page
a. Edit the pyDefault data transform rule for the Update work type to set the
initial values on the .Item page from lookup data page
b. Add a Set action to the transform definition
1. Use .Item as the Target
2. Use D_Item[pyID:Param.EntityID] as the Source
c. Save the data transform
In PGP the View case type for Entities shows a comprehensive snapshot of an entity
instance’s data.
In PGP the Search case type collects filter criteria from the user and retrieves a list of
matching entities which may then be selected for further processing.
Rule inventory
Applies to Theme Cosmos. The following is a list of rules created in this exercise.
Work-Entity-
Item-Add
• Initiate event
• Interview case
• Evidence case
• Manage associations
• Application request
• Program finder
Initiate event
Applies to Theme Cosmos. Intake specialists can initiate an event in the application, can
perform and track actions. You can also initiate an event from the context of person
entity and that event will get associate to the person.
Intitiate event
In order to use the event case in implementation layer, save as the D_Event data page
in the implementation layer and update the lookup with the implementation class
name in the source.
Applies to Theme Cosmos. When adding an event to the system, to add a field to be
captured on the event details capture screen, complete the following steps.
Applies to Theme Cosmos. By default, when creating an event, one address is captured.
Applies to Theme Cosmos. By default, the event review screen displays the following
review actions in ICM application: open an investigation, Associate to an existing
investigation, Need additional information, Issue warning, No Action-Invalid event, and
No Action-Duplicate event. And in Pega government platform application, review screen
displays the following review actions: Approve, Reject and Return.
To add a new review action for an event, complete the following steps.
View event
Applies to Theme Cosmos. Pega Government Platform and Investigative Case
Management users can view events and their associated data.
Extend the Event view page and display other properties of an event.
1. Define the new property in PegaPS-Data-Event, if the new property does not exist.
Search event
Use Search event to search the events in the system based on their basic information.
Search for events by using inputs such as Name, Event ID, Report type, State, and City.
Add a field to the search criteria for the Search event function.
1. Open the SearchEventTable (PegaPS-Data-Portal) section, and then add the required
field to the section.
2. Add a parameter to the D_SearchEventList data page and pass the value of the
search text to this parameter in the above section.
3. To filter the records based on this field, add the parameter to the SearchEventList
report definition, and add the parameter in the filter conditions.
To add a field to the search results for the Search event function, complete the
following steps.
1. Add the required property to the columns space of the EventDetails report
definition to retrieve it from the database.
2. Add the new column to the repeating grid in the SearchResults (PegaPS-Data-Event)
section and refer to this new field.
f. Update the service class to the Event initiate class of the implementation
application, for example, PegaPS-ICMImpl-Work-Event-Initiate.
g. Save as the service method CreatepyStartCase in the email listener to the
implementation layer ruleset. Change the primary page class to the
implementation layer's request access class, for example, PegaPS-ICMImpl-
Work-Event-Initiate.
h. Update the requestor login section of email listener with the operator that
you created earlier.
i. Save the email listener.
4. Add the email listener.
a. Open Admin Studio.
b. Click Resources, then click Listeners.
c. In the Start/restart listener menu, select the listener that was created in the
previous step and click Apply.
d. Refresh the Active listeners section.
Result:
The following list details some of the features of Investigative Case Management:
• Investigation case
• Subject
Investigation case
Applies to Theme Cosmos. An Investigation Case Management user can create a
standalone investigation case.
To use the Investigation case in the implementation layer, save as the D_Investigation
data page in the implementation layer and update the lookup with the implementation
class name in the source.
When conducting an investigation, you must capture a certain number of details about
the case.
Assume that you need to capture one more field when adding an investigation to the
system. To add a field, complete the following steps:
Viewing an investigation
The case view shows the relevant information about the investigation in different tabs.
You can search the investigations in the system by using basic information such as date
range, investigation ID, category, and so on.
f. Update the service class to the Request access class of the implementation
application, for example, PegaPS-ICMImpl-Work-ICM-Investigation-Initiate.
Subject
Applies to Theme Cosmos. Pega Government Platform (PGP) enables users to create
subjects of type Person and Business. Users can associate subjects to their
microjourneys like Investigation, for streamlined and efficient case management.
To capture more details when adding a subject to the system, complete the following
steps.
a. Add the new entity type as a record in the option map and set the Field name/
Group value as EntityType.
b. Save as the SetICMEntityClass data transform in the implementation layer.
c. Create a when rule, for example, IsPerson, and add another step for the new
entity.
d. Update the .ICMEntity page to update the class with the new entity class name.
e. Save as the ICMEntityDetails (PegaPS-Data-ICM-Entity) section to the entity class and
update it with the properties that need to be captured when creating the subject.
f. Open the NewSubject (PegaPS-Data-Entity) section and click the Save as button.
g. Save to the entity class and update it with the properties that you need to be
capture when creating a new subject.
h. Update the Identification (PegaPS-Work-ICM-Subject-Initiate) section by adding the
SearchKnownSubject section with the new entity page context.
i. Open the SearchEntityCriteria and SelectKnownSubject (PegaPS-Data-Entity) sections
and click the Save as button.
j. For implementing the select existing feature, save the sections to the entity class.
View a subject
An Investigative Case Management user can view a list of subjects in the investigation
case under Subjects.
An Investigative Case Management user can view a list of subjects in the investigation
case under Subjects.
You can search for a subject in the system by using basic information such as Subject
ID, Type, Role, and so on.
To add a field in the search results for a subject, complete the following steps.
Interview case
Applies to Theme Cosmos. An Investigative Case Management user can conduct an
interview for an investigation case or for a subject case by creating an interview directly
from the investigation or subject.
Edit an interview by using the Edit interview feature, which you can use to add another
participant, update the values that are captured, and so on.
When conducting an interview for an investigation case or for a subject, you must
capture a certain number of details about the case or subject.
Assume that you need to capture one more field when adding an interview to the
system. To add a field, complete the following steps:
Viewing an interview
An Investigative Case Management user can view an interview and the associated data
that was collected during the interview.
The Interview case type can be extended to any other cases by completing the following
steps.
Evidence case
Applies to Theme Cosmos. As an Investigative Case Management user, add evidence for
an investigation case by creating an evidence case directly from the investigation.
The Evidence case type can be extended to any other cases by completing the following
steps.
An Investigation Case Management user can capture the item details from the evidence
case.
In evidence, only basic details of the item are captured using the Manage basic item
component. In this component, item details are captured in a single screen. If you need
to capture the full item details in a screen flow, then Manage Item component can be
used.
To capture the item from evidence, Select the Capture Item check box in the first screen
of evidence case and then item details will be captured in the next screen.
The details of the item captured will be displayed in the separate tab called Item in the
evidence case. Also in the investigation case, under evidence tab, you can see the item
in the separate column.
Configure the item basic details component in App Studio to use in a case type, as a
step or an optional process, in a stage. You can use the item basic details component in
case types that capture basic data related to the item.
5. In the Case life cycle section, click Stage and enter a name for the stage in the text
box.
6. Hover over Process, and then click Step > More > Process > Manage basic item.
7. Click Select.
1. In the Dev Studio Explorer panel, click App. In the search field, enter PegaPS-
Data-Evidence.
2. Right-click the class and create a property for the information that you want to
add, for example, Complaints.
3. Include the new property in the section.
a. In the Application Explorer, find the PegaPS-Data-Evidence class.
b. Click User Interface > Section > EvidenceInfo.
c. Add the new property in the section.
4. Include the new property in the EvidenceRO section of the PegaPS-Data-Evidence
class by repeating step 3.
Viewing evidence
An Investigative Case Management user can view evidence and the associated data that
was collected for the evidence.
Manage associations
Applies to Theme Cosmos. Use the Manage associations case to create or delete
associations between entity types, such as Person, Business, Vehicle, Item, or Facility.
You can launch the Associations case from User Portal by performing either of the
following actions:
All associations are saved to and are retrieved from the Link database table (PegaPS-
Data-Link). When associations are modified, the Link database table is also updated
accordingly. The LinkedFromID is the primary ID from where the association is created
for the first time. The LinkedToID is the ID to which the association is mapped.
• When Manage associations case is launched from the Entity view screen, the
EntityID is the preset.
• When Manage associations case is launched from the User portal by using
the Associations link on the Create menu, select Manage associations for field.
Association validations
There are certain validations in place for the associations that you can create by using
the Associations case.
• You can add a new person, vehicle, or facility to your system when you create an
association but you cannot create a business, as creating this entity involves a
review process.
• You can associate an entity or case with another entity type or case type, including
its own type. For example, you can associate a person (Person-1) with another
person (Person-2). You can also associate a person (Person-1) with a business
(Business-1).
• You can associate an entity or case with another entity or a case more than once
with the same role. However, it cannot have a similar association within the same
time period. For example, you can associate a person (Person-1) with another
person (Person-2) with role as “Driver” multiple times, but with a different time
period.
For all associations, the context from where the association is created for the first
time is important for displaying the relationship or role of the association. For
example, when you create an association with a person (Person-1) and a business
(Business-1) as "Employer," then in the context of Business-1, Person-1 has an
association with Business-1 as an "Employee."
If there is a requirement to capture a new data element, such as the association place,
in addition to the relationship and the time period of the association, then complete
the following steps.
The Manage associations case supports all five existing entity types, Person, Business,
Facility, Vehicle, and Item in PGP and Investigation, Event, and Subject case types in ICM.
If there is a requirement to include a new entity type (for example, Land) that was
created in an application, then complete the following steps. Note: This example uses
"Land" as the new entity type. The entity should be replaced whereever applicable with
the new entity type that you are adding.
Auditing an association
Pega Government Platform provides support to Audit History for all the modifications
done as part of an Association case. Below are the scenarios where case history is
updated for Association case.
For example, to add audit history for the new field 'Place', open the
PropertiesToCompare data transform and add another step to set the new field 'Place'.
Extending Associations
Applies to Theme Cosmos. Follow these steps to create new associations from a case
type:
• Use PersistLink flow from PGP to create new association from any case type.
• To add multiple associations in a case type, SaveLink activity can be used to loop
through the list to create new associations.
For example, we have created a new Inspection case type in implementation layer and
we want to capture the business details and associate the business to inspection case.
Implementation steps:
1. Add PersistLink flow as a step in the case type to associate the business to
inspection case. This can be added from both Dev studio and App studio.
2. Provide all the required parameters such as association FromClass, ToClass,
FromID, ToID, LinkType, and so on.
Entity details
3. After creating the inspection case and capturing business details, now we can see
the association details in the Association widget.
To add multiple associations, SaveLink activity can be used to loop through the list
to create new associations.
This can be implemented as shown in the below screenshots which references the
investigation case use case to add multiple external organizations.
Let’s say Inspection is a new case type created in implementation layer and we would
like to extend the associations for this and display all the associations available for the
case type.
Implementation steps:
Extending associations
To extend visualization for a new case type and display the custom image for case type
and label in the visualization, follow the below implementation steps.
3. Once the above snippets are added, we can see the image and label in association
visualization.
Visualize
Association visualization
Let’s say Asset is a new Entity created in implementation layer and we would like to
extend the associations for this and display all the associations available.
To introduce a new entity, follow the steps mentioned in Creating new entities.
The following are the implementation classes for Asset entity created in
implementation layer:
Work classes -
• PGPGov-PGPImpl-Work-Entity-Asset-Add
• PGPGov-PGPImpl-Work-Entity-Asset-View
• PGPGov-PGPImpl-Work-Entity-Asset-Update
Cell properties
Extend associations
7. Once the Asset entity is created and associated, you can see the association
widget in the utility panel with the association details. In this example, we are
associating Asset entity with Item entity.
8. In the association details in association widget and visualization, currently Entity
ID of the new entity will be displayed.
9. Extend D_Entity data page in the implementation layer and add the respective
sources to fetch the Asset entity details. Refer Item entity implementation and
follow the similar approach for Asset. Create all the report definitions and data
transforms as required.
Asset entity
To extend visualization for a new entity and display the custom image for entity and
label in the visualization, follow the below implementation steps.
Extending visualization
4. Once the above code is added, we can see the image and label in association
visualization.
Visualization
Application request
Applies to Theme Cosmos. The application request case type enables you to apply for a
program or any of its descendants, for example, a license. Using application request,
you can bring all the services of your organization under one case type.
The application request case type allows business users to streamline application
processes, such as capturing entity details, project details, document intake, consent
agreement, and so on from start to finish. The business managers can review and
approve the attached or uploaded documents, review the checklist, evaluate the
process, and approve the application.
Users can select a license/program and review basic details, such as name, description,
applicable for, category, subcategory, and so on including documents required and
apply for the same. This feature is applicable for all the entities except household when
selected through Application request. After a user applies for a license or program it is
sent for review.
Application request
Programs tab
Program finder
Applies to Theme Cosmos. In Pega Government Platform™, Program finder is a
questionnaire case type which can be used as prescreening for the programs. This
prescreening would help users in identifying the eligible programs and licenses they
can apply for.
Program finder case in Pega Government Platform™ comes with set of sample
questions, based on the responses provided to the questions, system displays the list
of programs and licenses that user is eligible. Users can select from the eligible
programs and apply for the same.
Technical description
The following work class is used for Program finder case type in PGP.
PegaPS-Work-ProgramFinder
Extensions
To extend this, save as this rule into implementation layer and add the conditions to
decision table as per the requirement.
Decision table
Program finder questionnaire case type can also be customized and extended as per
the requirement by adding additional questions and mapping the response fields. If
required, the additional question related criteria should be added to the decision table
as conditions to fetch the results.
The Pega Government Platform (PGP) Option map is a pattern for supplying
customizable, configurable data collections to Pega Picker user interface selection
controls like pxAutoComplete and pxDropdown list.
Education Autocomplete
• Instances can be managed from App Studio using the Data Type Record Editor in
support of the low-code/no-code developer.
• Value display order can be explicitly controlled (not just alphabetical).
• The solution scales from a few instances to thousands of instances.
• The solution is localizable.
• The data instances are supplied by a parameterized data page can be used as a
source in many data driven use cases.
• The data page is loaded by a data transform that may be customized in an
implementation layer.
Architecture
• A Pega local data type that holds the collections of name-value pairs grouped by
field name group.
• An interface to manage the OptionMap data instances.
• A data page to retrieve collections of name-value pairs based on parameters.
The OptionMap data type is created under Pega's local Data Type Wizard and can fully
leverage the App Studio Data Designer for instance management and record editing.
The D_OptionMapList is a Requestor scoped data page that takes two parameters.
Utilize the option map data in a Pega UI picker control. Configure list source to call the
D_OptionMapList data page passing parameters to identify the field name or group that
identifies the collection instances to be loaded.
Features implementation
Applies to Theme Cosmos. Implement and extend the features of Pega Government
Platform (PGP) to meet your business needs.
Dashboard
Applies to Theme Cosmos. The dashboard in the portals provides users with a diverse
set of reports based on application and their access group.
Reports on investigation
• Investigation by status: The pie chart represents the number of investigations for
a status.
• To make changes, open “InvestigationByStatus”(CL:PegaPS-Work-ICM-Investigation)
section and “InvestigationByStatus” (CL: PegaPS-Work-ICM-Investigation) report
definition.
Reports on event
• Events by top 100 locations: The following is a column chart representing top 10
states which have most events with all statuses except “resolved-Cancelled”.
Events with no address information are excluded.
Events Report
• Event by Status: The following is a pie chart representing event cases against their
status.
Users logging into PGPCosmos and ICMComos applications have reports on application
requests in dashboard.
• Application Request by Status: The following Bar graph represents the count of
applications based on their status.
• Recent certificates issued: The following line graphs show different certificates
approved in the last seven days.
This chart provides the information on cases within the given range of distance.
Easily add new reports or charts to your dashboard or edit chart labels with our simple
step-by-step guide.
Add report/chart
1. Open the section with live UI and open the chart cell properties.
2. To change the Title go to General tab, under chart section click Edit Title.
3. To change axis labels, go to Axis tab and change Axis Label.
1. Open D_SearchProgramList data page, in Data Sources open all the reports
included as source.
2. In query tab of each report, add field as a column to display in the results.
3. Open “"SearchProgramTable"(CL:PegaPS) section, Add a column to the table and
include the field.
Review checklist
Applies to Theme Cosmos. Review checklist is a reusable and generic component for a
process through which an evaluator or manager can review the application progress
based on various checklist items.
You can use review checklist in various intake applications of government business use
cases, like grants application, issuance of certificates, license and permits, where a
caseworker and manager need to complete different sets of checklist items.
You can add a review checklist as a component from App Studio and you can configure
the list for various use cases. Using the parameters of the component, you can choose
a list to display in a case.
1. Configure a Checklist type that you can select to populate a Review Checklist. A
Checklist type provides the checklist item rows that the checklist contains.
2. Add the review checklist process component, to a step, in a stage of your case
type.
Add a new checklist type with checklist items or update an existing checklist.
You can add a review checklist component in a case lifecycle as a step to introduce a
process through which an evaluator or supervisor can review various to-do tasks that
need to be completed as part of any application or case lifecycle.
Configure the review checklist component in App Studio to use in a case type, as a step,
in any of the stages.
Checklist config is a section component that can be used in any case type to configure it
in runtime. Furthermore, required validations and persist feature are provided as
reusable components that can be used to save or validate multiple configurations
simultaneously.
• Create new: User can either create a new Checklist from scratch or modify an
existing Checklist set.
• None: Users can choose not to configure a Checklist set for their use case.
Technical description
This component provides basic validations such as validating if checklist is empty and
Duplicate check for checklist. The system will throw validation errors if the checklist is
empty and if we try to create a duplicate checklist.
• IsChecklistEmpty
• IsChecklistDuplicate
• ValidateChecklistConfig
The Persist configuration flow component can be used to persist the configurations
created. This component allows multiple types of configurations to be saved
simultaneously.
This component can be used in any case type as a step in any of the stages or as a view.
Make use of the Validation rules and persist configuration component provided.
1. Invoke Checklist component as a view and add validation. Using the persist
component, you can persist case data.
a. Click Configure view, search for Checklist config in existing views and add it
to form (as shown in the following image).
Checklist config
2. To Persist data using persist component, click + STEP > More. Search for Persist
configurations processes and click Select to add it as a step. Select Persist
Checklist set checkbox.
Persist checklist
Persist configurations
Configure view
Duplicate entry
Validation criteria
Follow these steps to add a new Checklist configuration as a step or view for one of the
case types.
Below are the extension data transforms to add additional parameters or to set
additional configuration properties to case type. Extend them in implementation layer
for any customization.
Consent agreement
Applies to Theme Cosmos. The Consent Agreement component displays an actionable
consent agreement screen. The consent agreement screen contains the text stating the
agreement clauses, a check box to agree, and a field to enter signature.
Government agencies can have various agreements, and terms and conditions that the
constituents or the end users need to agree for various business use cases.
For example, for any contract award or for any grant application from the government,
there must be an agreement between both the parties which is signed and agreed
upon. The text and content must be different for different applications.
Use the Consent Agreement process component in a case type as a step in any of the
stages. Consent Agreement is a built-in dynamic PGP component that allows e-
signatures and templates.
Result:
Based on the business use case need, you can select the appropriate text
template from the available templates and can include an e-signature.
This section component can be used in any case type as a step in any of the stages or
as a view.
Extensions
To set additional configuration properties to case type, use the following extension data
transform. Extend it in implementation layer for any customization.
Note: To create new consent agreement templates, you must switch to Dev
Studio.
5. In the Display and validation section, in the Prompt values area, create a new
paragraph rule by clicking the Add a row icon.
6. In the Standard value box, enter a value, for example,
CentralAgreementTemplate.
7. In the Prompt value box, enter or select the desired value.
8. Click Save.
9. In the navigation panel of Dev Studio, click Data types.
10. Click Option map.
11. On the Records tab, click Add record.
12. Enter the appropriate text for the ID, Code, Display value, Display order, and Field
name / Group fields.
Result:
After you refresh the D_PGPOptionMapList and D_OptionMapList data pages, the
new consent agreement template is displayed in the Consent agreement
template list.
Document intake
Applies to Theme Cosmos. Document intake enables you to attach the required
documents for a particular category.
• Configure a document.
• Create a new document category or use an existing category.
• Add specific documents to a category.
• Configure other details such as, mandatory document, optional document, and so
on.
For various applications, depending on the norms and policies, different set of
documents need to be uploaded as a part of any case. To achieve different set of
requirements for different applications, you can use this component and configure it
accordingly.
Applies to Theme Cosmos. Use the Document intake process component in a case type
as a step in any of the stages.
4. From the Case types column, click a case type, or click the New button to create a
new case type.
5. In the Case life cycle section, click Stage, and then enter a name in the text box.
6. Hover over process, and then click +STEP > More > Processes > Document intake.
7. Click the Select button.
8. In the Document details section, in the Source list, select a source.
a. Select By name, and in the Purpose list, select a document from the list of
required documents.
b. Alternatively, select By property to specify a property on the work class that
supplies a specific document at run-time.
9. In the Routing details area, select an operator:
• To route the assignment to the current operator, click Current operator.
• To specify a user or operator to whom you want to route this assignment,
click Specific user, and then, in the User field, select a user or enter a
property in the work class that supplies a specific operator ID at run time.
• To route the assignment to a specific work queue, click Work queue, and
then, in the Queue field, select a work queue name or enter a property in the
work class that supplies a specific work queue at run time.
10. Click Save.
11. Click the Views tab, and then click Create new view.
a. In the Search box, enter Intaken documents, and then click the Add to
view icon.
b. In the Options list, select Read-only.
12. Click Submit.
Applies to Theme Cosmos. Add a new document purpose with a list of documents.
For different applications, you may have to upload unique sets of documents. Using
App Studio, you can edit an existing purpose and a list of documents, or add a new
purpose and the corresponding list of documents.
User can configure the document sub-configuration in any run time case as follows:
• Create new: User can either create a new document from scratch or modify an
existing document set.
• None: Users can choose not to configure a document set for their use case.
Applies to Theme Cosmos. This component can be used in any case type as a step in
any of the stages or as a view. Make use of validation rules and persist configuration
component provided.
1. Invoke Document component as a view and add validation. Using the persist
component, you can persist case data.
a. Click Configure view, search for Document config in existing views and add it
to form.
Document configurations
2. To Persist Data using persist component, click + Step > More. Search for Persist
configurations processes and click Select to add it as step. Select Persist
document set checkbox.
Persist configurations
a. Navigate to configure view of step, switch to Validations tab and search for
IsDocumentSetListEmpty to validate the empty config list . (Select if needed)
Validation criteria
Document configuration added as step or view for one of the case type.
Extensions
Below are the extension data transforms to add additional parameters or to set
additional configuration properties to case type. Extend them in implementation layer
for any customization.
Verify document
Applies to Theme Cosmos. The verify document component enables users to view the
list of uploaded documents and take approval decision. You can configure a rejection
action as a part of the document verification.
Users can opt to approve or reject each document with comments and configure
rejection stage to route only the rejected documents.
Verify document
Applies to Theme Cosmos. Configure routing details like the operator, stage, and so on
based on approval decision. You can use Verify document process component in a case
type as a step in any of the stages.
Applies to Theme Cosmos. Add more document review options in addition to the
existing options.
7. Update the VerifyDocument flow to handle the newly added Pending action.
8. Click Save.
Result:
After you refresh the D_PGPOptionMapList and D_OptionMapList data pages, the
newly added record appears in the UI.
Nearby locations
Applies to Theme Cosmos. The Nearby locations process enables you to view important
nearby places such as hospitals, schools, and so on that are supported by Google's
Near Me service. You can also view the nearby cases and entities that are already in the
application.
For example, if there is an application for school license, any reviewer can use this
component to see if there are any bars or liquor stores in the nearby area and take the
approval decision based on that. Also, for any investigation case for multiple events
reported, the field investigators can use this component to check the event case in the
nearby area.
Use the Nearby locations process component in a case type as a step in any of the
stages. You can configure the base location for searching nearby cases, entities, or
places either with the current location, or using a property reference.
5. In the Case life cycle section, click Stage, and then enter a name in the text box.
6. Hover over process, and then click +STEP > More > Processes > Nearby locations.
7. Click the Select button.
8. In the Location details section, in the Source list, select Current location to
configure the current location as the base location for searching nearby cases,
entities, or places.
9. Alternatively, select By property reference, and then enter or select a property
from the combo box.
10. Select the Enable nearby result selection check box to select the nearby search
results for further processing in the next steps or stages.
11. In the Routing details area, select an operator:
• To route the assignment to the current operator, click Current operator.
• To specify a user or operator to whom you want to route this assignment,
click Specific user, and then, in the User field, select a user or enter a
property in the work class that supplies a specific operator ID at run time.
• To route the assignment to a specific work queue, click Work queue, and
then, in the Queue field, select a work queue name or enter a property in the
work class that supplies a specific work queue at run time.
12. Click Save.
13. To show a list of selected nearby places, click the Views tab, and then click Create
new view.
a. In the Search box, enter Selected nearby places, and then click the Add
to view icon.
14. To show a list of selected nearby cases or entities, Views tab, and then click Create
new view.
a. In the Search box, enter Selected nearby cases and entities, and
then click the Add to view icon.
15. Click Submit.
Extend the Nearby locations component depending on the business use case and
requirement.
Add a new entity apart from the PGP-provided entities, as a part of nearby entity
search, in the Nearby locations component.
For example, the AddressList property contains the addresses of a person. While saving
the person details, the PersistEmbeddedPage activity (CL:PegaPS-Data-Entity-Person) runs
which has the logic to save AddressList in PegaPS-Data-Address table.
Show new entity as one of the type in nearby cases and entities
Evaluate
Applies to Theme Cosmos. The Evaluate process performs the evaluation of a case type
based on the evaluation criteria.
Evaluate provides an option to select evaluation type and routing type. Based on
selected evaluation type, evaluation criteria are fetched. You can provide scores against
each criteria. The total scores are calculated based on its score and its weightage for
each evaluation criteria.
Applies to Theme Cosmos. Use the Evaluate process component in a case type as a step
in any of the stages.
6. Hover over process, and then click +STEP > More > Processes > Evaluate.
7. Click the Select button.
8. In the Evaluation details section, in the Source list, select a source.
a. In the Source list, select By name.
b. In the Evaluation type list, select an evaluation type, for example, Grants.
c. Alternatively, in the Source list, select By property to specify a property on
the work class that supplies the specific evaluation type at run-time.
9. In the Routing details area, select an operator:
• To route the assignment to the current operator, click Current operator.
• To specify a user or operator to whom you want to route this assignment,
click Specific user, and then, in the User field, select a user or enter a
property in the work class that supplies a specific operator ID at run time.
• To route the assignment to a specific work queue, click Work queue, and
then, in the Queue field, select a work queue name or enter a property in the
work class that supplies a specific work queue at run time.
10. Click Save.
Applies to Theme Cosmos. Add a new evaluation type with list of evaluation criteria.
Note: The sum of all the weights of the criteria list must be equal to 100.
7. Click Save.
• Create new: User can either create new evaluation from scratch or modify an
existing evaluation criteria.
• None: Users can choose not to configure any evaluation set for their use case.
Technical description
This component provides basic validations such as validating if evaluation set is empty
and Duplicate check for evaluation. The system will throw validation errors if the
evaluation set is empty and if we try to create a duplicate evaluation.
• IsEvaluationSetListEmpty
• IsEvaluationSetDuplicate
• ValidateEvaluationSetConfig
Once the evaluation criteria is entered, the same can be persisted using the Persist
configurations flow component. The component allows multiple configurations to be
saved simultaneously based on the persist flow parameters.
This component can be used in any case type as a step in any of the stages or as a view.
Make use of the validation rules and persist configuration component provided.
1. Invoke Evaluation component as a view and add validation. Using the persist
component, you can persist case data.
a. Click configure view and search for Evaluation criteria config in existing
views. Add it to form as shown below
Evaluation config
2. To Persist Data to using persist component. Click on + Step > More, search for
Persist configurations processes and click Select to add it as step. Check Persist
evaluation set checkbox.
Persist configurations
Evaluation validation
Duplicate entry
Validation criteria
Extensions
Below are the extension data transforms to add additional parameters or to set
additional configuration properties to case type. Extend them in implementation layer
for any customization.
Extending evaluate
Applies to Theme Cosmos. Configure the system recommendation for the newly added
type or for an existing type as you do it in the Grants example.
Activity plan
Applies to Theme Cosmos. Represent tasks and goals in an activity plan, and assign
those tasks and goals to team members associated with the investigation. You can use
activity plan as an optional action for an existing case as a case component. You can
show the list of plans conducted on a case in a hierarchical table.
The activity plan landing page supports managing the plan templates, goals, and tasks.
Managers or supervisors can create activity plan templates from the activity plan
landing page. Each activity plan template can have any number of tasks and goals in it.
You can develop activity plan templates using the PegaPS-Work-Manage-ActivityPlan case
type. The captured plan template details are stored as instances of thePegaPS-Data-
Config-ActivityPlan class.
Standalone tasks and goals can be created without creating the plan templates. Each
goal should contain at least one task; you can create a custom task or add an existing
task. When you create a task or a goal, PGP creates an instance of PegaPS-Data-Config-
Task and PegaPS-Data-Config-Goal classes.
Pega Government Platform provides a new tab called “Activity Plan Usage” in Activity
Plan landing page. Under this tab, we can see the list plan templates that are used
during creation of Activity plan case from Investigation or any other case. On expanding
each row, the goals and tasks under each plan can be viewed. We can view different
details about the templates like the name, description, status, how many times the
template has been used, is it an existing or custom template, and if plan is a custom
template giving an option to convert it to a new plan template in the system. Using
search field, we can also search for any activity plan.
The activity plan feature is enhanced in PGP release 24.1 to support sequencing of
activity plan goals and tasks. This feature helps in sequencing the goals and tasks of an
activity plan by providing the order or sequence for creation of goals and tasks. Once a
sequence is set, the goals and tasks within the plan will be created as per the sequence.
The next task or goal will be created only after the previous task is resolved. This
feature can be used by selecting Sequential checkbox while creating an activity plan
template or any run time activity plan case.
While creating a template, user can check the Sequential check box. In Goals and tasks
screen, the tasks within the goals can be sequenced or reordered using menu option or
drag action. In the Reorder plan tasks and goals screen, user can sequence plan’s goals
and tasks using menu options or drag action. The same functionality is applicable for
both template and run time activity plan case.
Activity plan
When a sequential template plan is used in an investigation case, the goals and tasks
would be shown in the order defined in the template. This sequence can be modified in
the case as required. Goals and tasks can be assigned to the operator or work queue.
Once a sequence is set and tasks and goals are assigned, the goals and tasks within the
plan will be created as per the sequence. The next task or goal will be created and
assigned only after the previous task is resolved. In the details tab of the case, the tasks
which are not created are displayed with “waiting” status and are greyed out. Users can
also create custom sequential plans in the runtime and define the order of creation as
required.
For an activity plan, users can view the Timeline view for the plan, goals, and tasks in
the Activity plan tab of the case. This view provides information on plan, task and goal
creation, completion, and status.
To support the timeline view in Activity plan case and goal case, a new Timeline tab is
added to the case.
Timeline
Technical Description
Below are the work classes used to create Activity plan, goal and task cases from
Investigation or any other case.
• PegaPS-Work-ActivityPlan
• PegaPS-Work-Goal
• PegaPS-Work-Task
Configurations
Applies to Theme Cosmos. You can configure editing a plan description to enable or
disable at runtime. Enabling the configuration set will allow the users to edit the
descriptions of Plan, goal, and task cases in runtime after the creation. Disabling will
not display the Edit button in the case.
Configure setting
Configuration set
Extensions
Extending work queue assignment for goals and tasks
In the Activity plan case, users can now assign goals and tasks to work queues as well.
To enable or disable assigning the goals and tasks to work queues, use the
GetWorkbasketDetails when rule. This when is marked as extension and by default, this
is set to true. To disable the assignment to Work queues, extend this when rule in the
implementation layer and set this when rule to false.
Applies to Theme Cosmos. Create, update, and delete tasks in activity plans. You can
add custom tasks and create SLAs in days and hours.
8. Click Save.
Applies to Theme Cosmos. Create, update, and delete goals in activity plans. You can
add custom tasks, add existing tasks, and create SLAs in days and hours for a goal.
8. Click Save.
Applies to Theme Cosmos. Add existing tasks or goals, create custom tasks or goals for
the existing activity plans. You can segregate tasks for a goal, and goals for an activity
plan so that you can add these plans to an investigation.
8. Click Save.
Applies to Theme Cosmos. If implementation team has a new template field like
SLADuration in their application. While converting custom plan to template, even these
new template fields introduced in implementation layer should be populated and
persisted in the manage template case. To support this procedure, follow these steps:
4. Add a new step in GetPlanDetails data transform and set the property.
5. Add a new step in SetIndexDetailsToConfig data transform and set the property.
Assessments
Applies to Theme Cosmos. The Assessments feature helps you create new assessments,
questions, or question pages. Use the Assessments component to configure and
conduct assessments.
For Investigative Case Management, Assessment is added only for the ICM Manager
access group.
Summary of features
Use the Assessment process component in a case type as a step in any of the stages.
You can create assessments by creating a questionnaire case type from App Studio.
After you add the conduct assessment process as a step, you should select the
assessment.
• If you select the assessment by name, then the same assessment initiates every
time the process is run.
• If you select the assessment by property reference, you need to send the class
name of the assessment that must be initiated.
• If you do not select an assessment in the process configuration, when the process
is run, you can select an assessment from the available list.
This section component can be used in any case type screen to configure it at runtime.
You can select any Assessment that is required to be configured for your case in
runtime.
This section component can be used as a step in any case type in one of the stages or
as a view.
2. In the header of your workspace, click the Switch Studio menu, and then click App
Studio.
3. In the navigation pane of App Studio, click Case types.
4. From the Case types column, click a case type or click New to create a new case
type.
5. Add the step in the stage and click Configure view.
6. In the left pane, search for Assessment config and click on + icon .
Assesssment config
Configuring interpretations
Based upon the interpretation results, business users can take further decisions or
perform a set of actions.
For example, in a loan application, if the assessment case is configured as: if the score
of all the responses is 0-5, and the interpretation is set as low risk. For any score above
5, it is set as high risk.
Based on the interpretation, the approver can understand and decide whether granting
the loan amount is risky or not.
1. In the header of your workspace, click the Switch Studio menu, and then click App
Studio.
2. Click the Preview button, and then click Config Assessment.
3. Click Configure, and then click Add interpretation.
4. In the SLA Name list, select the number of days from 1 through 4.
5. In the Min score field, enter the minimum score.
6. In the Max score field, enter the maximum score.
7. In the Interpretation field, enter the interpretation based on the minimum and
maximum scores. For example, if the Min score is 0 and the Max score is 3, then
the interpretation is Good.
Extending assessments
Applies to Theme Cosmos. Extend the assessment feature using Dev Studio.
Add a new SLA type to the existing SLA configurations for any assessment.
1. Create an SLA in the system that refers to OneDay in the PegaPS-Work class.
2. In the Explorer panel, click Data types > Option Map.
3. On the Records tab, add a row with the Field name/Group set to SLA.
Ensure that the Code column value is the same as the ID of the newly created SLA.
For many applications, there is always a need to capture information of all the family
members as part of a single step. For each person, you can mention a relationship (for
example, parent, child, grand parent, and so on).
While capturing the details of a person, you can either select an existing person in the
system or create a new person.
For multiple persons feature, Pega Government Platform offers components that you
can use from App Studio for the following scenarios.
Applies to Theme Cosmos. Add the multiple entity intake component when you build a
case type. Many government applications require you to capture details of multiple
persons as a part of the intake process, for example, multiple nominees, multiple
beneficiaries, and so on.
• To route the assignment to a specific work queue, click Work queue, and
then, in the Queue field, select a work queue name or enter a property in the
work class that supplies a specific work queue at run time.
10. Click Save.
5. In the Search Text box, enter PersonPerson and then click Apply.
9. Click the Data model tab, and then click the Add field button.
10. In the Field name field, enter the name for the field, for example, Father.
11. In the Type list, select Embedded data.
12. In the Data object list, select Person.
13. Click the Single record button, and then click Submit.
14. Click the Workflow tab and configure the process that you added.
Entity ID
Enter or select the Entity ID of Father if it is available so that the component
automatically gets the details from SOR and fills the appropriate fields. If this
is left blank, a new entity is created with all the details submitted.
Include in MyCases
Select this if you want to show the current case in MyCases of the entity.
Person Page
Select the property of the Person type into which you must capture the
details of the father and add quotes at both ends, for example, “.Father”. The
details are captured into the Father property.
Label
Provide an instruction to the user, for example, Enter father details.
For more information on adding new fields to screens, refer to Adding new fields to the
intake screen.
Case report
Applies to Theme Cosmos. Case report is a reusable and generic component for a
process. Using case report, a manager or reviewer can consolidate data from a case
and can generate a Microsoft Word or PDF document.
You can add create report as a component from App Studio, and can generate a
granular level report from case data. Pega Government Platform supports generating
the details of case summary, interview, evidence, team members, assessments, and
activity plans that are related to the case type. In addition to the above, the ICM
application supports subjects and external organizations as well.
Configure the case report component in App Studio to use in a case type, as a step or
an optional process, in a stage. You can use the case report component in case types
that capture data related to interviews conducted, evidence, activity plans, and so on.
2. In the header of your workspace, click the Switch Studio menu, and then click App
Studio.
3. In the navigation pane of App Studio, click Case types.
4. In the Case types column, click a case type, or click the New button to create a new
case type.
5. In the Case life cycle section, click Stage, and then enter a name for the stage in
the text box.
6. Hover over Process, and then click STEP > More > Processes > Create case report.
7. Click the Select button.
8. Under Configurations, click the checkbox "Is digital signature required?," to
capture the digital signature.
Create a case report with case details attached to the case type. The case report
component is useful if the case type captures data related to interviews conducted,
evidence, activity plans, and so on.
Adding a new selection item to the report contents for list objects
Add a new case type component to the case report. During the document creation, the
case type component and its details appear.
Create a new Word template while downloading the case report with details. The Word
template helps in capturing key information and in maintaining consistency of the
information.
Change the styles in PDF document. The <style> tag defines the style information (CSS),
where you mention how case details render in the PDF document.
When you generate a case report in the PDF file format, the DocumentationReport
property which holds the complete markup stream of the PDF document, is passed as a
parameter to the GenerateCaseReportDocuments activity through which the PDF
document is generated.
The following is the styling CSS for PDF document in PGP and is set in step 4 of the
PostPreview (CL:PegaPS-Work) data transform.
"<style> th{ align:justify; text-align: left; vertical-align: top; border-bottom: 1px solid b
lack; } table{ border-collapse:collapse; } th,td{ padding:2px; font-size: 9pt; } td{ borde
r-bottom: 1px dotted #000; font-weight:regular; text-align:top; vertical-align:top; } </s
tyle>"
Programs
Applies to Theme Cosmos. As an agency, manage your licensing and certification
processes by interacting with constituents and corporate entities. The program
configurator omni-channel tool helps you meet customer needs more effectively and
efficiently.
In program configurator, you can configure a new license by providing the required
data for the license along with the image. The program configurator includes license
configuration, a comprehensive application that streamlines licensing and certification
application process from start to finish, including evaluation, document upload, and
verification.
Applies to Theme Cosmos. For different applications, you may have various programs.
Using App Studio, you can edit an existing program/license configuration details, or add
a new program/license configuration with details.
Program configuration
Applies to Theme Cosmos. Government organization offers its citizens different
services, different set of service details need to be created in the application. To achieve
different set of details for different services, you can use this component and configure
it accordingly.
The program configuration landing page can be accessed from app studio and supports
configuring programs and licenses.
Program definition
Program definition case type helps in defining and managing the programs for
government purposes and customize them as required. This case type provides end-to-
end capabilities of Program management and configuration that enable agencies to
increase efficiency.
If a government agency wants to create a new program or license, they can quickly
create a Program definition case to define the program or license with the data model
that comes with the case.
This feature can be used for defining and managing programs and licenses for various
entities available in PGP such as person, business, item, vehicle, facility.
Using Program Definition case type, you can add a new case to create a program or
license with a specific manager access. This features offers the following capabilities:
• Edit program
• Copy program
You can create the program or license from User portal > left navigation menu >
Create.
While defining the program, you must provide the following details:
• Name
• Category
• Sub-category
◦ Entity applicable
◦ Start date
◦ End date
◦ Fund details
◦ Configurations
▪ Document
▪ Evalutation
▪ Checklist
Approval process
Upon entering the details, the case type will go through an approval process before
saving the program to the system. Once approved, the status of the program is active. If
the reviewer rejects the program, the case is resolved with the status Resolved rejected
else the program is saved to the system and the status is changed to active.
You can search or view a program or license from Program definition landing page. You
can narrow your search to the applicable entity with the entity type list.
• Copy Program– This feature allows you to copy the program details (except name
and unique identifier) and create a new program definition case. You can edit the
program details of the new program definition case as you go through the flow.
• Edit/Update Program – This feature allows you to edit the program details which
goes through an approval process before saving the changes. If the reviewer
rejects the changes, the program is routed back to the user to edit the details. If
accepted, the changes are saved to the system.
• Apply now – This feature allows you to initiate or launch the application request
case with the program details.
Technical description
While creating the case, based on the selected category (Program/License) the
configurations are persisted in the respective data types.
The following data classes are used for the selected category.
• Program: PegaPs-Data-Config-Program
• License: PegaPs-Data-Config-Program-License
Below is the work class used to create the program definition work object for both
Program and License
PegaPS-Work-Manage-Program
Configurations
Pega government platform comes with a reusable section components that can be
used in program definition case type for the configuration of Documents, Checklists,
Evaluations, and so on. These section components can be used in any case type where
there is a need for configuration of these items. A flow component Persist configuration
is used to persist these configurations into the system.
Using these components, the user who is defining the program can configure the
required documents, checklists, evaluation and so on. These section components are
built in such a way that, user can select existing documents from the list of documents
available, or create a new document set as per the requirement. This same functionality
is applicable for checklists and evaluation configuration as well. Once a new document
is created, it would be persisted into the system using Persist configurations flow
component.
Persist configurations component persists all the configurations into the system. This
component comes with parameters to commit the configurations. These parameters
can be set as per the requirement. For example, if there is a need to use and persist
only a few configurations in the implementation, the required parameters can be
enabled and others can be disabled by unchecking the checkbox for the respective
configuration parameter.
Persist configurations
• PGPGov-PGPCosmo-Data-Config-Program
• PGPGov-PGPCosmo-Data-Config-Program-Grants
• PGPGov-PGPCosmo-Data-Program
• PGPGov-PGPCosmo-Data-Program-Grants
• PGPGov-PGPCosmo-Work-Program
• PGPGov-PGPCosmo-Work-Program-Grants
10. On the Data model tab, click the Add field button to add the new program
configuration specific fields, for example, Land type.
11. Click Submit.
12. On the View tab, click the Program configuration details tile.
13. Click the Delete icon to delete any fields that are not applicable to the new
program configuration.
14. Search for the fields that you have added in step 9, click the Add to view icon to
add them to the view, and then click on Submit.
19. Add new program sub categories. For subcategories, you must add the Field name
column value that you added in step 18 as the Code column value.
25. In the Created in version box, enter or select the ruleset version, on the History
tab enter a description and then click Save.
26. Open the Implementation Program work class and click Save as.
27. Enter the details and click Save.
28. Search and open the SetProgramClasses (CL:PegaPS) decision table, click Save as to
save it to the implementation layer ruleset.
29. Add an else if condition for the new program configuration and in the Return
column, enter the newly created Config class, for example, PGPGov-PGPCosmo-
Data-Config-Program-Grants. Similarly, configure the new data and work classes.
• An operator touch report that shows the work for an operator for a given time
period.
• A team touch report for a supervisor, to review the cases their team members
worked on for a given time period. The team report access is restricted only to
supervisors.
• A touch report for investigation cases, but can be extended to any case.
View the audit details of investigations for different time periods. By default, the work
for the current week is displayed. You can change the time period.
By clicking Time filter and Select values, you get options to select different time periods
or a particular date.
By default, the report displays the audit details of all the investigations. To view the
audit details of an investigation, click the Work ID filter and enter an Investigation ID.
By default, the report displays the work of all the team members. To display the work of
a team member, click the Performerfilter and mention the name of the operator.
Display new columns for touch points of an operator for an investigation report. You
can view other details of an investigation, such as reported activity, description, and so
on.
As a manager or a team member, create similar reports for different case types.
Time management
Applies to Theme Cosmos. Time Management application provides a generalized time
management system to track and report time for case workers that is consistent with
applicable standards and guidelines.
Users use this application to capture, submit time entries for approval, re-submit
rejected time entries on a daily basis. Users have multiple opportunities to record their
time throughout the workday or they can enter time for the entire day and submit for
approval as a part of their end-of-day activities.
The Managers can view the time entries submitted by their workgroup and they can
Approve or Reject the time entries.
• The Project data table stores and lists all the projects details available in the
system. This table contains information about projects such as Project ID, Project
name, Project details, Project approver, and so on.
• The Time code table contains information about time codes such as name,
description, Approver, status, and so on.
The time management features are enhanced in release ’23 to support cascading
approval for time entries. You can control the routing of approvals based on the
configuration of the time management project.
Based on the selected approvals for a project in data records, Time entry is routed to
different levels of approvals accordingly. If all routing paths are enabled the approval
action goes first to the Work Group Manager, then to the Time Code Approval , and to
the Project owner Approval
Note: If time code approval is enabled at project level, and if the time code
does not have an approver or owner, the approval of the specific time code
entry is skipped and moved to the next step accordingly.
Time entry
Cascading approval
1. Login from App studio > Data > Project > Records. The list of records for the
selected project is displayed.
2. Select Enable approval and select team manager approval, time code approval
and project owner approval based on your requirement.
3. Click Save. A tick mark appears under the selected records.
Records
Extensions
Applies to Theme Cosmos. The following are the extensions for Time management
feature.
Add a new field to the project table in the Time Management application.
1. In the navigation pane of App Studio, click Data > Data objects and integrations.
2. In the list of data objects, click Project table.
Data model
2. In the Data objects and integrations window, click the Time entry log data
object.
7. Repeat step 6 to save the following sections into the implementation layer and
add a new field as a column to the table layout:
• ApprovalTimeEntryLog
• Approval_TimeEntryLogs
8. Add the field that you added in step 7 as a column in the following report
definitions class of PS-TimeMgmt-Data-TimeEntryLog:
• TimeEntryLogList
• LatestTimeEntryLogList
• MyTimeLogListLP
• CaseTimeEntryLogList
Open case type in app studio, Optional actions > add a new process to a stage > add
step > More > Processes > Time Entry
Open pyCaseMainInner section rule of that class, under Main content add a section
control with section name "TimeWrapper" with page context as "Use current page
context."
Technical description
Applies to Theme Cosmos.Based on the type of approvals selected for a project in data
records, Time entered for that project would be routed to different levels of approvals
accordingly.
This feature allows users to log time against a case for the current day. The time logs
are reviewed by manager or supervisor and they can approve or reject the time log.
The flow can be reused in such a way that users can initiate time entry log from any
case type. As it is initiated from a case the reference details are auto populated.
This feature allows user to view the summary chart and reports on time entry logs for a
particular case.
In investigation case users can log time from Action > Add work and the reference
details are auto populated. The View time in case is also included to the case but only
the investigation owner and manager/supervisor can view it.
Manage time
Time Management also has a Manage time landing page in which users can view time
entry logs for a given time period, a manager can view all time entry logs for a team.
Time management also provides restricted access to time entries, which is enforced by
attribute based access control (ABAC) rules:
Configurations
Applies to Theme Cosmos. The following are the configurations for Time mangement
feature.
1. In the navigation pane of App Studio, click Data > Data objects and integrations.
2. In the list of data objects, click Project table.
2. In the Data objects and integrations window, click the Records tab to view the
time codes that are available in the system.
3. Optional: To update a time code record, click the row of the record that you want
to update.
4. Optional: To delete a time code record, click the Delete icon at the end of each
row.
5. Optional: To add a new time code, at the end of the list click Add record.
6. Click Save to save the changes.
Deadline vaildation
Configure setting
Configure the Time sheet due setting to change the due time for a time sheet. The
default end of the day for a time sheet is 11:59 PM. This is called the due time. If a time
entry case is submitted after the due time, the system displays a validation error and
the user can not submit the case again.
4. Click the Settings icon at the end of the Specific due time row.
5. Enter a new due time as HHMMSS, in 24-hour format, for when users must submit
the time sheet.
update timesheet
• A low code platform that caters to the citizen developer through easy to re-use
components (UI, flow, user actions, and case types).
• Prerequisites
• Entities
For information about installing your application, see the product installation guide.
This implementation guide presents tasks in the sequence in which they are commonly
performed; however, the sequence varies based on business priorities. Follow the
procedures in this guide to complete the tasks for the first minimum lovable product
(MLP) release. Also, use this guide during iterative releases as you configure and extend
more features on top of the MLP release.
Prerequisites
Applies to Constellation. To prepare the implementation environment and to create
your application, complete the following preparation tasks:
The following are the access groups for the Pega Government Platform (PGP):
The following are the access groups for the Investigative Case Management (ICM)
application:
5. Follow the New Application wizard instructions until the Name your application
page opens, and then follow the steps below.
For more information about each step of the wizard, see Creating an application.
6. On the Name your application page, enter the name of the application, and then
click Advanced configuration.
7. In the Organization settings section, enter the Organization name, Division name,
and Unit name for this application.
The New Application wizard creates the application class structure for you based
on the organization settings that you enter. For more information, see Class layers
and Class hierarchy and inheritance.
If you have not already defined the organization entities (for example, if you have
not already defined the division), type the name of the new entity in the
appropriate field. The application saves the new values when you create the new
application.
Note: For the new application, the organization name cannot be PegaPS
or PegaGP.
8. Click Save.
9. Click Create application.
• D_Person
• D_Association
• D_IntvTemplate
b. Alternatively, if the application is directly built on Investigative Case
Management, override the following list of data pages.
• D_Investigation
• D_Subject
• D_Incident
• D_Interview
• D_Evidence
• D_Business
• D_Person
• D_Association
• D_IntvTemplate
10. Search for pyDefaultCaseMatch rule of class PegaGP-Work-Incident and override
the rule in the implementation layer incident class for the related incidents to
work in the new application.
11. In Dev studio, navigate to Application > Definition, expand the Advanced section
at the bottom, and click Generate routing table for the links to work in the new
application.
Configuration sets
Pega Government Platform (PGP) uses configuration sets in the application to control
the behavior of the application and minimize rule overrides and custom rule changes.
The settings are organized into configuration sets that associate the settings with a
common element, for example, an application feature or specific case type. All the PGP-
related configuration sets follow the pattern PGP-<Feature name>.
The following figure displays the configuration sets used for the Pega Government
Platform and Investigative Case Management:
Configuration sets
Data Pages separate the interface (that is the source of the data) from the Data Model
in your system. To implement this, you can use Data Pages and extend them to your
layer. Then, load the data from its system of record using REST, SOAP, or other methods
by changing the data source. For more information, refer Sourcing data.
Entities
Applies to Constellation. The Pega Government Platform (PGP) features pre-configured
entities for modeling common data elements in government processes, streamlining
case processing and data persistence in your application. Use PGP's collection of
government data structures to efficiently manage scalar properties, embedded pages,
and data instances with foreign-key relationships.
Each Pega Government Platform entity data class has supporting case types to provide
standardized data management operations on the persistent datastore.
Add
Collect data and persist to database table.
Update
Edit data and persist to database table.
View
Present data that has been read from the database table.
Search
Collect criteria and retrieve matching instances from database table.
• Person
• Business
Person
Applies to Constellation. Effortlessly manage the data of constituents with the Person
entity feature of Pega Government Platform (PGP). Capture, view, and edit details of
constituents, search for a constituent, and view their information.
Person entity feature of Pega Government Platform (PGP) enables you to manage
constituents’ data seamlessly. You can capture, view, and edit details of constituents.
You can also search for a person and select to view their details. The following are the
examples for Person entity:
Persona Action
Persona Action
Reusable features
PGP constellation application is built on Common Data Model (CDM) and leverages all
base entities from it. For more details, refer Overview section of Common Data Model.
The classes used for CDM data entity and PGP work class are as follows.
PegaGP-Work-Entity-Person Common-LDM-Entity-Contact
Common-LDM-Entity-Account-
Consumer
Note: When you are creating a person from PGP, a corresponding account of type
"consumer" record is created and persisted in CDM, by default.
The Person case type enables you to create or edit a person's profile in the system, with
options to input details such as name, communication details, and more. The system
saves the person's record along with relevant data, such as communication details,
communication preference, security questions, and more in the database. Additionally,
the system checks for duplicate records based on defined criteria.
You can use the Person case type when creating a person as a child case of a process or
as a standalone case, such as online self-registration.
Technical details
The Common Data Model (CDM) requires an account for every Person (Contact) record.
When you create a person from Pega Government Platform (PGP), a corresponding
account of type "consumer" record is automatically created and saved in CDM. The
corresponding CDM class for a consumer account is Common-LDM-Entity-Account-
Consumer .
Set the account's "relationship type" as "Personal," "Customer," or "Both." You can
configure this by using PGP-Person configuration set. Refer to the Configuration
instructions for more details.
For the Person entity, the PGP application uses two Data Transforms: one to initialize
the object and the other to prepare it for data persistency. You need to update these
Data Transforms to process the case data.
SetDefaults data transform: You can use SetDefaults data transform of Common-LDM-
Entity-Contact class to initialize person entity with default values.
PrepareObject data transform: You can use this data transform of Common-LDM-
Entity-Contact class to prepare the object or data persistency by updating the data
as needed. For example, if you want to capture "Full name," introduce a step in data
transform to concatenate First name and Last name. You can define these type of
transformations in this data transform.
The CDM supports collecting email and phone details using embedded list properties.
PGP application follows a specific design pattern of using embedded page properties
such as primary email and primary phone.
Consider a scenario where you need to introduce a new embedded page, such as
secondary email, to the Person case type. Follow these steps to add the new embedded
page to the Email page list:
• In the SetDefaults data transform, set the Is Primary property to False as this is a
secondary email. Also, set the property type to either Personal or Work as
appropriate.
• In the PrepareObject data transform, append the newly created secondary email
embedded page to the email page list. Use the "When" condition to check for the
existence of values. Refer to the primary email step in the PrepareObject data
transform.
Configuration instructions
When creating a person and account record, it is important to set the appropriate
relationship type for the account. To configure the relationship type, you can use the
PGP-Person configuration set provided by PGP.
The relationship type can be one of three options - "Personal," "Customer," or "Both."
By default, it is set to Personal. If your organization offers products or services, set this
to "Customer." If you want the user to be able to choose between "Personal" or
"Customer," set it to "Both."
Extensions
The out-of-the-box model provides some fields for the person entity, but you may need
to extend the model to add new fields. These fields can be simple scalar types, such as
height or weight, or more complex types such as picklists or embedded pages.
Reference data, such as a list of countries or states, gender type is typically used to
populate picklists.
If you want to add a secondary email, you will need to extend an embedded page.
Creating scalar fields is a simple process, but adding reference fields or embedded
pages requires additional steps. You must create these new fields in Common-LDM-
Entity-Contact class.
After creating new fields in the model, you can use them in case type and views. For
detailed instructions on how to extend the model refer to the following links.
Although the model might offer many fields, you might not want to persist all
depending on your use case. PGP offers a specific design pattern to filter out the
unwanted fields and persist only the required fields. You can use the PrepareObject data
transform to filter out these unwanted fields.
Refer to technical details section of Person case type for detailed instructions on how to
filter and initialize.
For extending a case type refer to Extending a Data Model for a Case.
Duplicate search
The Person case type in Pega Government Platform (PGP) includes a feature that allows
searching for duplicate records when creating a new person. This feature ensures data
accuracy by identifying any existing records that match the defined criteria entered
during the process creation. If duplicate record is found, the system alerts and provides
an option to either update the existing record or create a new one. This feature
prevents duplicate records and maintains data integrity within the system.
Technical details
PGP offers a Check Duplicate Data transform that limits duplicate entries based on
specific criteria. This data transform can be executed in any Flow Action during post-
processing. The restriction for adding a new person is based on their first name, last
name, and date of birth. To add extra fields to the duplicate check, refer to the
Extensions section.
Configuration instructions
Extensions
You can extend the SetDuplicateCriteria data transform by adding new fields to the
duplicate check and specifying them in the Contact List report definition. Expose the
field first, if the field is not already exposed.
360-person view
The Pega Government Platform (PGP) enables you to access a comprehensive 360-
degree view of an individual, providing complete details. To view all the information of a
person, search for their profile and select it.
The 360-degree view provides essential information, including the name, address, and
ID. Pega constellation screens consist of three sections: the Summary view (left pane),
Detail view (main section), and widgets (right section). By clicking on the email or phone
number in the summary panel, you can directly open an email or make a call.
Additionally, you can view a person's associations by clicking on the associations in the
summary panel.
Technical details
PGP provides Display person information view to display the complete 360 view of
the selected person.
Configuration instructions
Extensions
To extend the 360-Person view, navigate to App Studio and go to the Data Explorer.
Next, open the Contact entity and navigate to the UX tab. Here, you can access the full-
page view, which is a wrapper view that displays the 360-Person view. To make changes
to the summary panel or tabs (details and associations), navigate to the respective view
from the tab links.
Consider the example of adding a new field ‘Height’ under ‘personal information’ in the
above screen shot.
Search person
Search functionality in Person an include first name, last name, date of birth, or
national identification number. Once you enter the search criteria, the system displays
results that match the search criteria.
Technical details
PGP provides SearchPerson view to search and select an existing person. This view can
be used in different case types where person search is required. You can search for an
existing person using first name, last name, or DOB. Based on the search criteria
entered, the results (contact ID, first name, last name, DOB, address summary) are
displayed.
If you want to define your own search functionality, refer to platform’s data reference
pattern.
Configuraton instructions
Extensions
Extending search
You can extend the search criteria or the search results by adding a new field.
3. Under Input settings, check the "enable search" checkbox to get the list of fields
used in search criteria. Click "Add" to include the new field to search criteria.
Search fields
4. All the fields shown in search results are listed under "Columns." If you want to
add a new field to search results, click "Add."
The landing page of Pega Government Platform (PGP) Person entity displays the list of
people (constituents) added to the system. Click Entities from the left pane, the list of
People and Business entities added to the system are displayed. The landing page view
is also called as Person list view.
Technical details
No technical details
Configuration instructions
Extensions
Entities landing page is defined under web portal (Channel interfaces). You will find
people tab inside this landing page.
To add a new field to People landing page, click People > All contact view > Add and
select the required field.
Basic person is a reusable feature, that offers view and flow action to capture details,
and flow to persist the details. The view can be reused in any case type where person
details are captured, instead of rebuilding each time. For example, a case worker at
government department capturing candidate details, case worker capturing applicant
and parent details in case of a issuing birth certificate.
Technical details
Configuration instructions
Extensions
To add a new field to this view, for example, spouse name, click Add button and
proceed with next steps.
Basic person is a reusable feature that leverages to capture the basic information of a
person and associate it to the required case type. Basic Person can be used as part of
another micro journey to capture constituents' information for example, a case worker
at government department searches for person's record and if not found, creates new
person record during issue driving license journey.
• Flow – The person details are persisted in the database and can be used in other
use cases.
• Flow action - The person details are not persisted in the database. These details
are temporarily stored and used for viewing purposes. Subsequently "Persist
entity" feature can be used to persist data, if required.
Technical details
Configuration instructions
To capture basic person details, use OOTB flow and flow action. For multiple person
details, use a reusable view and define your own flow and flow action.
The Basic Person information flow includes two parameters Entity ID and Routing
details.
• Entity ID is an optional parameter. Use it when you want to fetch existing person
details. When creating a new person's data record, leave it blank.
• Routing Details: The case type is assigned based on the selected option. The
following are the available routing options:
◦ Current operator: The case type is assigned to a specific user.
◦ Work list: The case type is assigned to the worklist of a specific user.
◦ Work queue: Select work queue or work basket, and the available user picks
the case.
Routing details
Extensions
Business
Applies to Constellation. Government agencies often need to capture details of
businesses during processes like register a business, Issue a license, and more. Pega
Government Platform (PGP) provides a business entity that can be used during
implementation of such use cases. It allows users to efficiently capture and manage
details about businesses and organizations.
The Business case type enables you to create a new business entity in the system. This
case type saves the business record, along with supporting data, for example, address
of business, contact person, and more. The Add Business case type checks for duplicate
business entries and provides notifications accordingly.
Persona Action
Reusable features
PGP constellation application is built on Common Data Model (CDM) and leverages all
base entities from it. Visit Overview section (of Common Data Model) for more details.
The classes used for CDM data entity and PGP work class are as follows.
PegaGP-Work-Entity-Business Common-LDM-Entity-Account
Common-LDM-Entity-Account-
Business
Note: While creating business from PGP, by-default, Account type "business" is being
set.
Create business case type is used to create a business organization's profile in the
system. Create business case type can be used wherever creating a business can be
child case of a process or is a standalone case.
This case type provides an option to input details such as Trade name, Legal name
Employer ID, Open Date, Ownership type, Number of employees, Business Phone,
email, fax, address, contact person, and more in the database. System also checks for
duplicates while creating a business based on defined criteria.
Technical details
For Business entity, Pega Government Platform (PGP) application uses two Data
Transforms, one to initialize and other to prepare object for data persistency. You must
update these Data Transforms for processing the case data.
Common data model supports collecting email and phone details using embedded list
properties, PGP follows a specific design pattern of using embedded page properties
like primary email and primary phone.
Configuration instructions
Business goes through an approval process before creation. Once the business request
is created, case moves to work queue. By Default, it is set to "BusinessReviewQueue." If
your organization has specific work queue(s), you can update this value as required.
Business configuration
Capture contact person - Click Create business case type (in Dev studio) and select
the checkbox to capture the contact person details for a business. If this option is not
selected, the contact person details are not captured when creating a new business.
Extensions
While Out-Of-The-Box model offers certain fields for business entity, you may have to
extend the model to create new fields. These fields can be simple scalar type, (example,
Organization incorporated date) or complex properties like pick list or embedded
pages. The data that is typically used to source picklist is referred as reference data, for
example Ownership type, country list or state list. Adding secondary email is an
example of extending an embedded page. Creating scalar fields is straight forward,
while reference field and embedded pages requires additional steps.
Once the new fields are created in the model, they can be used in case type and views.
For detailed instructions on “how to extend the model” refer to the following links.
While the model may offer many fields, depending on your use case, you may not want
to store all the fields. PGP provides a specific design pattern to filter unwanted fields
and store only required fields. Use the PrepareObject data transform to filter unwanted
fields. Refer to the technical details section of the Business case type for detailed
instructions on how to filter and initialize.
For extending case type, refer to Extending a Data Model for a Case
Duplicate search
Pega Government Platform (PGP), the business case type includes a feature to search
for duplicate records while creating a new business. This feature helps to ensure data
accuracy by identifying any existing records that may match the criteria entered during
the creation process. If a duplicate record is found, the user will be alerted and can then
choose to either update the existing record or create a new one. This feature is
particularly useful in preventing duplicate records and maintaining data integrity within
the system.
Technical details
PGP provides Check Duplicate data transform to restrict duplicate entry based on
criteria. This Data transform can be called in any flow action post processing. Restricting
new business is based on Employer ID.
Incase, if you would like to add additional fields to duplicate check refer to extensions
section.
Configuration instructions
Extensions
You can extend SetDuplicateCriteria data transform, add new fields to duplicate check
and mention in Account List report definition. In case, if field is not already exposed this
needs to be exposed first.
360-business view
PGP enables you to view all the details related to a business profile in a 360-degree
view. Once a business profile is created, select the business case type to view all the
details of that business. This view has two sections - Summary view (left pane) and
Detail view (main section). You can directly open an email or call by clicking phone in
the summary pane.
Technical details
PGP provides Display business information view to display the complete 360 view of
the selected business.
Configuration instructions
Extensions
To extend the 360-business view, switch to app studio and navigate to data explorer.
Open the “Business account” entity, and navigate to UX tab. Here, you can see full page
view which is a wrapper view that displays 360-Business view. You can make changes to
summary panel, Tabs (details, associations, and branch) by navigating to respective view
from the tab links.
• Click Details tab and navigate to the respective view by clicking each view link in
the order coming on your way.
• Navigate to Details > Display business information > Display business details >
business info and add the new field in business info view.
Search business
The Pega Government Platform (PGP) provides SearchBusiness view to search and
select for an existing business. This view can be used in different case types based on
the requirement.
You can search for an existing business using legal name, trade name, email, or phone.
Based on the search criteria entered, the results are displayed. Check Extensions to
know more about adding a new field to search criteria.
Technical details
PGP provides SearchBusiness view to search and select for an existing business. This
view can be used in different case types based on the requirement. For detailed
information on implementing SearchBusiness view, refer to business entity in
Implementation guide.
You can search for an existing business using legal name, trade name, email, or phone.
Based on the search criteria entered, the results are displayed. Check implementation
guide to add fields for search criteria.
Configuration instructions
Extensions
Extending search
You can extend the search criteria or the search results by adding a new field . To add a
new field in search criteria follow these steps:
The landing page of the Pega Government Platform (PGP) Business entity displays the
list of businesses added to the system. Click Entities from the left pane, the list of
People and Business entities added to the system are displayed. The landing page view
is also called as Business list view.
Technical details
No technical details
Configuration instructions
Extensions
Entities landing page is defined under web portal (Channel interfaces). You will find the
businesses tab inside this landing page.
To add a new field to Businesses landing page, click Businesses > All accounts view ,
click Add option and select required field.
Basic business details are used to capture the basic details of a business and associate
them to the required case type. In this scenario, after entering the required details
system validates if the business details already exist in the system. If the business
details do not exist in the system, you can create a new business by providing their
details. You can search for an existing business or add a new business to capture basic
information.
Technical details
Configuration instructions
Extensions
To add a new field to this view, (for example, Organization incorporated date), click +
Add and select the required field.
Basic business details are used to capture the basic details of a business and associate
them to the required case type. In this scenario, after entering the required details
system validates if the business details already exist in the system. If the business
details do not exist in the system, you can create a new business by providing their
details. You can search for an existing business or add a new business to capture basic
information.
Technical details
Configuration instructions
To capture basic business details, use OOTB flow and flow action.
Scenario 1: ABC Drone business organization wants to apply for exemption to fly the
drone. If the organization details are not found in the system, the official creates a new
record and saves the data into the system. Then, they proceed further with the process
for approval. This scenario is an example of a basic business flow component.
Scenario 2: ABC Drone business wants to apply for exemption to fly the drone. If the
organization is not found in the system, the official captures the details of that
organization (but does not save them in the system) and proceeds further with the
process for approval. The business details are available in the case type and can be
saved to the system at any point in time. This scenario is an example of a basic
business flow action component.
The Basic business information flow includes two parameters Entity ID and Routing
details.
Entity ID is an optional parameter. Use it when you want to fetch existing business
details. When creating a new business data record, leave it blank.
Capture contact person - Select the checkbox to capture the contact person details for
a business. If this option is not selected, the contact person details are not captured
while creating a new business.
Routing Details: The case type is assigned based on the selected option. The following
are the available routing options:
• Work queue: Select work queue or work basket, and the available user picks the
case.
Extensions
For detailed information on creating a new entity, refer Adding a new entity.
• Incident
• Subject
• Interview
• Evidence
• Associations
Incident
Applies to Constellation. Government agencies, their employees, constituents report
many incidents or events such as theft, disturbance, and narcotics. for further action by
suitable authorities. Pega Government Platform (PGP) offers an "incident" case type to
register, process the reported incident and help government organizations improve the
resolution process.
• Initiate incident
• Review incident
• Resolve incident
The incident feature of Pega Government Platform (PGP) enables you to manage
incident lifecycle. It allows you to capture, view, and act on incidents. An automatic
email is sent out to reporter, when an incident is created, or an action is taken on the
incident.
The following are the sample use cases for incident case type:
Persona Action
Persona Action
Reusable features
Case type
• Incident case type
View
• 360-incident view
This case type offers the option to input incident details, including the incident name,
date and time, report type (lead, tip, or Incident), reported activity, incident location,
and reporter information. The system saves the incident details along with relevant
data. Once the incident is created, its status is set to New, and it is assigned to a work
queue by default.
Technical details
The Pega Government Platform (PGP) application uses "pyDefault" data transform to
initialize and set the default values to the Incident case instance.
Work class
Incident case type work class is PegaGP-Work-Incident and this case is extended in
Investigative Case Mangement (ICM) application with the work class as PegaGP-Work-
ICM-Incident .
Data class
To capture incident specific details like incident name, incident date time, notified date
time, and more, the incident case has its synonymic data property as "Incident" with
page definition as Common-LDM-Data-Incident .
Configuration instructions
PGP offers a configuration set, PGP-Incident , which enables you to configure the
work queue to which you want to route the incident for review. In case of multiple work
queues, you can use decision table or decision tree options.
Related incidents
In a situation where you would like to identify related incidents, PGP offers you this
capability.
PGP-Incident configuration set can be used to show or hide the related incidents
feature. Setting the value to True will show the "Related incidents" feature in the
incident life cycle.
In PGP out-of-the-box, related incidents is defined using three properties (which are
referred in case match rule).
• Incident type
• Zip code
• Time period of one week before and after the incident date and time.
You can change the case match rule from App Studio, by modifying the these
conditions based on your need as shown below.
• Open an investigation review option, the system displays the list of investigation
officers in the drop-down to assign the investigation.
• To show the list of investigation officers in the drop-down during the incident
review process, use PreReview data transform. All the operators added to
ICMAgent accessgroup will be added to this list.
To change the access group, you can override PreReview data transofrm and assign the
required access group to "RouteToAccessGroup" field.
Extensions
Few examples of extensions to incident case type could be adding a new property to
incident details screen and creating a new "review action" type. Here are the detailed
steps explaining how various extensions can be done to incident case.
For adding a field to incident details capture screen, complete the following steps.
By default, incident review screen displays the following review actions in ICM
application. ICM is an application where incident case has been implemented.
• Open an investigation
• Associate to an existing investigation
PGP review screen displays the following review actions: Approve, Reject and Return. In
order to add a new action type, follow these instructions.
Consider adding a new review action type "No action" for an incident.
1. Open the "ReviewAction" property from PGP or ICM application respectively and
select save as of the property to implementation layer.
2. You can update the prompt values of the "ReviewAction" property to add a new
value.
3. Open the ReviewIncident ( PegaGP-Work-Incident or PegaGP-Work-ICM-
Incident ) flow and click the Save as button.
4. Update the connectors that result from the decision shape "review action" with
the newly introduced actions.
The landing page of the PGP incident case type displays the list of incidents added to
the system. Click Incidents from the left pane, and the list of incidents added to the
system is displayed. Use the search incident feature to search for incidents in the
system based on their basic information. Search for incidents by using inputs, for
example, Name, Incident ID, Report type, State, and City.
Technical details
No technical details
Configuration instructions
Extensions
To add a field to the search results for the Search incident landing page, complete the
following step.
• Add the required property to the columns space of the ICMIncidents_1 view and
ensure the queryable option is enabled in the source datapage (D_IncidentList) of
the landing page.
Subject
Applies to Constellation. Subject case type in Pega Government Platform (PGP) enables
users to create subjects and associate them to investigation cases or entities for
streamlined and efficient case management. A Subject include a person or business.
The Subject case type allows you to easily add subjects directly within an investigation
or as standalone entries for later association. Effortlessly capture, view, and edit details
of diverse entities and items for seamless data management.
You can easily create subjects within an investigation case or as standalone entries for
later association. Effortlessly capture, view, and edit details of diverse entities and items
for seamless data management.
The following are the sample use cases of Subject case type
Persona Action
Reusable features
Case type
• Subject case type
View
• 360-subject
• Subject landing page
• Related subjects list
Flow
• Create subject
Create subjects using Subject case type and associate them to a Person or business. In
the Create Subject window, select person or business option and select any of the three
options (existing, new, or unknown) to create a subject.
Technical details
The following are work and data classes used for a Subject casetype in Pega
Government Platform (PGP) and Investigative Case Management (ICM).
Work classes
Data classes
Based on the selected subject type, you can dynamically change the subject data class
to either subject person data class or subject business data class. You can initialize the
entity in the Post subject type data transform.
Persist information (flow) – Save subject entity information by calling the save entity
activity and passing parameters based on the entity type.
Configuration instructions
Note: If this option is not selected, contact person details are not
captured when creating a new business.
Extension
Consider an example of adding an Item as a new entity in the system. Follow these
steps to add a new entity to subject type:
The landing page of the Pega Government Platform (PGP) subject case type displays the
list of subjects added to the system. Click Subjects on the left pane and the system
displays the list of subjects added. Use the search subject feature to search for subjects
in the system based on their basic information. Search for subject by using inputs, such
as subject name, Incident ID, Report type, State, and City.
Technical details
No technical details
Configuration instructions
Extensions
The subject landing page is defined under the web portal (channel interfaces). You will
find the Subject tab inside this landing page.
To add a new field in the Subjects landing page, click + Add and select the required
field.
Note: We opted to use the existing list, open the Subjects list view case type
and click +Add to add a new field.
Create subject
Create subject is a reusable component that can be invoked in any case type. If you
have a use case where you need to invoke subject case, you can use this component
and associate the subject to the parent case.
Subject list details view displays the list of subjects associated to a case. You can
configure the subjects tab to view the list of associated subjects.
Technical details
Create subject
Configuration instructions
To get list of associated subjects in the subject tab of a case, create Subject tab and
invoke subject list details view.
Extensions
Interview
Applies to Constellation. The Interview case type allows you to capture or record details
of any interview conducted. You can initiate an interview by capturing the details such
as participants, location, time, and attachments. The system saves the details in the
system of record. The case type can be invoked from other case types such as
investigation.
The Pega Government Platform (PGP) interview case can be easily configured in your
business process. Interview allows to initiate, conduct, and close the interview. You can
use guidance to have pre-defined questions, capture response, and add final notes
after conducting the interview.
You can also launch the Interview case type as a standalone case or in another case.
Persona Action
Investigation case supervisor Interview the suspect of a hit and run case
Reusable features
Case type
• Interview case type
View
• 360-interview view
Flow
• Create interview
PGP constellation application is built on Common Data Model (CDM) and leverages all
base entities from it. Visit Overview section (of Common Data Model) for more details.
Interview casetype
Interview case type is used to create or edit an interview case in the system. This case
type provides an option to capture the interview details such as selecting the guidance
template (the available templates are Subject, Suspect, and Witness), primary
interviewer, scheduler type (immediately or later), and the participants list.
Technical details
The following work and data classes are used for interview case type in Pega
Governement Platform (PGP) and Common Data Model.
PegaGP-Work-Interview Common-LDM-Data-Interview
Configuration instructions
PGP offers a configuration set, PGP-Interview that enables you to configure the
interviewer list. You can assign the interviewer list to any of the following options:
configure settings
Extensions
Create interview
The Create interview component can be accessed from any case. If the component is
invoked from a case other than the interview case, the created interview case becomes
the child case, and an association link is established between the interview and the
primary case. This link can be managed through Manage associations.
Interview list details view displays the list of subjects associated to a case. You can
configure the subjects tab to view the list of associated subjects.
Technical details
Configuration instructions
To get list of associated interviews in the interview tab of a case, create Interviews tab
and invoke Interview list details view.
Create interview
Interview tab
Extensions
Interview template
Applies to Constellation. Pega Government platform’s interview template feature offers
a range of tools and features that enables you to create customized templates with list
Persona Action
Reusable features
Case type
• Create interview template
View
• 360-interview template view
• Template landing page
This feature offers the option to input template name, description, status (active/
inactive), and an option to add the questions. The system saves the provided details
along with relevant data. Once the template is created, its status is set to active, by
default. The template appears in the dropdown menu while creating an interview.
Technical details
No technical details
Configuration instructions
Extensions
The Interview template landing page is defined under the web portal (Channel
interfaces). You will find the Templates tab inside this landing page.
To add a new column to the Templates landing page, click Interview and navigate to
the Interview template list view.
Evidence
Applies to Constellation. As an investigation officer, you can associate evidence with its
case to easily view all details of the evidence against the case at any time.
The Pega Government Platform (PGP) evidence case type enables you to capture details
of evidence that can serve as evidence. You can capture location details and
attachments related to the evidence based on its type. The captured details and
attachments are persisted in the system of record.
Persona Action
Reusable features
Case type
• Evidence case type
View
• 360-evidence view
Flow
• Create evidence
Evidence from an investigation case by providing details such as evidence type, name,
description, location details, and attachments, if any. Any evidence created through
investigation is automatically associated with that investigation.
Technical details
The PGP Constellation application is built on the Common Data Model (CDM) and uses
all base entities from it. For more information, visit the Overview section of the
Common Data Model. The classes used for the CDM data entity and PGP work class are
listed below.
PegaGP-Work-Evidence Common-LDM-Data-Evidence
Configuration instructions
Extensions
Create evidence
The Create evidence is a reusable flow that can be accessed in any case type. If you
need to create an evidence case and associate it with a parent case, you can use this
flow.
The evidence list details view displays the list of evidence associated with a case. You
can configure the Evidence tab to view the list of associated evidence.
Technical details
Configuration instructions
To view the list of associated evidence in the Evidence tab of a case, create an Evidence
tab and invoke the evidence list details view.
Extensions
The following are the business examples for investigation case management:
Persona Action
FBI agent
To investigate an incident, work on the
following tasks:
Persona Action
Reusable features
Case type
• Investigation case type
View
• 360-investigation view
The Investigation case type in the system enables easy creation of investigation cases.
This case type provides an option to input details such as investigation name, case
open date and time, reported activity, description, address details, external
organizations, and more. The system also checks for duplicates based on defined
criteria when creating an investigation case. You can use this case type as a standalone
case.
Technical details
The following work and data classes are used for an investigation case in Pega and ICM.
PegaGP-Work-ICM-Investigation Common-LDM-Data-Investigation
Configuration instructions
Extensions
This feature allows you to generate a summary of the investigation case using GenAI.
The summary includes details of the investigation case as well as any cases created
from it (such as interviews, evidence, and subjects) based on your selection.
Configuration instructions
You can configure the system to generate a case summary using Gen AI. To generate a
case summary using Gen AI, follow these steps:
Enabling Gen AI
Depending on your organization's needs, you can activate or deactivate the Pega GenAI
feature. Activating Pega GenAI enables you to view the Case Summary action in the
Investigation case type.
The Investigation list view, also known as the landing page of an investigation, displays
the list of investigations added to the system. Click Investigations in the left pane, to
view the list of investigations added to the system.
Technical details
No technical details
Configuration instructions
Extensions
The Investigation landing page is located within the web portal (Channel interfaces).
You can find the Investigations tab on this landing page.
To add a new field to the investigation landing page, (since we are using the existing list,
open the investigation list view), click on the "Add" option and select the desired field.
To include a new property in the summary panel of investigation case, open the Full
page view of Investigation case by clicking on UX Tab of Investigation case type. Under
Summary, Click "Add" to add new fields.
To include a new tab in the investigation case, open the Full page view of Investigation
case by clicking on UX Tab of Investigation case type. Under Tabs, click "Add" to create
new tab.
As all the fields are already created in the data class, open the data designer for the
Investigation data class ( Common-LDM-Data-Investigation ). Then, open the
Display Investigation Information view located under the Partial view section. Click Add
button in the desired region to add new fields.
Including additional fields on child details screen: The fields related to child details
are created in the Contact class. Therefore, open the data designer for the Contact class
( Common-LDM-Entity-Contact ). Then, open the Child Details Display view located
under the Partial view section. Click Add button in the desired region to add new fields.
Extending Gen AI: Each feature has a specific data transform to build its context. If you
need to add new properties to the context, open the data transform for that feature
and update the values accordingly. The data transforms for all features can be found in
the "PrepareReportInfo" data transform, which serves as a wrapper for all of them. To
add new properties to a specific feature's context, find the name of its data transform
within "PrepareReportInfo" and create an extension for it.
For example, to add a field to the subject, open "ReportSubjectSummary" and update
the value or create an extension data transform and include the field in it.
Extending case summary by adding a new feature: To add a new feature to the case
summary, create an extension for the "PrepareReportInfo" data transform and update
it accordingly. For example, to include an "Activity Plan" feature, create an extension
data transform for "PrepareReportInfo" and include the necessary code.
Associations
Applies to Constellation. Association management is a powerful and extensible
framework Out-of-the-box (OOTB) for managing relationships between different
entities and cases. The visual output offers high business value to customers who want
to manage complex relationships in case life cycles.
Pega Government Platform (PGP) provides an association framework that enables you
to associate objects with each other and manage all the associations. These
associations include entities to entities, entities to cases, and cases to cases.
Persona Action
Restaurant license approver manager Check the history of all owners and their
prior businesses and violations by owners
and their businesses, before approving.
Manage associations
You can manage associations through the context of individual entities or cases. You
can create new associations and edit existing associations for entities or cases.
Technical details
The following are the work and data classes of associations in Pega Government
Platform (PGP) and Common Data Model (CDM):
For entity-to-entity associations, the relationship and entity classes are used from the
CDM layer. A new class, Common-LDM-Relation-Case_Entity , is created in PGP
24.1 for case-to-entity associations.
Reusable flows
You can use the SaveAssociation flow rule to initiate the persistence logic for any case
or entity associations conditionally.
Configuration instructions
In the Manage Association case, we can limit the manual association of certain cases
or entity combinations by hiding them on the UI. You can achieve this by using the PGP
- Limit Associations configuration set.
Specify the configuration setting value for each case and entity by listing the relevant
case or entity names separated by commas. Use NULL as the value to avoid any
restrictions.
Extensions
The views used to manage associations among cases or entities through the Manage
Associations feature.
• You can use the Person Associations view to manage associations between
Person entities and other entities or cases.
• You can use the Business Associations view to manage associations between
Business entities and other entities or cases.
• You can use the Case Associations view to manage associations between any
cases.
To manage associations with a new case type in the Manage Associations feature,
open the Case Associations view and add a grid for the new case type. Then, make any
necessary changes.
The Associations list view in Pega Government Platform (PGP) displays all connections
between entities. This view is customizable to show various association types and is
easy to use from any case or entity under the "Associations" tab. We can view the list of
associations or connections between an entity or case and other entities and cases
under the Associations tab.
Technical details
The following data pages are used to display the associations in the Association list
view:
Configuration instructions
Extensions
For more information on managing reference data, refer Adding a new picklist single-
value field.
Implementation layer
2. Open Application Definition, add your PGP application at the top in newly
created CS implementation application.
Application definition
5. From application definition, Switch to Cases and Data tab, add our PGP case
classes in the Case Types list.
Case categories
d. Give the name of the category from Associated cases drop-down (select PGP
cases to be displayed under this category).
Associated cases
e. To include many cases, click + Add task button below the drop-down.
f. Save the case type.
7. Launch cases from interaction portal.
a. Launch Interaction portal.
b. Create Interaction case type from create menu.
c. Click + Add Case button in details screen. It displays all the cases of each
category.
d. Select the PGP case from the category to launch the case from the
interaction portal.
Hotfixes
This page lists the hotfixes that the Pega Government Platform application requires.
This page also lists hotfixes required for the Pega Foundation for Government
application, the Pega application superseded by the Pega Government Platform
application.
To request a hotfix, go to My Support Portal. Click New request > For something I need
and select Service request > Existing hot fix. Add and verify the hotfix details and click
Finish.
Import each type of hotfix in the listed order during the Pega Government Platform or
Pega Foundation for Government installation or upgrade:
• Apply Pega Platform hotfixes immediately after the Pega Platform installation or
upgrade.
• Apply Pega Government Platform hotfixes just after you complete the
application bundle import.
To see hotfix installation details, see the readme that is included in the hotfix.
The following table lists the required Pega Government Platform 8.8 hotfixes.
HFix-85100
BAC pre-registration for
activities.
The following table lists the required Pega Government Platform 8.7 hotfixes.
8.7 HFix-84901
BAC Pre Registration for
activities
The following table lists the required Pega Government Platform 8.6 hotfixes.
8.6 HFix-84878
BAC Pre Registration for
activities
HFix-82530
Enhancement- App Factory
Support for PGP 8.6.
HFix-80827
The following issues are
addressed:
• SetObjClass data
transform throwing
error from @baseclass.
• ROI Generation in
Cosmos investigation
does not pull some
new properties.
• Work and Data
attachments do not
prompt correct error in
UI Kit.
• Support to only RTE
and local file for Data
attachments in
Cosmos.
• Removal of default
param value (Google
key) from the data
page parameters.
• Subject search issues
in Cosmos.
• Global context fixes for
images.
• Merge attribute for
business label issue
for Ownership type
property.
The following table lists the required Pega Government Platform 8.5 hotfixes.
8.5.1 HFix-80897
• Google key configured
as default value in
parameters
• Global context issues
for Image Prefix
8.5 HFix-84884
BAC Pre Registration for
activities.
of platform hotfix
HFix-84421.
The following table lists the required Pega Government Platform 8.4 hotfixes.
HFix-63547
• The Participants
parameter
configuration is
missing for AddPlan
flow rule.
• Creating a new entity
from the Manage
association is failing
with PegaCRM as built
on.
• The activity plan
option from Mobile
toolkit is invoking the
configuration page
instead of invoking the
plan.
• PegaGP ruleset was
shipped with unlocked
ruleset version.
The following table lists the required Pega Government Platform 8.3 hotfixes.
• Visualize in Household
view is not working as
the ObjectType
property was set.
• Opening cases from
open link of the nodes
of the Visualize
diagram is not
working, for the cases
in the implementation
layer.
• The Confirm harness,
after the external
assignment has been
performed is showing
Investigation case
information - For
security reasons we
should not show any
case information.
• The data layer
attachments are not
being saved to CMIS
repositories (Fix for SR-
D47517 of PGP 8.1).
The following table lists the required Pega Government Platform 8.2 hotfixes.
The following table lists the required Pega Government Platform 8.1 hotfixes.
• Upload image
functionality for
Person or Vehicle is
not available in
Implementation layers.
• Reporting ruleset
missing for
ICMManagers.
• Unable to publishing
private message in
Pulse section.
• Procurement Admin's
accessgroup missing
the security role.
The following table lists required Pega Platform hotfixes for Pega Government
Platform 7.4.
pyAttachApprovalEmail
activity.
The following table lists required required Pega Government Platform 7.4 hotfixes.
The following table lists required Pega Government Platform 7.31 hotfixes.
• In PGP Selfservice
portal, the label and
text fields of the
username and
passwords are
overlapping.
• Branch details are not
being displayed in the
Business view page.
The following table lists required Pega Government Platform 7.21 hotfixes.
The following table lists required Pega Foundation for Government 7.16 hotfixes.
Resources
Find supplemental about Pega Government Platform.
Import each type of hotfix in the listed order during the Pega Government Platform or
Pega Foundation for Government installation or upgrade:
• Apply Pega Platform hotfixes immediately after the Pega Platform installation or
upgrade.
• Apply Pega Certification and Licensing for Government hotfixes just after you
complete the application bundle import.
To see hotfix installation details, see the readme that is included in the hotfix.
The following table lists the required Pega Certification and Licensing for
Government 8.5 hotfixes.
The following table lists the required Pega Certification and Licensing for
Government 8.4 hotfixes.
The following table lists the required Pega Certification and Licensing for
Government 8.3 hotfixes.
The following table lists required Pega Certification and Licensing for Government
7.31 hotfixes.
The following table lists required Pega Certification and Licensing for Government
7.21.01 hotfixes.
HFix-35628
Changes are required to
address the following
issues:
HFix-35628
Changes are required to
address the following
issues:
• Opening a complaint
case from search
complaint encounters
an error.
• The return to login
page screen has a
blank display.
• Users cannot view the
Add business button in
the Create operator
page.
The following table lists the required Pega Platform hotfixes for Pega Certification
and Licensing for Government 7.15.01.
The following table lists the required Pega Certification and Licensing for Government
7.15.01 hotfixes.
The following table lists required Pega Certification and Licensing for Government
7.13.01 hotfixes.