0% found this document useful (0 votes)
167 views596 pages

50.pega Government Platform '24 1 2024-07-20-17-54-02

Uploaded by

A
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
167 views596 pages

50.pega Government Platform '24 1 2024-07-20-17-54-02

Uploaded by

A
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 596

Pega Government Platform

'24.1
20 July 2024

©2024 Pegasystems Inc


Pega Government Platform '24.1 2

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 3

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 4

Optional: Importing the sample data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167


Optional: Installing sample application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Update_______________________________________________________________________________ 170
Completing the prerequisite tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Backing up your system. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Updating the application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Importing common application file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Importing common government application file. . . . . . . . . . . . . . . . . . . . . . . . 174
Importing Pega Government Platform application file. . . . . . . . . . . . . . . . . . . 175
Optional: Configuring OAuth 2.0 and setting the application URI. . . . . . . . . 176
Creating operator accounts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Optional: Importing the sample data (PGP Constellation). . . . . . . . . . . . . . . . 179
Optional: Importing the sample data (PGP traditional application). . . . . . . . 180
Updating data from integration layer to data layer. . . . . . . . . . . . . . . . . . . . . 181
Optional: Enabling backward compatibility with integration layer. . . . . . . 182
Refactoring wrapper activities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Adding properties to integration and data layers. . . . . . . . . . . . . . . . . . . . . 184
Customizing report definitions in implementation layer. . . . . . . . . . . . . . . 184
Customizing data pages in implementation layer. . . . . . . . . . . . . . . . . . . . . 185
Customizing data page response data transforms in implementation layer. .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Adding classes to communications and identifiers in implementation layer. .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Modifying State drop-down menu source. . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Modifying Country drop-down menu source. . . . . . . . . . . . . . . . . . . . . . . . . 186
State label configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
App Studio compliance changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Extending new case types in implementation layer. . . . . . . . . . . . . . . . . . . . . 188
Modifying class context data transform rule. . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Modifying business context data transform rule. . . . . . . . . . . . . . . . . . . . . . . 189
Enabling operator creation in user registration functionality. . . . . . . . . . . . . 189
Optimized properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

©2024 Pegasystems Inc


Pega Government Platform '24.1 5

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 6

Update Person case type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221


View Person case type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Business entity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Vehicle entity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Add Vehicle case type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Update Vehicle case type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
View Vehicle case type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Household entity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
Add Household case type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
Update Household case type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
Updating an existing list property. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Update Manage members case type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
View Household case type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Facility entity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Add Facility case type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Update Facility case type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
View Facility case type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
Search entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Item entity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Add Item case type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Update Item case type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
View Item case type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Entity attachments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Entity history and field audit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Entity merge. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Creating new entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
What are PGP entities?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
New Entity overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Development steps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Create Case types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Create data management case types. . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Enabling for App Studio. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

©2024 Pegasystems Inc


Pega Government Platform '24.1 7

Rule inventory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301


Implementing case types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Initiate event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
View event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Search event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
Event creation through email. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
Investigative Case Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Investigation case. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
Subject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Interview case. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
Evidence case. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
Manage associations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
Extending Associations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
Application request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
Program finder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
Managing reference data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
Features implementation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Dashboard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Search program landing page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Review checklist. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
Consent agreement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
Configuring consent agreement in runtime case. . . . . . . . . . . . . . . . . . . . 364
Extending consent agreement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Document intake. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
Configuring document from App studio. . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
Configuring document in runtime case. . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
Extending document intake. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Verify document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Nearby locations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
Evaluate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
Evaluating configuration from App studio. . . . . . . . . . . . . . . . . . . . . . . . . . 388
Evaluate configuration in runtime case. . . . . . . . . . . . . . . . . . . . . . . . . . . . 390

©2024 Pegasystems Inc


Pega Government Platform '24.1 8

Extending evaluate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398


Activity plan. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
Configurations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
Extensions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
Assessments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
Extending assessments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
Multiple entity intake. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
Configuring and extending multiple entity intake in a single screen. . . . 428
Configuring and extending multiple entity intake in separate screens. . 430
Case report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
Programs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
Program configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
Operator Case Involvement (Touch) reporting. . . . . . . . . . . . . . . . . . . . . . . . 455
Time management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
Technical description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
Configurations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
Implementation guide for Constellation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
Preparing for implementation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
Configuring access groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
Creating a new application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
Configuring the new application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
Connecting system of record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
Entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
Person. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
Business. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
Creating new entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
Implementing case types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
Incident. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
Subject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
Interview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
Interview template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540

©2024 Pegasystems Inc


Pega Government Platform '24.1 9

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 10

Getting started with Pega


Government Platform
Explore the links below to access product and other useful information for Pega
Government Platform (PGP)

Release notes

• Release notes

Product overview

• Product overview for Theme Cosmos


• Product overview for Constellation

Setup

• Install with Theme Cosmos


• Install with Constellation
• Update

Implement

• Implementation guide for Theme Cosmos


• Implementation guide for Constellation

©2024 Pegasystems Inc


Pega Government Platform '24.1 11

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.

For a complete list of new features, see the Release Notes.

• Pega Government Platform built with Constellation new features

• Pega Government Platform Traditional application enhancements

• Issues addressed for Pega Government Platform Traditional application

• Known issues for Pega Government Platform Traditional application

©2024 Pegasystems Inc


Pega Government Platform '24.1 12

• Known issues for Pega Government Platform Constellation

• Deprecated and withdrawn rules

Pega Government Platform built with


Constellation new features
The Pega Government Platform (PGP) release 24.1includes a number of new features.

Some of the new features of PGP include:

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 13

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

Incident case type in PGP Constellation helps to streamline the management of


incidents, tips, and complaints reported by government agencies, employees, and
constituents. The Incident feature allows for capturing, viewing, and acting on incidents,
improving the resolution process. Automatic email notifications are sent to the reporter
when an incident is created or an action is taken, ensuring timely communication.

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 14

create interviews, assign interviewers with suggested questions, and review notes on
conducted interviews, enhancing the overall interview management process.

Evidence

The evidence feature in PGP Constellation enables investigation officers to associate


evidence with their investigation cases, making it easy to access and review all evidence
related to a case at any time. This feature streamlines the process of managing
evidence in investigation cases, ensuring that all relevant information is readily
available for officers to make informed decisions.

Investigative Case Management

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 15

The updated association and relationship management feature enables versatile


relationship creation, including Entity-to-Entity, Entity-to-Case, Case-to-Case, and Case-
to-Entity. Case workers can add associations manually or automatically through
business processes. The system supports bi-directional relationship types and naming.
Association management is easily extensible for new entities and cases, providing a
comprehensive view of associations in the context of an entity or case.

Pega Government Platform Traditional


application enhancements
Pega Government Platform (PGP) 24.1 has no enhancements for this release.

Issues addressed for Pega Government


Platform Traditional application
This section describes issues resolved in this release that are of the most interest to
and are likely to have the most impact on the Pega user and developer community.

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.

The release notes include the following issue types:

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 16

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.

Known issues for Pega Government


Platform Traditional application
This table describes the known issues that might occur in this release.

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.

ID Title and description Suggested resolution

BUG - 625115 Empty assignment key error Override corresponding


on click of edit in section and have a “WHEN”
investigation case, for user condition.
with no edit access rights.

BUG - 676905 Unable to open the tab


In the pyCaseMainInner of
review checklist tab in
the Application Request
application request unless
class. Open the "Evaluation
the case is refreshed.
info tab" cell properties

©2024 Pegasystems Inc


Pega Government Platform '24.1 17

ID Title and description Suggested resolution

under Main content


(Grouped) and enable the
"Reserve space when
hidden" option. Repeat
same for other tabs if you
face similar issue.

Known issues for Pega Government


Platform Constellation
This table describes the known issues that might occur in this release.

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.

ID Title and description Suggested resolution

BUG - 853769 Localization - Email subject and The fix is anticipated in 24.2
contents are not localized. from platform.

BUG - 834139 Unified list is unable to fetch updated


Extend the appropriate data
entity names.
page response data
transform to set the latest
values of the entity.

Unable to retrieve the most recent Set pzReindex value on the


BUG - 851566
updated identifier ID. Multiple index top level page.

©2024 Pegasystems Inc


Pega Government Platform '24.1 18

ID Title and description Suggested resolution

records are created for a ContactID


Note: This is
PATCH API call.
already set for the
contact entity for
requests initiated
from the Pega
Government
Platform app.
Follow the same
for other entities
as needed.

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.

Deprecated and withdrawn rules


Pega Government Platform has deprecated some rules during the releases to better
maintain the product and make it easier for you to extend rules when needed. After
two releases these rules will be withdrawn as a practice.

The following table lists the count of deprecated and withdrawn rules for every release
in Pega Government Platform.

©2024 Pegasystems Inc


Pega Government Platform '24.1 19

Release Deprecated Rules Withdrawn Rules

'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.

'23 Deprecated rules

The following table lists the deprecated rules of Pega Government Platform for '23
release.

Name RuleSet Ruleset version Applies to

AllMembersHaveEn PegaPS 08-23-01 PegaPS-Work


dDate

ApplicationPending PGPCosmos 08-23-01 PegaPS-Work


Email

©2024 Pegasystems Inc


Pega Government Platform '24.1 20

Name RuleSet Ruleset version Applies to

ApplicationSubmitt PGPCosmos 08-23-01 PegaPS-Work


ed Email

AttachFilesScreenm PegaPS 08-23-01 Data-WorkAttach-


mobile File

AttachFilesScreenM PegaPS 08-23-01 Data-WorkAttach-


obile File

BranchesActions PGPCosmos 08-23-01 PegaPS-Work-


Entity-Business

BusinessNameRequ PegaPSUserServices 08-23-01 PegaPS-Work-User-


ried Registration

CasesListValues PegaPS 08-23-01 PegaPS-Work

CheckInvalidMarital PegaPS 08-23-01 PegaPS-Data-Entity-


Status Person

CommunicationInfo PegaPS 08-23-01 PegaPS-Work

CopyCountryIntToD PegaPS 08-23-01 Code-Pega-List


ata

DocumentGenerati PGPCosmos 08-23-01 PegaPS-Work


onDetails Mail

EducationView_Hea PGPCosmos 08-23-01 PegaPS-Work


ding

EneterValidEmail PegaPS 08-23-01 @baseclass

ExperienceView_He PGPCosmos 08-23-01 PegaPS-Work


ading

ExternalApproval PGPCosmos 08-23-01 PegaPS-Work


Email

FetchEducationDeta PegaPS 08-23-01 Code-Pega-List


ils

©2024 Pegasystems Inc


Pega Government Platform '24.1 21

Name RuleSet Ruleset version Applies to

FetchevaluationCrit PegaPS 08-23-01 PegaPS-Data-


eriaList Config-
EvaluationCriteria

FetchPersonHouseh PegaPS 08-23-01 Code-Pega-List


oldList

GovtServiceWrappe PegaPSPortals 08-23-01 PegaPS-Work


r

HasNoActiveMemb PegaPS 08-23-01 PegaPS-Work


ers

HasNoHeadOfHous PegaPS 08-23-01 PegaPS-Data-Entity-


ehold Household

IsExperience PegaPS 08-23-01 PegaPS-Data-Entity-


Associate

IsNotAdministrator PegaPS 08-23-01 PegaPS-Data-Entity-


Business

IsResultCountIsZero PGPCosmos 08-23-01 PegaPS

IsReviewPending PegaPS 08-23-01 PegaPS-Data-


Review

IsWorkPartyURIExist PegaPS 08-23-01 Data-Party


s

KnownEvidenceLoc PegaPSInt 08-23-01 PegaPS-Int-


ation Evidence

LoadSecurityQuesti PegaPSUserServices 08-23-01 PegaPS-Data-Entity-


ons Person

ManageLocationList PegaPS 08-23-01 PegaPS-Work

MergeEntitiesHeade PGPCosmos 08-23-01 PegaPS


r

©2024 Pegasystems Inc


Pega Government Platform '24.1 22

Name RuleSet Ruleset version Applies to

MissingAttachment PegaPS 08-23-01 @baseclass

MissingHeadOfHou PegaPS 08-23-01 @baseclass


sehold

NoDataWithAddAss PegaPS 08-23-01 PegaPS-Data-


ociation Association

NoIDLocationMapW PGPCosmos 08-23-01 PegaPS-Data-Entity


ithList

NoNearbyCasesRes PegaPS 08-23-01 PegaPS-Work


ults

NoRDLPaginator PegaPS 08-23-01 PegaPS

NotificationEmailTe PGPCosmos 08-23-01 PegaPS-Work-Event-


mplateContent Initiate

ParticipantsListExist PGPCosmos 08-23-01 PegaPS-Work-


s Manage-Interview

PostAddTeamMem PegaPS 08-23-01 PegaPS-Work


ber

PostDocumentPara PegaPS 08-23-01 PegaPS-Work


mConfig

PreferenceDetails PegaPS 08-23-01 PegaPS-Data-


Preference-Comm

PreSearchBusiness PGPCosmos 08-23-01 PegaPS-Data-


Association

ProfileNavigation PegaPS 08-23-01 PegaPS-Data-Entity-


Person

RemoveTempAttach PegaPS 08-23-01 PegaPS-Work


mentsPage

©2024 Pegasystems Inc


Pega Government Platform '24.1 23

Name RuleSet Ruleset version Applies to

ResetAssociate PegaPS 08-23-01 PegaPS-Data-


Association

SalutationAndMarit PegaPS 08-23-01 PegaPS-Data-Entity-


alStatus Person

SaveAssociations PegaPS 08-23-01 PegaPS-Data-Entity

SelectValidOwner PegaPS 08-23-01 @baseclass

SetDuplicateFalse PegaPS 08-23-01 PegaPS-Data-


Config-
InterviewTemplate

SetEndUserDefaults PegaPSUserServices 08-23-01 Data-Admin-


Operator-ID

SetProcessParamet PegaPS 08-23-01 PegaPS-Data-


ers Config-Portal

ShowItemValues PGPCosmos 08-23-01 PegaPS-Data-Entity-


Item

ShowMeasurement PGPCosmos 08-23-01 PegaPS-Data-Entity-


Item

ShowReqAccessNod PegaPS 08-23-01 History-Work-


e

ShowReqInfoNode PegaPS 08-23-01 History-Work-

SortBranchList PegaPS 08-23-01 PegaPS-Data-Entity-


Business

TrainingView_Headi PGPCosmos 08-23-01 PegaPS-Work


ng

UnderwritingAppro PGPCosmos 08-23-01 PegaPS-Work


ved Email

©2024 Pegasystems Inc


Pega Government Platform '24.1 24

Name RuleSet Ruleset version Applies to

ValidateDuplicatePe PegaPS 08-23-01 PegaPS-Data-Entity-


rson Person

ValidateManufactur PGPCosmos 08-23-01 PegaPS-Data-


er Association

VehicleFromDateMa PegaPS 08-23-01 PegaPS-Data-


ndatory Association

VehicleInfoRO_1 PGPCosmos 08-23-01 PegaPS-Data-Entity-


Vehicle

VehicleResults PegaPS 08-23-01 PegaPS-Data-Entity-


Vehicle

ViewLocations PegaPS 08-23-01 PegaPS-Data-Entity

ViewNoteInner PegaPS 08-23-01 PegaPS-Data-Note

D_AssessmentCase PegaPS 08-23-01 PegaPS-Work


s

D_BusinessRole PegaPS 08-23-01 PegaPS-Data-Entity-


Business

PGPUtilities PegaPS 08-23-01


PartyRoleInPageGro
up--
(String,String,Clipbo
ardProperty)

SendEmail Email PegaPSICM 08-23-01 PegaPS-Work-ICM

8.8 Deprecated rules

The following table lists the deprecated rules of Pega Government Platform for 8.8
release.

©2024 Pegasystems Inc


Pega Government Platform '24.1 25

Name Ruleset Ruleset version Applies to

webwb Vis JS PegaPS 08-08-01

pyStartCase PegaPS 08-08-01 PegaPS-Work-


Merge

8.7 Deprecated rules

The following table lists the deprecated rules of Pega Government Platform for 8.7
release.

Name Ruleset Ruleset version Applies to

CaseActionArea PegaPS 08-07-01 PegaPS-Work-


Question

CaseActionAreaButt PegaPS 08-07-01 PegaPS-Work-


ons Question

CancelFlow PegaPS 08-07-01 PegaPS

LogOffPS PegaPS 08-07-01 PegaPS

PostConfirmCancel PegaPS 08-07-01 PegaPS

PostEvidence PegaPS 08-07-01 PegaPS-Work

pyStartCase PGPCosmos 08-07-01 PegaPS-Work-


Merge

8.6 Deprecated rules

The following table lists the deprecated rules of Pega Government Platform for 8.6
release.

Name Ruleset Ruleset version Applies to

ListCount PegaPS 08-06-01

CancelFlow PegaPS 08-06-01 PegaPS

©2024 Pegasystems Inc


Pega Government Platform '24.1 26

Name Ruleset Ruleset version Applies to

LoadClassContext PegaPS 08-06-01 PegaPS-Data-


Context-Class

pyStartCase ICMCosmos 08-06-01 PegaPS-Work-


RequestAccess

8.5 Deprecated rules

The following table lists the deprecated rules of Pega Government Platform for 8.5
release.

Name Ruleset Ruleset version Applies to

QuestionPageLabel PegaPS 08-05-01 Embed-PegaQ-


Results-
QuestionGroup

.QuestionPageLabel PegaPS 08-05-01 Embed-PegaQ-


Results-
QuestionGroup

PGPSampleData 8.3 PegaPS 08-05-01

PGPSampleData 8.4 PegaPS 08-05-01

PGPSampleDataSCs PegaPS 08-05-01


08.10

D_GetQuestionGrou PegaPS 08-05-01 Rule-PegaQ-


pLabel QuestionGroup

ListCount PegaPS 08-05-01

RelatedEntities PegaPS 08-05-01 PegaPS-Data-Entity

ManageTeamMobil PegaPS 08-05-01 PegaPS-Work


e

HeaderInformation PegaPS 08-05-01 PegaPS-Data-Entity-


Business

©2024 Pegasystems Inc


Pega Government Platform '24.1 27

Name Ruleset Ruleset version Applies to

ViewDetails PegaPS 08-05-01 PegaPS-Data-Entity-


Business

FacilityLocation PegaPS 08-05-01 PegaPS-Data-Entity-


Facility

AddAttachments PegaPS 08-05-01 PegaPS-Data-Entity-


Vehicle

AddRelations PegaPS 08-05-01 PegaPS-Work

RelatedPersonnel PegaPS 08-05-01 PegaPS-Work

AddAssociates PegaPS 08-05-01 PegaPS-Work-


Manage-Associate

pyCaseContent PegaPS 08-05-01 PegaPS-Work-


Manage-Education

pyCaseContent PegaPS 08-05-01 PegaPS-Work-


Manage-Experience

CaseActionArea PegaPS 08-05-01 PegaPS-Work-


Question

CaseActionAreaButt PegaPS 08-05-01 PegaPS-Work-


ons Question

CancelFlow PegaPS 08-05-01 PegaPS

LogOffPS PegaPS 08-05-01 PegaPS

PostConfirmCancel PegaPS 08-05-01 PegaPS

pyStartCase PegaPS 08-05-01 PegaPS-Work-


Merge

ViewDetails PegaPS 08-05-01 PegaPS-Data-Entity-


Business

InitiateEvent PegaPS 08-05-01 PegaPS-Work-Event-


Initiate

©2024 Pegasystems Inc


Pega Government Platform '24.1 28

Name Ruleset Ruleset version Applies to

InitiateAskQuestion PegaPS 08-05-01 PegaPS-Work-


Question

GovtServicesDetails PegaPSPortals 08-05-01 PegaPS-Work

pyCaseContent PegaPSUserServices 08-05-01 PegaPS-Work-User-


ChangePassword

ForgotPassword PegaPSUserServices 08-05-01 PegaPS-Work-User-


ForgotPassword

Registration PegaPSUserServices 08-05-01 PegaPS-Work-User-


Registration

pyStartCase PGPCosmos 08-05-01 PegaPS-Work-


Entity-Facility-Add

pyStartCase PGPCosmos 08-05-01 PegaPS-Work-


Manage-Branch

pyStartCase PGPCosmos 08-05-01 PegaPS-Work-


Manage-Member

pyStartCase PGPCosmos 08-05-01 PegaPS-Work-


Merge

8.3 Deprecated rules

The following table lists the deprecated rules of Pega Government Platform for 8.3
release.

Name Ruleset Ruleset version Applies to

RelatedEntities PegaPS 08-03-01 PegaPS-Data-Entity

PostEvidence PegaPS 08-03-01 PegaPS-Work

RelatedEntities PegaPS 08-03-01 PegaPS-Data-Entity

©2024 Pegasystems Inc


Pega Government Platform '24.1 29

Name Ruleset Ruleset version Applies to

SetStateLabel PegaPS 08-03-01 PegaPS-Data-


Address

EntityHasCases PegaPS 08-03-01 PegaPS-Data-Entity

ViewAllCases PegaPS 08-03-01 PegaPS-Work

InvestigationAssoci PegaPSICM 08-03-01


ationControl

RelatedEntities PegaPSICM 08-03-01 PegaPS-Data-Entity

RelatedEvents PegaPSICM 08-03-01 PegaPS-Work

RelatedAllEventsList PegaPSICM 08-03-01 PegaPS-Work-ICM

SubjectRelatedCase PegaPSICM 08-03-01 PegaPS-Work-ICM


sListAll

RelatedInvestigatio PegaPSICM 08-03-01 PegaPS-Work


nsVisual

RelatedAllSubjects PegaPSICM 08-03-01 PegaPS-Work-ICM

8.2 Deprecated rules

The following table lists the deprecated rules of Pega Government Platform for 8.2
release.

Name Ruleset Ruleset version Applies to

Pgpwebsiteheader PegaPS 08-02-01 @baseclass

Procurementswebsi PegaPS 08-02-01 @baseclass


teheader

WebLoginComplaint PegaPS 08-02-01 @baseclass


s

WebLoginPGP PegaPS 08-02-01 @baseclass

©2024 Pegasystems Inc


Pega Government Platform '24.1 30

Name Ruleset Ruleset version Applies to

WebLoginProcurem PegaPS 08-02-01 @baseclass


ents

8.1 Deprecated rules

The following table lists the deprecated rules of Pega Government Platform for 8.1
release.

Name Ruleset Ruleset version Applies to

LoadBusinessConte PegaPS 08-01-01 PegaPS-Data-


xt Context-Business

LoadClassContext PegaPS 08-01-01 PegaPS-Data-


Context-Class

D_StateList PegaPSInt 08-01-01 PegaPS-Int-Config-


State

Withdrawn rules
This page lists the list of withdrawn rules of Pega Government Platform for 8.x releases.

'23 Withdrawn rules

The following table lists the withdrawn rules of Pega Government Platform for '23
release.

Name RuleSet Ruleset version Applies to

LogOffPS PegaPS 08-23-01 PegaPS

PostConfirmCancel PegaPS 08-23-01 PegaPS

pySetWhenGadgetC PegaPS 08-23-01 Embed-


ontext Conversation-
Question

©2024 Pegasystems Inc


Pega Government Platform '24.1 31

Name RuleSet Ruleset version Applies to

pySetWhenGadgetC PegaPS 08-23-01 Rule-Obj-When


ontext

.RelatedCasesCount PegaPS 08-23-01 PegaPS-Work

pyInvalidTelephone PegaPS 08-23-01 @baseclass


Number

pyExtendedAPIs PegaPS 08-23-01 Rule-Obj-Flow

PGP_Release 8.9 PegaPS 08-23-01

PreRoll 8.9 PegaPS 08-23-01

ManageTeamMobil PegaPS 08-23-01 PegaPS-Work


e

pyGeolocationTracki PegaPS 08-23-01 Data-Portal


ngIsEnabled

PreUpdateBasicDet PGPCosmos 08-23-01 PegaPS-Data-


ails Config-Goal

PreUpdateBasicDet PGPCosmos 08-23-01 PegaPS-Data-


ails Config-Task

pyCaption Due on PGPCosmos 08-23-01 PegaPS-Work

NoWorkID PGPCosmos 08-23-01 @baseclass

pyNoIDHeader PGPCosmos 08-23-01 Assign-

AddPlan ICMCosmos 08-23-01 PegaPS-Work-ICM-


Investigation-
Initiate

pyWorkActionsPerf PegaPSICM 08-23-01 PegaPS-Work-ICM-


orm Investigation-
Initiate

©2024 Pegasystems Inc


Pega Government Platform '24.1 32

Name RuleSet Ruleset version Applies to

pyWorkActionsRevie PegaPSICM 08-23-01 PegaPS-Work-ICM-


w Investigation-
Initiate

pyCaseMarkerSecti PegaPSICM 08-23-01 Work-Cover-


on

pyProximityMap PegaPSICM 08-23-01 @baseclass

pyProximityMapOpt PegaPSICM 08-23-01 Data-Portal


ions

Refactor_CopyIntTo PegaPSICM 08-23-01 PegaPS-Data-


Data Config-OptionMap-
ICM

pyGeolocationTracki PegaPSICM 08-23-01 Data-Portal


ngIsEnabled

Action TimeMgmt 08-23-01 PS-TimeMgmt-


Work-TimeEntry

Comments TimeMgmt 08-23-01 PS-TimeMgmt-


Work-TimeEntry

pyCaseInformation TimeMgmt 08-23-01 PS-TimeMgmt-


Work-TimeEntry

IsActionApprove TimeMgmt 08-23-01 PS-TimeMgmt-


Work-TimeEntry

8.8 Withdrawn rules

The following table lists the withdrawn rules of Pega Government Platform for 8.8
release.

Name Ruleset Ruleset version Rule Type

PGP 7.40 PegaPS 08-08-01 Product

©2024 Pegasystems Inc


Pega Government Platform '24.1 33

Name Ruleset Ruleset version Rule Type

webwb Bootstrap PegaPS 08-08-01 Text File


css

webwb Custom css PegaPS 08-08-01 Text File

webwb PegaPS 08-08-01 Text File


ProgressIndicator js

8.7 withdrawn rules

The following table lists the withdrawn rules of Pega Government Platform for 8.7
release.

Name Ruleset Ruleset version Applies to

pgpDefaultSecured PegaPS 08-07-01

CustomRole PegaPS 08-07-01 Data-Party

pxDeviceType PegaPS 08-07-01 Index-


CircumstanceDefini
tion

pxIsMobileDevice PegaPS 08-07-01 Index-


CircumstanceDefini
tion

ProgressColor PegaPS 08-07-01 PegaPS

ProgressTextSuffix PegaPS 08-07-01 PegaPS

DispositionType PegaPS 08-07-01 PegaPS-Data-Config

DateDecimal PegaPS 08-07-01 PegaPS-Data-


Context-Business

MergedFromKey PegaPS 08-07-01 PegaPS-Data-


Snapshot

SetAppLoginPage PegaPS 08-07-01 Code-Security

©2024 Pegasystems Inc


Pega Government Platform '24.1 34

Name Ruleset Ruleset version Applies to

NoticeHeaderBkp PegaPS 08-07-01 PegaPS-Work

RachGrantConsentA PegaPS 08-07-01 PegaPS-Work


greement

BusinessBranchDet PegaPS 08-07-01 PegaPS-Data-Entity-


ailsRO1 Business

IACAuthentication PegaPS 08-07-01 Code-Security

DeleteDocList PegaPS 08-07-01 Pega-Ext-


ExpExplorer-
Configuration-
Document

AssociateRelatedEv PegaPS 08-07-01 PegaPS-Work-Event-


ents Initiate

ValidateAssociates PegaPS 08-07-01 PegaPS-Work-


Manage-Associate

getEmailSenderInfo PegaPS 08-07-01 PegaPS-Work-


RequestAccess

PostAddAttachment PegaPS 08-07-01 PegaPS-Data


s

pyAttachContent PegaPS 08-07-01 PegaPS-Work

AUTSetAttachmentT PegaPS 08-07-01 PegaPS


oFile

AUTSetLinkData PegaPS 08-07-01 PegaPS-Data-Link

EndUser PegaPS 08-07-01 Data-Portal

PreReviewDocumen PegaPS 08-07-01 PegaPS-Work


t

SetRadiusRange PegaPS 08-07-01 PegaPS-Work

©2024 Pegasystems Inc


Pega Government Platform '24.1 35

Name Ruleset Ruleset version Applies to

SetRelatedEvents PegaPS 08-07-01 PegaPS-Work-Event-


Initiate

SetLinkedFromTo PegaPS 08-07-01 PegaPS-Work-


Manage-Associate

SetCaseStatusForSL PegaPS 08-07-01 PegaPS-Work-


A TransferOwnership

PegaPSEndUser PegaPS 08-07-01 Data-Portal

ReviewRequest_3 PegaPS 08-07-01 PegaPS-Work-


RequestAccess

IsMultipleConfigure PegaPS 08-07-01 @baseclass


dCounties

IsSingleConfiguredC PegaPS 08-07-01 @baseclass


ountry

PGPRulesets_pyrule PegaPS 08-07-01 @baseclass


set

DuplicateTemplate PegaPS 08-07-01 Pega-Ext-


ExpExplorer-
Configuration-
InterviewTemplate

IsAttachmentTypeD PegaPS 08-07-01 PegaPS


ocument

ShowCaseActions PegaPS 08-07-01 PegaPS-Work

ShowManageTeam PegaPS 08-07-01 PegaPS-Work

NonMandatoryAddr PegaPS 08-07-01 PegaPS-Data-


essFormWithCurren Address
tLocation

©2024 Pegasystems Inc


Pega Government Platform '24.1 36

Name Ruleset Ruleset version Applies to

AnonymousReporti PegaPS 08-07-01 PegaPS-Data-Event


ng

CaseHistoryTab PegaPS 08-07-01 PegaPS-Work

EventDetailsPreview PegaPS 08-07-01 PegaPS-Work-Event

RegistrationInfo PegaPSUserServices 08-07-01 PegaPS-Work-User-


Registration

D_DocumentSource PGPCosmos 08-07-01 PegaSocial-


Options Document

InterviewReport PGPCosmos 08-07-01 PegaPS-Data-


Interview

TestTraining PGPCosmos 08-07-01 PegaPS-Data-


Training

ReportPDFWrapper PGPCosmos 08-07-01 PegaPS-Work

EnterCaseDetails PGPCosmos 08-07-01 PegaSocial-


Document

OpenByHandle PGPCosmos 08-07-01 @baseclass

IsApplicableForBusi PGPCosmos 08-07-01 PegaPS-Work-


ness ApplicationRequest

IsApplicableForFacili PGPCosmos 08-07-01 PegaPS-Work-


ty ApplicationRequest

IsApplicableForPers PGPCosmos 08-07-01 PegaPS-Work-


on ApplicationRequest

CreateForm_Default PGPCosmos 08-07-01 PegaPS-Work-


Entity-Vehicle-Add

LoadDocumentSour PGPCosmos 08-07-01 Code-Pega-List


ceOptions

©2024 Pegasystems Inc


Pega Government Platform '24.1 37

Name Ruleset Ruleset version Applies to

Apply PGPCosmos 08-07-01 PegaPS-Work-


ApplicationRequest

EditAction PGPCosmosOverrid 08-07-01 PegaPS-Work-


e ActivityPlan

EditAction PGPCosmosOverrid 08-07-01 PegaPS-Work-Goal


e

EditAction PGPCosmosOverrid 08-07-01 PegaPS-Work-Task


e

pxDeviceType PegaPSICM 08-07-01 Index-


CircumstanceDefini
tion

ApplicationRequest ICMCosmos 08-07-01 PegaPS-Work-


ReviewWorkBasket ApplicationRequest

UserPortal ICMCosmos 08-07-01 PegaPS-Data-Portal

SelectItems ICMCosmos 08-07-01 PegaPS-Work-ICM

ReportPDFWrapper ICMCosmos 08-07-01 PegaPS-Work-ICM-


Investigation-
Initiate

pyPopulateCaseCon PegaPSICM 08-07-01 Assign-Worklist


tentsInner

pyPopulateCaseCon ICMCosmos 08-07-01 Assign-Worklist


tentsInner

getEmailSenderInfo PegaPSICM 08-07-01 PegaPS-Work-ICM-


Investigation-
Initiate

ICMAgent PegaPSICMPortals 08-07-01 Data-Portal

CaseWorker PegaPSICM 08-07-01 Data-Portal

©2024 Pegasystems Inc


Pega Government Platform '24.1 38

8.6 Withdrawn rules

The following table lists the withdrawn rules of Pega Government Platform for 8.6
release.

Name Ruleset Ruleset version Applies to

pyEmail PegaPS 08-06-01 @baseclass

PGP 08.10 PegaPS 08-06-01

PGPSampleData PegaPS 08-06-01


7.40

PGPSampleData 8.3 PegaPS 08-06-01

PGPSampleData 8.4 PegaPS 08-06-01

PGP_ICM_Demo PegaPS 08-06-01


7.40

gella-pegasystems- PegaPS 08-06-01


com-CodeFragment

AddAssociates PegaPS 08-06-01 PegaPS-Work-


Manage-Associate

pyCaseContent PegaPS 08-06-01 PegaPS-Work-


Manage-Education

pyCaseContent PegaPS 08-06-01 PegaPS-Work-


Manage-Experience

pyUploadFile PegaPS 08-06-01 Data-WorkAttach-


File

pyCaption PegaPS 08-06-01 PegaPS-Data-


CommType Comm-Phone

AddAssociates PegaPS 08-06-01 PegaPS-Work-


Manage-Associate

Web-Login-Member PegaPS 08-06-01 @baseclass

©2024 Pegasystems Inc


Pega Government Platform '24.1 39

Name Ruleset Ruleset version Applies to

Web-Login-test PegaPS 08-06-01 @baseclass

InitiateEvent PegaPS 08-06-01 PegaPS-Work-Event-


Initiate

InitiateAskQuestion PegaPS 08-06-01 PegaPS-Work-


Question

SetMergeStatus PegaPS 08-06-01 PegaPS-Data-Entity

PersistInterview PegaPS 08-06-01 PegaPS-Work

ForgotPassword PegaPSUserServices 08-06-01 PegaPS-Work-User-


ForgotPassword

Registration PegaPSUserServices 08-06-01 PegaPS-Work-User-


Registration

EditAction PGPCosmos 08-06-01 PegaPS-Work

pyCaption PGPCosmos 08-06-01 PegaPS-Work-


CreateNew Manage

CaseDetails PGPCosmosOverrid 08-06-01 PegaPS-Work-Event


e

pyRefresh PGPCosmosOverrid 08-06-01 PegaPS-Work-


e Entity-Business-
View

pyWorkCommonAct PGPCosmosOverrid 08-06-01 PegaPS-Work-


ions e Entity-Business-
View

pyRefresh PGPCosmosOverrid 08-06-01 PegaPS-Work-


e Entity-Facility-View

pyWorkCommonAct PGPCosmosOverrid 08-06-01 PegaPS-Work-


ions e Entity-Facility-View

©2024 Pegasystems Inc


Pega Government Platform '24.1 40

Name Ruleset Ruleset version Applies to

pyRefresh PGPCosmosOverrid 08-06-01 PegaPS-Work-


e Entity-Household-
View

pyWorkCommonAct PGPCosmosOverrid 08-06-01 PegaPS-Work-


ions e Entity-Household-
View

pyRefresh PGPCosmosOverrid 08-06-01 PegaPS-Work-


e Entity-Person-View

pyWorkCommonAct PGPCosmosOverrid 08-06-01 PegaPS-Work-


ions e Entity-Person-View

pyRefresh PGPCosmosOverrid 08-06-01 PegaPS-Work-


e Entity-Vehicle-View

pyWorkCommonAct PGPCosmosOverrid 08-06-01 PegaPS-Work-


ions e Entity-Vehicle-View

ProgressIndicator PegaPSICM 08-06-01

AssociateEvent_RDL ICMCosmos 08-06-01 PegaPS-Data-Event

SearchCriteria ICMCosmos 08-06-01 PegaPS-Data-Event

pyCaseMainInner PegaPSICM 08-06-01 PegaPS-Work-


Manage

InitializeInterview PegaPSICM 08-06-01 PegaPS-Work

IsUnderInvestigatio PegaPSICM 08-06-01 PegaPS-Work-ICM-


n Investigation

PgpServices PGPOverride 08-06-01

webwb Registration PGPOverride 08-06-01


js

UserServices PGPOverride 08-06-01

©2024 Pegasystems Inc


Pega Government Platform '24.1 41

Name Ruleset Ruleset version Applies to

CustomAuthenticati PGPOverride 08-06-01 Code-Security


on

CustomAuthVerifica PGPOverride 08-06-01 Code-Security


tion

Web-Login-Member PGPOverride 08-06-01 @baseclass

Web-Login-test PGPOverride 08-06-01 @baseclass

WebLoginMain PGPOverride 08-06-01 @baseclass

8.5 Withdrawn rules

The following table lists the withdrawn rules of Pega Government Platform for 8.5
release.

Name Ruleset Ruleset version Applies to

Inline PegaPS 08-05-01 PegaPS

Order PegaPS 08-05-01 PegaPS

SLAName PegaPS 08-05-01 Rule-PegaQ-


Questionnaire

pyCaption PegaPS 08-05-01 @baseclass


Investigation

wss normalizemin PegaPS 08-05-01


css

Settings PegaPS 08-05-01 PegaPS-Landing

AttachmentFeedDe PegaPS 08-05-01


scription

ProgressIndicator PegaPS 08-05-01

pyAttachmentFeed PegaPS 08-05-01


Description

©2024 Pegasystems Inc


Pega Government Platform '24.1 42

Name Ruleset Ruleset version Applies to

RangeSlider PegaPS 08-05-01

PGPFooter PegaPS 08-05-01 @baseclass

PgpNavigation PegaPS 08-05-01 @baseclass

PgpServices PegaPS 08-05-01 @baseclass

Pgpwebsiteheader PegaPS 08-05-01 @baseclass

ProcurementService PegaPS 08-05-01 @baseclass


s

Procurementswebsi PegaPS 08-05-01 @baseclass


teheader

SliderModalTemplat PegaPS 08-05-01 @baseclass


eStyles

ModalSlider PegaPS 08-05-01 PegaPS

Are you sure you PegaPS 08-05-01 PegaPS-Data-


want to delete from Address
this model?

Are you sure you PegaPS 08-05-01 PegaPS-Data-


want to delete from Association
this model?

Are you sure you PegaPS 08-05-01 PegaPS-Data-


want to delete from Education
this model?

Are you sure you PegaPS 08-05-01 PegaPS-Data-Entity-


want to delete from Person
this model?

Are you sure you PegaPS 08-05-01 PegaPS-Data-


want to delete from Training
this model?

©2024 Pegasystems Inc


Pega Government Platform '24.1 43

Name Ruleset Ruleset version Applies to

DocumentationRep PegaPS 08-05-01 PegaPS-Work


ort

pyCaseMain PegaPS 08-05-01 PegaPS-Work

pyB2CCaseMainConf PegaPS 08-05-01 PegaPS-Work


irm

EventDetails PegaPS 08-05-01 PegaPS-Work-Event-


Initiate

pyCaseMain PegaPS 08-05-01 Work-

AssessmentConfigu PegaPS 08-05-01 Rule-PegaQ-


ration Questionnaire

AssessmentConfigu PegaPS 08-05-01 Rule-PegaQ-


ration_RG Questionnaire

AssessmentList PegaPS 08-05-01 Rule-PegaQ-


Questionnaire

AssessmentList_RG PegaPS 08-05-01 Rule-PegaQ-


Questionnaire

AssessmentNoResu PegaPS 08-05-01 Rule-PegaQ-


lts Questionnaire

pyMainMenu PegaPS 08-05-01 Pega-Landing

pyCaption Agent PegaPS 08-05-01 @baseclass

pyCaption Airport PegaPS 08-05-01 @baseclass

pyCaption Any PegaPS 08-05-01 @baseclass

pyCaption High PegaPS 08-05-01 @baseclass

pyCaption Russian PegaPS 08-05-01 @baseclass

pyActionPrompt PegaPS 08-05-01 @baseclass


Click to collapse

©2024 Pegasystems Inc


Pega Government Platform '24.1 44

Name Ruleset Ruleset version Applies to

pyActionPrompt PegaPS 08-05-01 @baseclass


Click to expand

pyButtonLabel PegaPS 08-05-01 @baseclass


Request access

pyCaption Active PegaPS 08-05-01 @baseclass

pyCaption PegaPS 08-05-01 @baseclass


Administrator

pyCaption Apply PegaPS 08-05-01 @baseclass

pyCaption Approve PegaPS 08-05-01 @baseclass

pyCaption Audit PegaPS 08-05-01 @baseclass

pyCaption Blue PegaPS 08-05-01 @baseclass

pyCaption PegaPS 08-05-01 @baseclass


CaseManager

pyCaption PegaPS 08-05-01 @baseclass


CaseWorker

pyCaption Client PegaPS 08-05-01 @baseclass

pyCaption PegaPS 08-05-01 @baseclass


Compliant

pyCaption Critical PegaPS 08-05-01 @baseclass

pyCaption Current PegaPS 08-05-01 @baseclass


operator

pyCaption Custom PegaPS 08-05-01 @baseclass

pyCaption PegaPS 08-05-01 @baseclass


Customer

pyCaption days PegaPS 08-05-01 @baseclass

©2024 Pegasystems Inc


Pega Government Platform '24.1 45

Name Ruleset Ruleset version Applies to

pyCaption PegaPS 08-05-01 @baseclass


Dependent

pyCaption PegaPS 08-05-01 @baseclass


Description

pyCaption Details PegaPS 08-05-01 @baseclass

pyCaption PegaPS 08-05-01 @baseclass


Document

pyCaption E-Mail PegaPS 08-05-01 @baseclass

pyCaption Employer PegaPS 08-05-01 @baseclass

pyCaption English PegaPS 08-05-01 @baseclass

pyCaption Entity PegaPS 08-05-01 @baseclass


Type

pyCaption Event PegaPS 08-05-01 @baseclass

pyCaption PegaPS 08-05-01 @baseclass


Experience

pyCaption Expired PegaPS 08-05-01 @baseclass

pyCaption Fax PegaPS 08-05-01 @baseclass

pyCaption First PegaPS 08-05-01 @baseclass


Name

pyCaption French PegaPS 08-05-01 @baseclass

pyCaption German PegaPS 08-05-01 @baseclass

pyCaption Green PegaPS 08-05-01 @baseclass

pyCaption Home PegaPS 08-05-01 @baseclass

pyCaption Home PegaPS 08-05-01 @baseclass


phone

pyCaption I PegaPS 08-05-01 @baseclass

©2024 Pegasystems Inc


Pega Government Platform '24.1 46

Name Ruleset Ruleset version Applies to

pyCaption IN PegaPS 08-05-01 @baseclass

pyCaption Inactive PegaPS 08-05-01 @baseclass

pyCaption PegaPS 08-05-01 @baseclass


Individual

pyCaption Last PegaPS 08-05-01 @baseclass


Login

pyCaption Last PegaPS 08-05-01 @baseclass


Name

pyCaption Link PegaPS 08-05-01 @baseclass

pyCaption List PegaPS 08-05-01 @baseclass

pyCaption Low PegaPS 08-05-01 @baseclass

pyCaption Map PegaPS 08-05-01 @baseclass

pyCaption Price PegaPS 08-05-01 @baseclass

pyCaption Primary PegaPS 08-05-01 @baseclass

pyCaption Medium PegaPS 08-05-01 @baseclass

pyCaption months PegaPS 08-05-01 @baseclass

pyCaption PegaPS 08-05-01 @baseclass


Navigation

pyCaption Nearby PegaPS 08-05-01 @baseclass


Cases

pyCaption New PegaPS 08-05-01 @baseclass

pyCaption No PegaPS 08-05-01 @baseclass

pyCaption No PegaPS 08-05-01 @baseclass


attachments

pyCaption Notes PegaPS 08-05-01 @baseclass

©2024 Pegasystems Inc


Pega Government Platform '24.1 47

Name Ruleset Ruleset version Applies to

pyCaption PegaPS 08-05-01 PegaPS-Data-Entity-


Experience Person

pyCaption Last PegaPS 08-05-01 PegaPS-Data-Entity-


Login Person

pyCaption Last PegaPS 08-05-01 PegaPS-Data-Entity-


Name Person

pyCaption Open PegaPS 08-05-01 @baseclass

pyCaption Operator PegaPS 08-05-01 @baseclass

pyCaption Other PegaPS 08-05-01 @baseclass

pyCaption Others PegaPS 08-05-01 @baseclass

pyCaption Pager PegaPS 08-05-01 @baseclass

pyCaption Parent PegaPS 08-05-01 @baseclass

pyCaption Partner PegaPS 08-05-01 @baseclass

pyCaption Personal PegaPS 08-05-01 @baseclass

pyCaption Pink PegaPS 08-05-01 @baseclass

pyCaption Province PegaPS 08-05-01 @baseclass

pyCaption Question PegaPS 08-05-01 @baseclass

pyCaption Read- PegaPS 08-05-01 @baseclass


only

pyCaption Reassign PegaPS 08-05-01 @baseclass

pyCaption PegaPS 08-05-01 @baseclass


Reference

pyCaption Reject PegaPS 08-05-01 @baseclass

pyCaption Related PegaPS 08-05-01 @baseclass


Cases

©2024 Pegasystems Inc


Pega Government Platform '24.1 48

Name Ruleset Ruleset version Applies to

pyCaption PegaPS 08-05-01 @baseclass


Secondary

pyCaption Service PegaPS 08-05-01 @baseclass

pyCaption Services PegaPS 08-05-01 @baseclass

pyCaption Single PegaPS 08-05-01 @baseclass

pyCaption Specific PegaPS 08-05-01 @baseclass


user

pyCaption SSN PegaPS 08-05-01 @baseclass

pyCaption Storage PegaPS 08-05-01 @baseclass

pyCaption Take PegaPS 08-05-01 @baseclass


Action

pyCaption Target PegaPS 08-05-01 @baseclass

pyCaption Tenant PegaPS 08-05-01 @baseclass

pyCaption Timeline PegaPS 08-05-01 @baseclass

pyCaption Tip PegaPS 08-05-01 @baseclass

pyCaption Training PegaPS 08-05-01 @baseclass

pyCaption Update PegaPS 08-05-01 @baseclass

pyCaption User PegaPS 08-05-01 @baseclass


Name

pyCaption Users PegaPS 08-05-01 @baseclass

pyCaption PegaPS 08-05-01 @baseclass


Withdraw

pyCaption Work PegaPS 08-05-01 @baseclass


queue

pyCaption PegaPS 08-05-01 @baseclass


Workbasket

©2024 Pegasystems Inc


Pega Government Platform '24.1 49

Name Ruleset Ruleset version Applies to

pyCaption Yes PegaPS 08-05-01 @baseclass

WebLoginComplaint PegaPS 08-05-01 @baseclass


s

WebLoginPGP PegaPS 08-05-01 @baseclass

WebLoginProcurem PegaPS 08-05-01 @baseclass


ents

DeleteEducation PegaPS 08-05-01 PegaPS-Data-


Education

DeleteLocation PegaPS 08-05-01 PegaPS-Data-


Address

DeleteAssociation PegaPS 08-05-01 PegaPS-Data-


Association

AddToDeleteList PegaPS 08-05-01 PegaPS-Data-Entity-


Associate

DeleteRelation PegaPS 08-05-01 PegaPS-Data-Entity-


Person

DeleteTraining PegaPS 08-05-01 PegaPS-Data-


Training

PreAssessmentConf PegaPS 08-05-01 Rule-PegaQ-


iguration Questionnaire

RemoveTempId PegaPS 08-05-01 Rule-PegaQ-


Questionnaire

SetTempIdForNewR PegaPS 08-05-01 Rule-PegaQ-


ow Questionnaire

IsPGPApplications PegaPS 08-05-01 PegaPS-Data-


Context-Application

PegaPS_bkp_23Jun PegaPS 08-05-01

©2024 Pegasystems Inc


Pega Government Platform '24.1 50

Name Ruleset Ruleset version Applies to

AssessmentConfigu PegaPS 08-05-01 Rule-PegaQ-


rationExists Questionnaire

IsSampleData PegaPS 08-05-01 Rule-Admin-Product

PegaPS_UIKit7_07Jul PegaPS 08-05-01


y_bkp

LayoutGroup PegaPSUI 08-05-01 PegaPS

Footer PegaPSUserServices 08-05-01 PegaPS-Work-User-


Registration

Header PegaPSUserServices 08-05-01 PegaPS-Work-User-


Registration

Intake PGPCosmos 08-05-01 PegaPS-Work

Intake PGPCosmos 08-05-01 PegaPS-Work

.BuiltOnAppCSV PegaPSICM 08-05-01 PegaPS

InvestigationAssoci PegaPSICM 08-05-01


ationControl

ConfirmDeactivate PegaPSICM 08-05-01 PegaPS-Data-


Config-ActivityPlan

RelatedEntities PegaPSICM 08-05-01 PegaPS-Data-Entity

RelatedInvestigatio PegaPSICM 08-05-01 PegaPS-Work


nsVisual

RelatedAllEventsList PegaPSICM 08-05-01 PegaPS-Work-ICM

SubjectRelatedCase PegaPSICM 08-05-01 PegaPS-Work-ICM


sListAll

RelatedInvestigatio PegaPSICM 08-05-01 PegaPS-Work


nsVisual

RelatedAllSubjects PegaPSICM 08-05-01 PegaPS-Work-ICM

©2024 Pegasystems Inc


Pega Government Platform '24.1 51

8.4 Withdrawn rules

The following table lists the withdrawn rules of Pega Government Platform for 8.4
release.

Name Ruleset Ruleset version Applies to

ConfirmExternal PegaPS 08-04-01 PegaPS

ConfirmExternal PegaPS 08-04-01 PegaPS

Log off PegaPS 08-04-01 Code-Security

Database- PegaPS 08-04-01 @baseclass


Authorization-
NoModifyAccess

Database- PegaPS 08-04-01 @baseclass


Authorization-
NoOpenAccess

pyCaption Category PegaPS 08-04-01 @baseclass

pyCaption Create PegaPS 08-04-01 @baseclass

pyCaption Create PegaPS 08-04-01 @baseclass


new

pyCaption Email PegaPS 08-04-01 @baseclass

pyCaption Female PegaPS 08-04-01 @baseclass

pyCaption First PegaPS 08-04-01 @baseclass


Name

pyCaption Georgia PegaPS 08-04-01 @baseclass

pyCaption Male PegaPS 08-04-01 @baseclass

pyCaption My Cases PegaPS 08-04-01 @baseclass

pyCaption Name PegaPS 08-04-01 @baseclass

pyCaption Owner PegaPS 08-04-01 @baseclass

©2024 Pegasystems Inc


Pega Government Platform '24.1 52

Name Ruleset Ruleset version Applies to

pyCaption Person PegaPS 08-04-01 @baseclass

pyCaption Phone PegaPS 08-04-01 @baseclass

pyCaption Role PegaPS 08-04-01 @baseclass

pyCaption Search PegaPS 08-04-01 @baseclass

pyCaption Select an PegaPS 08-04-01 @baseclass


image

pyCaption Subject PegaPS 08-04-01 @baseclass

Web-Session- PegaPS 08-04-01 @baseclass


Return

Web-Session- PegaPS 08-04-01 @baseclass


Return

DisplayAttachmentF PegaPS 08-04-01 PegaPS


ile

pySecureFeatures PegaPS 08-04-01 @baseclass

ShowUploadAvatar PegaPS 08-04-01 PegaPS-Data-Entity-


Person

ShowUploadAvatar PegaPS 08-04-01 PegaPS-Data-Entity-


Vehicle

LocationRO PegaPSICM 08-04-01 PegaPS-Data-


Address

pyCaseDetails PegaPSICM 08-04-01 PegaPS-Work-


Manage

HaveDocumentDele PegaPSICM 08-04-01 Link-Attachment


tePrivileges

©2024 Pegasystems Inc


Pega Government Platform '24.1 53

8.3 Withdrawn rules

The following table lists the withdrawn rules of Pega Government Platform for 8.3
release.

Name Ruleset Ruleset version Applies to

PGPSampleData PegaPS 08-03-01


08.10

.Name.FullName PegaPS 08-03-01 PegaPS-Data-Entity-


Person

.Name.FullNameWit PegaPS 08-03-01 PegaPS-Data-Entity-


hSalutation Person

TreeNavigation7 PegaPS 08-03-01 PegaPS-Work

pyRDLPaginator PegaPS 08-03-01 PegaPS

Association PegaPS 08-03-01 PegaPS-Data-Entity

AssociationList PegaPS 08-03-01 PegaPS-Data-Entity

ViewCasesAction PegaPS 08-03-01 PegaPS-Data-Entity

AUTSetDataForMan PegaPS 08-03-01 PegaPS


ageMembersNewH
ousehold

AUTSetExistingHHM PegaPS 08-03-01 PegaPS


embersListData

AUTSetDataForMan PegaPS 08-03-01 PegaPS-Work


ageMembersUseCa
se2

AUTSetDataForMan PegaPS 08-03-01 PegaPS-Work


ageMembersUseCa
se3

©2024 Pegasystems Inc


Pega Government Platform '24.1 54

Name Ruleset Ruleset version Applies to

AUTSetDataForMan PegaPS 08-03-01 PegaPS-Work


ageMembersUseCa
se4

HasAssociations PegaPS 08-03-01 PegaPS-Data-Entity

ManageAssociates PegaPSICM 08-03-01 PegaPS-Work-


Manage-Associate

Association PegaPSICM 08-03-01 PegaPS-Data-Entity

MyWorkCasesList PegaPSICM 08-03-01 PegaPS-Data-Entity

Interview PegaPSICM 08-03-01 PegaPS-Work

pyCaseAssetsMobil PegaPSICM 08-03-01 PegaPS-Work


e

CustomAuditList PegaPSICM 08-03-01 PegaPS-Work-ICM

CustomAuditModal PegaPSICM 08-03-01 PegaPS-Work-ICM


Window

CustomAudit PegaPSICM 08-03-01 PegaPS-Work-ICM

pyRDLPaginator PegaPSICM 08-03-01 PegaPS-Work-ICM

Subject PegaPSICM 08-03-01 PegaPS-Work-ICM-


Investigation

pyCaseInformation PegaPSICM 08-03-01 PegaPS-Work-ICM-


Investigation-
Initiate

CheckDuplicateAsso PegaPSICM 08-03-01 PegaPS-Work-


ciation Manage-Associate

ShowInWork PegaPSICM 08-03-01 PegaPS

AddNote PegaPSICM 08-03-01 PegaPS-Work-ICM

CustomAudit PegaPSICM 08-03-01 PegaPS-Work-ICM

©2024 Pegasystems Inc


Pega Government Platform '24.1 55

Name Ruleset Ruleset version Applies to

pyDefault PegaPSICM 08-03-01 PegaPS-Work

InitializeInterview_E PegaPSICM 08-03-01 PegaPS-Work-ICM


xt

InitializeEvidence_E PegaPSICM 08-03-01 PegaPS-Work-ICM-


xt Investigation

PostEvidence_Ext PegaPSICM 08-03-01 PegaPS-Work-ICM-


Investigation

HasPrivilegeToMan PegaPSICM 08-03-01 PegaPS


ageAssociates

IsOperatorAuthoriz PegaPSICM 08-03-01 PegaPS


ed

IsInvestigation PegaPSICM 08-03-01 PegaPS-Work-ICM

IsSubject PegaPSICM 08-03-01 PegaPS-Work-ICM

8.2 Withdrawn rules

The following table lists the withdrawn rules of Pega Government Platform for 8.2
release.

Name Ruleset Ruleset version Applies to

Entity PegaPS 08-02-01 PegaPS-Work

pyGridPaginator PegaPS 08-02-01 Data-

AddNote PegaPS 08-02-01 PegaPS

Notes PegaPS 08-02-01 PegaPS

Notes PegaPS 08-02-01 PegaPS

Actions PegaPS 08-02-01 PegaPS-Data-Entity-


Facility

©2024 Pegasystems Inc


Pega Government Platform '24.1 56

Name Ruleset Ruleset version Applies to

Actions PegaPS 08-02-01 PegaPS-Data-Entity-


Household

Actions PegaPS 08-02-01 PegaPS-Data-Entity-


Vehicle

pyCaseHeaderTitle PegaPS 08-02-01 Work-

SaveNotes PegaPS 08-02-01 PegaPS

EditInterview PegaPS 08-02-01 PegaPS-Data-


Interview

AddNote PegaPS 08-02-01 PegaPS

EditEvidence PegaPS 08-02-01 PegaPS-Data-


Evidence

EditEvidence PegaPS 08-02-01 PegaPS-Work

EditInterview PegaPS 08-02-01 PegaPS-Work

PostAddNote PegaPS 08-02-01 PegaPS

PreAddNote PegaPS 08-02-01 PegaPS

PostEditInterview PegaPS 08-02-01 PegaPS-Data-


Interview

PreEditEvidence PegaPS 08-02-01 PegaPS-Work

PostEditEvidence PegaPS 08-02-01 PegaPS-Work

PostEditInterview PegaPS 08-02-01 PegaPS-Work

SetInterviewTitle PegaPS 08-02-01 PegaPS-Work

Notes PegaPSICM 08-02-01 PegaPS

NotesHeader PegaPSICM 08-02-01 PegaPS

ViewNotes PegaPSICM 08-02-01 PegaPS

SaveEvidenceAssoci PegaPSICM 08-02-01 PegaPS-Work


ations

©2024 Pegasystems Inc


Pega Government Platform '24.1 57

Name Ruleset Ruleset version Applies to

PersistEmbeddedPa PegaPSICM 08-02-01 PegaPS-Data-


ge Interview

PersistInterview PegaPSICM 08-02-01 PegaPS-Work

AddEvidence PegaPSICM 08-02-01 PegaPS-Work

EditEvidence PegaPSICM 08-02-01 PegaPS-Work

SetInterviewID PegaPSICM 08-02-01 PegaPS-Data-


Interview

InitializeInterview PegaPSICM 08-02-01 PegaPS-Work

SetInterviewTitle PegaPSICM 08-02-01 PegaPS-Work

InitializeInterview PegaPSICM 08-02-01 PegaPS-Work-ICM

8.1 Withdrawn rules

The following table lists the withdrawn rules of Pega Government Platform for 8.1
release.

Name Ruleset Ruleset version Applies to

ShowAttachmentLis PegaPS 08-01-01 PegaPS-Data-


t Attachment-File

GenerateVerificatio PegaPSUserServices 08-01-01 PegaPS-Work-User-


nCode Registration

©2024 Pegasystems Inc


Pega Government Platform '24.1 58

Pega Government Platform


Product overview
Pega Government Platform (PGP) provides a rich set of features designed to enhance
the customer experience, improve user productivity, and increase customer
satisfaction. The solution provides reusable components or processes that can be used
to build an application or case by using Pega App Studio or Pega Dev Studio.

• Product overview for Theme Cosmos

• Pega Government Platform Product overview for Constellation

Product overview for Theme Cosmos


Applies to Theme Cosmos. Pega Government Platform™ (PGP) provides a rich set of
reusable components or processes using section based UI that helps your business
build a strong presence across technologies and channels.

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.

• Application intake features

• Manage information features

• Case reviewer features

• Association management framework

• Entity profile views

• Investigative case management

• Pega Government Platform case types and workflows

©2024 Pegasystems Inc


Pega Government Platform '24.1 59

• Roles and portals

• Primary data entities

• Time management

• Further reading

Application intake features


Applies to Theme Cosmos. Government agencies provide different services catering to
their constituents. Constituents can be a person, business or any entity. PGP provides
the following application intake-oriented features:

Basic person information

A process that captures basic person information, validates it, and checks for the
presence of duplicate information.

Multiple entity component can be used to capture information of multiple person


entities as part of a single step in any case type.

Detailed person 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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 60

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.

Persist object component

A generic component that saves entity related information and data object information
in the system of record.

Capture experience

A process that captures the experience details of a person.

Capture training

A process that captures the training details of a person.

Capture location

A process that captures the location details of an entity.

Consent agreement

Consent agreement is a feature that displays an actionable consent agreement screen.


This screen contains customizable text for the agreement clauses of your organization,

©2024 Pegasystems Inc


Pega Government Platform '24.1 61

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 detailed Item information like Manufacturer, Owner,


Dimensions, subitems, and so on, validates it, and checks for the presence of duplicate
information.

Basic Item Information

A process that captures basic person information, validates it, and checks for the
presence of duplicate information.

Manage information features


Applies to Theme Cosmos. Use the following features to manage information about
entities related to any government case.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 62

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.

Manage household members

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.

Manage Basic Item

A process that manages the item basic details and stores the details in the system of
record.

©2024 Pegasystems Inc


Pega Government Platform '24.1 63

Manage business

A process that manages the business details and stores the details in the system of
record.

Manage person with basic details

A process that manages the person basic details and stores the details in the system of
record.

Manage person with complete details

A process that manages the person details and stores the details in the system of
record.

Manage multiple persons

A process that manages the multiple person details and stores the details in the system
of record.

Time entry

A process that logs time entry of a user against any case.

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 64

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.

As a part of the program configurator a user can create a License configuration a


specialized version of a program configurator by Providing data to set up a new license.
License Configuration is a Comprehensive and configurable application that
streamlines the licensing and certification application process from start to finish,
including evaluations, document upload and its verifications.

Program configurator provides users with the following capabilities:

• Provide seamless and simple processes for constituents, businesses, and agency
employees
• Reduce processing and minimize touch points to provide straight-through
processing

©2024 Pegasystems Inc


Pega Government Platform '24.1 65

• Provide a modern government platform to meet future requirements and allow


business users to make policy changes
• Reduce project implementation time and accelerate project delivery
• Improve communication and interaction with constituents and businesses

Program definition

Pega Government Platform (PGP) provides comprehensive and standardized program


management capabilities to accelerate development with transparency and
compliance. The Program definition case type in PGP helps define and manage
programs for government purposes and customize them as required. This case type
provides end-to-end capabilities for program management and configuration that
enable agencies to increase efficiency.

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.

Using program definition you can:

• Define new program

• Edit program

• Copy program

• Search for a 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

©2024 Pegasystems Inc


Pega Government Platform '24.1 66

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.

Case reviewer features


Applies to Theme Cosmos. Government case workers have various needs when
reviewing the case through its lifecycle. Pega Government Platform provides the
following features to aid the case review process that can be reused and customized to
meet your business needs.

Upload document component

Applies to Theme Cosmos. Upload document component allows users to upload


documents as part of any case. This component enables business users to dynamically
configure the documents to be uploaded for any case with configurations like
mandatory or non-mandatory documents, size of the documents.

Verify document component

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.

Nearby location component

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 67

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 68

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 configuration

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 69

Activity plan template

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.

Initiation and execution

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.

Activity plan usage

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 70

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.

Entity attachment for entities

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.

Mobile Offline features

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

Applies to Theme Cosmos. Internationalization enables a business architect or a


supervisor user to configure the list of countries, the respective state or province labels
that an application supports through a simple configuration. It also enables the phone
number format validation for different countries.

©2024 Pegasystems Inc


Pega Government Platform '24.1 71

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.

Association management framework


Applies to Theme Cosmos. An association is a relationship within entities and between
entity and case. Consider an investigation involving a car accident. The accident is
reported, and one person is injured. In this case, two person entities are associated
with the case (incident), the car driver as the Subject and the injured person as a victim.

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.

To represent such relationships, Pega Government Platform™ uses an association


framework, which allows you to capture relationships between the following objects:

Entity to entity

Husband and wife or an owner of a business.

Below are the some of the entity-to-entity associations available in PGP.

• Person entity - Person to Business, Person to Facility, Person to Vehicle, Person to


Item.
• Business entity - Business to Facility, Business to Vehicle, Business to Person,
Business to Item

Case to case

Assessments or Events for an investigation

©2024 Pegasystems Inc


Pega Government Platform '24.1 72

Below are some of the case-to-case associations available in PGP.

• Investigation case - Investigation to Subject, Investigation to Event, Investigation to


Investigation Subject case – Subject to Event, Subject to Investigation, and so on.

Entity to case

Victim of an accident, beneficiary to a grant. Below are some of the entity to case
associations available in PGP.

• Person - Person to Investigation, Item to Investigation, and so on.


• Vehicle - Vehicle to Subject, Business to Subject, and so on.

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.

• Investigation case - Investigation to Business, Investigation to Vehicle, etc.


• Subject case - Subject to Person, Subject to Facility, Subject to Vehicle, etc.

Entity preview for association widgets

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.

Entity profile views


Applies to Theme Cosmos. Pega Government Platform provides enhanced profile views
that contain comprehensive information about the entities like person entity, business
entity, vehicle entity, household entity, facility entity, item entity, and their related cases
as well as associations. The views are built of different widgets that allow the customer
to remove, re- arrange or add more widgets in similar patterns.

©2024 Pegasystems Inc


Pega Government Platform '24.1 73

Enhanced person profile view

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..

Enhanced Business profile view

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 74

Investigative case management


Applies to Theme Cosmos. The Investigative Case Management (ICM) application has
been built on Cosmos theme with the following enhancements:

• Event case has been converted to different stages and steps


• Investigation case has been converted to different stages and steps
• In the Event case type, feature of identifying the potential duplicate/related events
has been introduced
• In Event case type, for Child welfare event type, new field to capture child details
has been introduced and it creates a new subject from event review and
associates to the investigation case

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 75

Enhanced view of ICM Application

Event Case view

©2024 Pegasystems Inc


Pega Government Platform '24.1 76

Conduct Investigation

The Investigation case type provides end-to-end investigative case management


abilities that enable agencies to increase the efficiency of the investigation’s
management and resolution process. The Investigation Case Management case type
can be initiated as a standalone case type and also extends the Event case type. This
event case type specializes in initiating an investigation case allows field investigators to
accept ownership of the case and conduct the 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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 77

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.

Investigation Case view

ICM Report of Investigation

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,

©2024 Pegasystems Inc


Pega Government Platform '24.1 78

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 79

Investigation report

Operator Case Involvement (Touch) Reporting

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 80

A supervisor can generate the following reports:

• A touch point report for the supervisors to view their work.


• A supervisor report for touch points of team for investigation to view the work
done by the team members on the investigation case type.

Pega Government Platform case types and workflows


Applies to Theme Cosmos. This section describes the standard cases that are included
with Pega Government Platform and are available for selection within the New
Application wizard when you create your Pega Government Platform application.
Depending on your organization's needs, you may include all or a subset of these case
types in your application.

Example case types

Event case management

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

Investigative case management

Pega Government Platform includes an end-to-end investigative case management


application that enables organizations to improve the efficiency of the investigations
management and resolution process by reducing paperwork and providing a digital
platform. It provides the following capabilities:

• Event intake – enables the intake worker to capture event details and category,
and to send it for review.

©2024 Pegasystems Inc


Pega Government Platform '24.1 81

• 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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 82

• 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

Pega Government Platform includes an end-to-end complaints management


application which is available only in UI Kit version. It provides the following capabilities:

• 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

Pega Government Platform provides a case management-based application for


managing the procurement process which is available only in UI kit version. It provides
the following capabilities:

• Define specifications – enables the procurement officer to define specifications for


the new procurement.

©2024 Pegasystems Inc


Pega Government Platform '24.1 83

• 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.

Standard case types

Case Type Description

Add person Add details of a person entity and create a


person entity in the system

Add business Add details of a business entity and create a


business entity in the system

©2024 Pegasystems Inc


Pega Government Platform '24.1 84

Case Type Description

Add facility Add details of a facility entity and create a


facility entity in the system

Add vehicle Add details of a vehicle entity and create a


vehicle entity in the system

Add household Add details of a household entity and create


a household entity in the system

Add evidence Add details of evidence in the system

Add note Add details of note in the system

Add activity plan Create an activity plan case in the system

Activity plan template Allows users to manage the activity plan


template configurations

Add item Add details of an item entity and create an


item entity in the system

Application Request A process to file an application. For entities,


to request issue of a program or license

Conduct interview Add details of interview case in the system

Goal Create goal case in the system

Initiate event Add information about an event and create a


new event case in the system

Manage associations Allows users to manage all the associations


that are linked to the entities in the system

Initiate complaint Add information about a complaint and


create a new complaint in the system

Initiate procurement Add information about a procurement and


create a new procurement in the system

Initiate investigation Add information about an investigation and


create a new investigation in the system

©2024 Pegasystems Inc


Pega Government Platform '24.1 85

Case Type Description

Initiate subject Add information about a subject and create


a new subject in the system

Change password Provides an option to change the existing


password

Forgot password Provide an option to retrieve a forgotten


password

License Add details of license and persist to the


system

Program Add details of program and persist it to the


system

Question Provide an option to the users to ask


questions

Registration Create and register new user account in the


system

Transfer ownership Provides a capability for transferring the case


ownership to other users

Request access Enables the users to request access to a case


which is routed for approval

Merge Entity Provide an option to merge the potential


duplicates of Person Entity and/or Business
Entity

Manage Branches Manage the branches of business entity and


save it to the system

Manage Education Manage the education details linked to


person entity and save it to the system

Manage Experience Manage the experience details linked to


person entity and save it to the system

©2024 Pegasystems Inc


Pega Government Platform '24.1 86

Case Type Description

Manage Location Manage the location linked to any entity and


save it to the system

Manage Training Manage the training details linked to person


entity and save it to the system

Manage household members Manage the household members linked to


household entity and save it to the system

Program definition Provides capability for defining and


managing programs

Program finder Provides support for prescreening for the


programs

Subject Add details of a subject entity and persist it


to the system

Search Person Search a person entity in the system based


on search criteria like id, name

Search Business Search a business entity in the system based


on search criteria like id, name

Search Household Search a household entity in the system


based on search criteria

Search Event Search an event in the system based on


search criteria like id, name

Search Facility Search a facility entity in the system based


on search criteria like id, name

Search Vehicle Search a vehicle entity in the system based


on search criteria like id, name

Search Complaint Search a complaint in the system based on


search criteria like id, name

©2024 Pegasystems Inc


Pega Government Platform '24.1 87

Case Type Description

Search Investigation Search an investigation in the system based


on search criteria like id, name

Search Procurement Search a procurement in the system based


on search criteria like id, name

Task Create a task case in the system

Time entry Add details of a Time entry such as time


code, project code, reference id, hours, and
so on and persist it to the system

Update person Update the details of person entity and store


in the system

Update business Update the details of business entity and


persist it to the system

Update facility Update the details of facility entity and store


in the system

Update item Update the details of item entity and persist


it to the system

Update vehicle Update the details of vehicle entity and store


in the system

Update household details Update the details of household entity and


store in the system

View person View all the information of person profile in a


360-degree view

View business View all the information of business profile in


a 360-degree view

View household View all the information of household entity


in the system

©2024 Pegasystems Inc


Pega Government Platform '24.1 88

Case Type Description

View item View all the information of item profile in a


360-degree view .

View vehicle View all the information of a vehicle entity in


the system

View facility View all the information of a facility entity in


the system

View complaint View all the information of a complaint in the


system

View investigation View all the information of an investigation in


the system

View procurement View all the information of a procurement in


the system

Roles and portals


Applies to Theme Cosmos. Pega Government Platform (PGP) supports key roles
associated with your day-to-day use of the application. The table below describes the
key access roles provided with the Pega Government Platform.

Role name Description

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.

PGP Manager The manager views urgent work, and reviews


and approves workbasket items from the
PGP manager dashboard which serves as a
generic portal for any apps built on top of

©2024 Pegasystems Inc


Pega Government Platform '24.1 89

Role name Description

PGP. The manager also has an ability to


configure assessments.

Intake specialist The intake specialist creates events based on


reported information and views reports
about events intake. They use the templates
of the PGP Case worker dashboard and Pega
manager portal with reports specific to
intake.

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 90

Role name Description

manager portal with reports specific to


procurements cases.

Procurement Specialist The procurement specialist enters


specifications and evaluation criteria for the
procurement and reviews the procurement.
They use the templates of the PGP Manager
dashboard and Pega manager portal with
reports specific to procurements cases.

Procurement Supervisor The procurement supervisor reviews the


procurement plan details and approves/
rejects them. They use the templates of the
PGP Manager dashboard and Pega manager
portal with reports specific to procurements
cases.

Market Analyst The market analyst enters market analysis


details about the procurement using the
templates of the PGP Case worker
dashboard and Pega manager portal.

Procurement Manager The procurement manager awards the


procurement and oversees the work of the
entire team using the templates of the PGP
Manager dashboard and Pega manager
portal.

Vendor The vendor submits bids against a


procurement. Vendors use the self-service
portal.

©2024 Pegasystems Inc


Pega Government Platform '24.1 91

Role name Description

Complaints User
The complaints user can file a complaint
from their self-service portal as a
constituent.

Complaints Manager The complaints manager reviews filed


complaints and takes further action as well
as coordinates work for his or her team.
They will use the templates of the PGP
Manager dashboard and Pega manager
portal.

PGP End User


The PGP end user can view and manage
personal details like experience, education,
associations, training, address. They can also
initiate events from the self-service portal.

Primary data entities


Applies to Theme Cosmos. This section describes the data types that are used by Pega
Government Platform, stored in external systems or, where appropriate, internally to
the Pega system.

Name Description System of record (SOR)

Address Contains information Pega


pertaining to the address
details of a person,
business, facility, vehicle,
household, and associate.

©2024 Pegasystems Inc


Pega Government Platform '24.1 92

Name Description System of record (SOR)

Association Contains information Pega


pertaining to managing all
associations.

Assessment Contains information Pega


pertaining to the
configurations and creation
of assessment

Checklist Map Contains information Pega


pertaining to the checklist
items to be reviewed for
various applications.

Communication Pega
Contains information
pertaining to
communication

details, such as email, fax,


phone, social network, and
websites.

Complaint Contains attributes and Pega


information pertaining to
complaints filed by
constituents or businesses.

Configuration Contains information Pega


pertaining to the
configurations of an
address, country, state,
authorization, and
communication type.

©2024 Pegasystems Inc


Pega Government Platform '24.1 93

Name Description System of record (SOR)

Document Contains information Pega


pertaining to the document
intake and its verification

Education Contains information Pega


pertaining to the education
details of a person.

Entity Contains data pertaining to Pega


a business, associate,
person, vehicle, facility,
household, item, and place.

Experience Contains information Pega


pertaining to the experience
details of a person.

Evaluation Criteria Pega


Contains information
pertaining to the evaluation

criteria and evaluation


scores for different
applications.

Event Contains information Pega


pertaining to an event or an
incident.

Evidence Contains information Pega


pertaining to evidence.

Goal Contains information Pega


pertaining to goal.

Identifier Contains information Pega


pertaining to identifiers

©2024 Pegasystems Inc


Pega Government Platform '24.1 94

Name Description System of record (SOR)

such as passport, driver


license, SSN, or national ID.

Interview Contains information Pega


pertaining to an interview.

Investigation Contains information Pega


pertaining to an
investigation.

License config Contains information Pega


pertaining to license
configuration

Link Contains information Pega


pertaining to rules related
to linked data objects.

Note Contains information Pega


pertaining to case notes.

Plan Contains information Pega


pertaining to activity plan

Portal Contains information Pega


pertaining to the details to
be displayed on the portal
based on the entity type
(Person or Business) and
business requirement.

Procurement Contains attributes and Pega


information pertaining to
procurements.

©2024 Pegasystems Inc


Pega Government Platform '24.1 95

Name Description System of record (SOR)

Program Config Contains information Pega


pertaining to program
configuration

Project code Contains information Pega


pertaining to project code

Question Contains information Pega


pertaining to questions
submitted by end users.

Subject Contains information Pega


pertaining to a subject.

Task Contains information Pega


pertaining to task

Training Contains information Pega


pertaining to the training
details of a person.

Time code Contains information Pega


pertaining to time code.

Time entry log Contains information Pega


pertaining to time entry log
submitted by users.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 96

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 97

Manage Time - My Timesheet

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.

Manage time entry - Team timesheet

Roles in Time management

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 98

Role name Description

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.

For more information about Pega Government Platform, see https://docs.pega.com/


bundle/pega-government-platform/page/pega-government-platform/hub/government-
platform-get-started.html.

Pega Government Platform Product


overview for Constellation
Applies to Constellation. The Pega Government Platform (PGP) provides a rich set of
features designed to enhance customer experience, improve user productivity, and
increase customer satisfaction. The solution provides reusable components or
processes used to build an application or case by using Pega App Studio or Pega Dev
Studio.

• Features

• Roles and portals

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.

The key features of PGP include:

©2024 Pegasystems Inc


Pega Government Platform '24.1 99

• 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.

Entities supported by PGP are:

• 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.

Government agencies often need to capture details of constituents during processes,


for example, issuing a passport, granting funds, or tax filing. You can use Person entity
in PGP to implement various use cases.

©2024 Pegasystems Inc


Pega Government Platform '24.1 100

Person entity

The following are the business examples for Person entity:

Persona Action

Investigation officer Associate victim, suspect, or eyewitness to a hit and run case.

Department of Capture person details as part of driving license application.


transportation customer
service staff

Taxpayer Create your own profile on the department of tax site and use
the details to file tax returns every year.

Farmer Create a profile in the department of agriculture to apply for


grants.

Military Capture employee details of a Department Of Defense (DOD)


person, for deployments.

Reusable features

You can extend the following features in your application.

©2024 Pegasystems Inc


Pega Government Platform '24.1 101

Case type
• Person case type

View
• 360-person view
• Search person
• People landing page

Flow and flow action


• Basic person information

Person case type

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 102

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 103

edit or update person

360-person view

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 104

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 105

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.

create new person

People landing page

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 106

People landing page

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

Basic person information

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 107

You can use basic person as a Flow or Flow Action.

• 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.

Government agencies often need to capture details of businesses during processes


such as business registration or license issuance. You can efficiently capture and
manage details about businesses and organizations by using the business entity
feature.

The following are the examples for Business entity:

Persona Action

Investigation officer Associate a pharmaceutical company to a financial fraud


case .

Small business owner Applying online for a restaurant’s liquor license.

Procurement head View all vendor businesses eligible for office supplies.
Update the better business bureau about the new
branch opened in Massachusetts.

Reusable features

You can extend the following features in your application.

©2024 Pegasystems Inc


Pega Government Platform '24.1 108

Case type
• Business case type

View
• 360-business view

• Search businesses

• Businesses landing page

Flow and Flow Action


• Basic business information

Business case type

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 109

Create business case type

Contact person selection

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 110

• 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.

The available actions are:

• 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).

©2024 Pegasystems Inc


Pega Government Platform '24.1 111

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 112

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.

Business landing page

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 113

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.

Business landing page

Basic business information

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:

©2024 Pegasystems Inc


Pega Government Platform '24.1 114

• 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.

Here are some key business components in PGP:

• 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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 115

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

Investigation officer Capture person, business as subjects for the


case

Citizen Raise a concern for noise in neighborhood


and associate neighbor for playing loud
music at midnight

Reusable features

PGP Subject case type provides the following reusable features.

Case type
• Subject

View
• 360-subject view

• Subject landing page

Flow
• Create subject

Subject case type

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 116

Subject

• Existing: Choose Existing to associate an existing person or business with the


subject. Search for a person or business by providing their details. Select a person
or business from the displayed list.

• 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

©2024 Pegasystems Inc


Pega Government Platform '24.1 117

• Victim

• Witness

• Suspect

Business
• Area of interest

• Suspicious organization

• Target

Enter the subject details and click Submit to create a subject.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 118

Edit subject

Associate to Investigation

Choose Associate to Investigation to link a subject to an investigation. A list of all


available investigations is displayed. You can also search for an investigation using the
Search icon. Select an investigation from the list to associate the subject with the
selected 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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 119

360-subject view

Other actions

Other actions that can be performed on this screen:

Click the three dots on the left pane of the subject screen. You can perform the
following actions:

1. Change identification - Select this option to change identification from unknown


to known and vice versa. You can also change the identification between the two
entities (person or business). Consider P as a person entity and B as a business
entity. You can change the identity from P1 to P2 and B1 to B2.

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.

2. Associate to investigation - only authorized users can associate a subject case to


an investigation. For more details on authorized users, refer Investigation case.

©2024 Pegasystems Inc


Pega Government Platform '24.1 120

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.

The following are the business examples of an interview case.

©2024 Pegasystems Inc


Pega Government Platform '24.1 121

Persona Action

Investigation case supervisor Interview the suspect of a hit and run case

Recruitment manager Setup interviews for candidates for an open


position

Reusable features

PGP interview case provides the following reusable features.

Case type
• Interview case type

View
• 360-interview view

• Interview list view

Flow
• Create interview

Interview case type

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 122

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:

• Start the interview

• 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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 123

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 124

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 125

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

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.

Interview template component enables users to create pre-defined set of open-ended


questions and answer format - short text, long text, and rich text, for an interview.
Interviewer can ask these questions during the interview and capture responses.

The following are the business examples for templates feature.

Persona Action

Investigation officer See all the list of questions to be asked in the


interview based on the template chosen.

Reusable features

PGP interview template provides the following reusable features.

©2024 Pegasystems Inc


Pega Government Platform '24.1 126

Case type
• Create interview template

View
• 360-interview template view
• Template landing page

Templates 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.

Templates landing page

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 127

Create interview template

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 128

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.

The following is the business example for evidence case type:

©2024 Pegasystems Inc


Pega Government Platform '24.1 129

Persona Action

Investigation officer
Associate the evidence to the investigation

Reusable features

PGP Person entity provides the following reusable features.

Case type
• Create evidence

View
• 360-evidence view

Flow
• Create evidence

Evidence case type

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 130

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 131

Edit evidence

360-Evidence view

Pega Government Platform (PGP) enables you to view a comprehensive 360-degree of


the evidence. Once evidence is created, the system displays details, including captured
evidence information, evidence type, associated investigation, and attachments, if any.

360-evidence view

©2024 Pegasystems Inc


Pega Government Platform '24.1 132

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.

Related evidence list

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.

The following are the business examples for associations:

Persona Action

Investigation officer Create or view associations of a hit and run


case victim with suspects, witness, and prior
accidents on those intersections.

Restaurant license approver manager Check the history of all owners and their
prior businesses and violations by owners
and their businesses, before approving.

©2024 Pegasystems Inc


Pega Government Platform '24.1 133

Persona Action

Child welfare worker Verify child's biological and foster parents'


relationship and history of any cases against
them.

To represent such relationships, Pega Government Platform uses an association


framework, which allows you to capture relationships between the following objects:

• Entity to Entity: Associate spouse and children to primary insurer

• Case to Case: Associate subjects with investigation

• Case to Entity: Associate subject to person or a business

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

PGP provides the following reusable features in Associations.

Case type
• Manage associations

©2024 Pegasystems Inc


Pega Government Platform '24.1 134

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

Associations list view

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.

Automatic associations: Automatic associations in Pega Government Platform (PGP)


enables the system to automatically link between the related entities and cases,
streamline process, and improve efficiency.

©2024 Pegasystems Inc


Pega Government Platform '24.1 135

Manual associations: Manual associations in Pega Government Platform (PGP) allows


you to manually link related entities and cases and provides flexibility in managing the
processes and data.

Associations list view

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.

Government journeys supported by PGP include:

• Incident

• Investigative Case Management

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 136

register, process the reported incident and help government organizations improve the
resolution process.

Incident case type provides the following capabilities:

• 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

Teacher Report an incident to the school safety office


about a suspicious bag found in the bus loop
of the school.

Employee Create an incident to report discrimination


complaint against a colleague at office.

Traffic inspector Create an incident to report traffic signal not


working

Citizen Report an incident to prevent accidents


caused by potholes and to take certain
action.

Reusable features

You can extend the following features in your application.

©2024 Pegasystems Inc


Pega Government Platform '24.1 137

Case type
• Incident case type

View
• 360-incident view

• Incident landing page

Incident case type

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 138

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 139

Edit incident

Review reported 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.

The available actions are:

• Approve: Approve the incident if the details entered are valid and act accordingly.

• Reject: Reject an incident when there is a similar duplicate incident (after


associating the potentially related incident with the current incident) or if the
incident is not valid.

• Return: Return to the incident if it is rejected and must be revisited to act.

Incident case management is implemented on Investigative case management (ICM)


application. By default, incident review screen displays the following review actions in
ICM application.

• Open an investigation

• Associate to an existing investigation

©2024 Pegasystems Inc


Pega Government Platform '24.1 140

• Need additional information

• Issue a warning

• No Action needed

• Invalid incident

• Duplicate incident

Review incident

Associate incident with other cases

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 141

360-incident view

Incident landing page

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.

Incident list view

Investigative Case Management


Applies to Constellation. Pega Government Platform (PGP) offers the Investigative case
management process to orchestrate all aspects of investigations right from initiating

©2024 Pegasystems Inc


Pega Government Platform '24.1 142

the investigation through subject management, conducting interviews, capturing


evidence, adding notes and more. Additionally provides automated audit trials, views of
relationships with entities, cases and all associations, to help navigate the investigation
to a closure.

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 list details some features of ICM:

• Create investigations either standalone or from an incident.


• Capture details for a case by using components such as interviews, evidence, and
subjects.
• Set user authorization and define how they search for and view cases.

The following are the business examples for investigation case management:

Persona Action

FBI agent
Investigate an incident and work on the
following items:

• Associate items and people with the


case.

• Conduct witness interviews.

• Collaborate with other internal and


external officers.
• Conclude the investigation and submit
a report.

Fraud investigator Investigate a case of fraud involving Covid-19


relief funds for businesses, collaborate with

©2024 Pegasystems Inc


Pega Government Platform '24.1 143

Persona Action

various agencies, and submit an


investigation report.

Child welfare state employee Investigate complaint of a child by looking at


relationships with biological parents and
foster parents and review any earlier
complaints or investigations involving them.

Reusable features

ICM provides the following reusable features.

Case type
• Investigation case type

View
• 360-investigation view

• Investigation landing page

Investigation case type

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 144

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 145

Edit investigation

360-Investigation view

360-degree view of an Investigation displays the complete details of an investigation.


After creating an investigation, select the investigation case type to view its details.

The 360-degree view displays information such as investigation name, investigation


details, case open date and time, reported activity, address, and ID. You can view the
associations, subjects, evidence, and interview associated to the selected investigation.
You can view the attachments, if any, from widgets (right pane).

©2024 Pegasystems Inc


Pega Government Platform '24.1 146

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 147

Note: Interview case type is extended as per investigation case type.To


interview a subject (person) associated to an investigation case, select the
known subject (person) as a participant when initiating an interview.

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.

To generate a case summary, follow these steps:

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 148

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.

Investigation landing page

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.

Investigations landing page

©2024 Pegasystems Inc


Pega Government Platform '24.1 149

Roles and portals


Applies to Constellation. Pega Government Platform (PGP) supports key roles
associated with your day-to-day use of the application. The table below describes the
key access roles provided with the Pega Government Platform.

Role name Description

PGP Case worker Pega Government Platform case worker can


add new entities to the system, manage the
entity information, and view reports from the
web portal.

PGP Manager The manager views urgent work, and reviews


and approves workbasket items from the
web portal which serves as a generic portal
for any apps built on top of PGP.

Intake specialist The intake specialist initiates incident on


behalf of reporter.

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,

©2024 Pegasystems Inc


Pega Government Platform '24.1 150

Role name Description

analyze data, and provide guidance to


investigaton agents.

©2024 Pegasystems Inc


Pega Government Platform '24.1 151

Install
• Installation guide for Traditional application

• Installation guide for Constellation

Installation guide for Traditional application


• Completing the prerequisite tasks

• Backing up your system

• Installing the application

Completing the prerequisite tasks


Applies to Theme Cosmos. Before you Install your application, ensure that you
complete all of the following tasks.

1. Consult with your database administrator to determine whether the installation


process can make automatic changes to the database schema. Alternatively, the
database administrator may need to manually apply the DDL files that include
schema changes.
2. Install the latest version of Pega Platform 24.1, and ensure that you can log in as
an administrator. For more information, see the Pega Platform Install Guide for
your environment on the Deploy Pega Platform page.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 152

Backing up your system


Applies to Theme Cosmos. When installing or updating an application, back up your
system after each step to ensure that you can revert to the last working version of the
system if you encounter an issue.

Note: The deployment process modifies both the data schema and the rules
schema. Use a backup procedure that preserves both schemas.

1. Verify that all rules are checked in.


2. Shut down the Pega Platform™ application server.
3. Use your database utilities to complete an offline backup of the Pega database.
4. Back up the configuration and environment files.
If you edited any of the following Pega Platform configuration files in the APP-
INF\classes directory of an EAR deployment, or the WEB-INF\classes
directory of a WAR deployment, include these files in the backup:
• prbootstrap.properties
• prconfig.xml
• logging file: prlogging.xml or prlog4j2.xml
• web.xml
• pegarules.keyring or any other .keyring files
5. Back up any third-party or custom JAR files that you installed.
Redeploying the Pega Platform applications might delete these files from your
application server.

Installing the application


Applies to Theme Cosmos. To install Pega Government Platform, import the application
file, and then complete the additional procedures outlined.

©2024 Pegasystems Inc


Pega Government Platform '24.1 153

Before you begin:

Make sure that you complete the prerequisites for this application installation.

• Importing common application file

• Importing common government application file

• Importing Pega Government Platform application file

• Creating a system administrator operator

• Creating operator accounts

• Updating event listeners

• Optional: Importing the sample data

• Optional: Enabling sample operator accounts

• Optional: Installing sample application

Importing common application file


Applies to Theme Cosmos. The system data and rulesets for Common application are
loaded during this task.

1. Log in to (https://<hostname>:<port>/prweb) 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 Configure > Application > Distribution > Import.
3. Select the /Rules/Common.jar file from your distribution media, and then
follow the wizard instructions.
4. For schema changes, depending on your site's requirements, select either
Automatic or Manual, and then continue following the wizard instructions. If you
select Manual, see Viewing and applying schema changes.

©2024 Pegasystems Inc


Pega Government Platform '24.1 154

5. When the import is complete, click Done.


6. Import the picklist reference data used by data objects within the common
application by following these steps.
a. In the header of Dev Studio, click Configure > Application > Distribution >
Import.
b. Select the /ResourceKit/CommonReferenceData.jar file from your
distribution media, and then follow the wizard instructions.
c. When the import is complete, click Done.

Importing common government application file


Applies to Theme Cosmos. The system data and rulesets for Common application are
loaded during this task.

1. Log in to (https://<hostname>:<port>/prweb) 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 Configure > Application > Distribution > Import.
3. Select the /Rules/Common-Government.jar file from your distribution media,
and then follow the wizard instructions.
4. For schema changes, depending on your site's requirements, select either
Automatic or Manual, and then continue following the wizard instructions. If you
select Manual, see Viewing and applying schema changes.
5. When the import is complete, click Done.
6. Import the picklist reference data used by data objects within the common
government application by following these steps.
a. In the header of Dev Studio, click Configure > Application > Distribution >
Import.
b. Select the /ResourceKit/CommonGovtReferenceData.jar file from
your distribution media, and then follow the wizard instructions.
c. When the import is complete, click Done.

©2024 Pegasystems Inc


Pega Government Platform '24.1 155

Importing Pega Government Platform application file


Applies to Theme Cosmos. The system data and rulesets for Pega Government Platform
are loaded during this task.

1. Log in to (https://<hostname>:<port>/prweb) 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 Configure > Application > Distribution > Import.
3. Select the /Rules/PegaGP.jar file from your distribution media, and then follow
the wizard instructions.
4. For schema changes, depending on your site's requirements, select either
Automatic or Manual, and then continue following the wizard instructions.
If you select Manual, see Viewing and applying schema changes.
5. On the Aged Updates screen, select the Import aged updates checkbox, and then
click Next.
6. When the import is complete, click Done.
7. Import the picklist reference data that is used by data objects within the Pega
Government Application by following these steps.
a. Select the /OptionalComponents/PegaGP_ReferenceData.jar file
from your distribution media, and then follow the wizard instructions.
b. When the import is complete, click Done.
8. Apply the required hotfixes by using Hotfix Manager. For more information about
applying hotfixes, see Applying the latest on-premises patch.
9. Verify the CommonDataModel service package settings
a. In the navigation pane, click Records > Integration Resources > Service
Package.
b. Open CommonDataModel rule and verify if the Service access group is
PegaGovt:Authors. If not, update the value to PegaGovt:Authors.
10. Optional: Verify the application rules.
a. In the navigation pane of , click Records > Application Definition >
Application.

©2024 Pegasystems Inc


Pega Government Platform '24.1 156

b. Confirm that the following application rule is displayed in the list:


• PegaGovt 8
• PegaGovtICM 8
• PegaGPCosmos 8
• PGPICMCosmos 8
• TimeMgmt 8
• PegaGP 8
• PGPICM 8
• PGPContracts 8
• PGPComplaints 8

Creating a system administrator operator


Applies to Theme Cosmos. Create a system administrator operator for Pega
Government Platform by completing the following steps:

1. Log in to (https://<hostname>:<port>/prweb) 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 Create > Organization > Operator ID.
3. Enter a short description, for example, pgpsysadmin, and then click Create and
open.
4. In the Application Access section, enter the access group
PegaGPCosmos:Administrators.
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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 157

Creating operator accounts


Applies to Theme Cosmos. If DWA (Directed Web Access) and Listener functionality are
used in your application, make sure that the following operators are available in the
environment.

OperatorID Access Group Team Starting activity

ICMEventListener PGPICMCosmos:IC IntakeSpecialist Data-


MIntakeSpecialist Portal.ShowDeskto
p

PGPEventListener PegaGPCosmos:Cas default@PegaPS Data-


eWorker Portal.ShowDeskto
p

RequestAccessEmai PGPICMCosmos:Ad default@PegaPS Data-


lApproval ministrator Portal.ShowDeskto
p

ICMInvestigationList PGPICMCosmos:Ad default@PegaPS Data-


ener ministrator Portal.ShowDeskto
p

For UI Kit apps: For applications built on UI Kit.

OperatorID Access Group Work Group Starting activity

ExternalUserP PegaGP:Caseworker Default Data-Portal.ShowDesktop


GP

ExternalUserC PegaGP:ComplaintsWo Default Data-Portal.ShowDesktop


omp rker

ExternalUserIC PegaGP:ICMAgent Default Data-Portal.ShowDesktop


M

ExternalUserPr PegaGP:Procurements Default Data-Portal.ShowDesktop


oc Worker

©2024 Pegasystems Inc


Pega Government Platform '24.1 158

OperatorID Access Group Work Group Starting activity

ICMInvestigati PegaGP:ICMAdmin default@Peg Data-Portal.ShowDesktop


onListener aPS

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.

Updating event listeners


Applies to Theme Cosmos. Pega Government Platform has a set of event listeners.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 159

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

Optional: Importing the sample data


Applies to Theme Cosmos. The distribution media includes sample data to help you
explore the application capabilities. The sample data includes disabled sample
operators that you can enable to learn about the workspaces for each operator role.
Importing the sample data is optional, and the sample data that is provided might not
align with your business needs.

Before you begin:

Ensure that you have already imported the application file.

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.

Optional: Enabling sample operator accounts


Applies to Theme Cosmos. If you imported the sample data, operators are included that
allow you to access the sample data. For security purposes, sample operators are
disabled by default.

©2024 Pegasystems Inc


Pega Government Platform '24.1 160

To enable the sample operators, complete the following steps.

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.

Optional: Installing sample application


Applies to Theme Cosmos. Pega Government Platform (PGP) includes four sample
applications within the distribution media such as ICM Demo (Theme Cosmos), ICM
Demo (Constellation), PGP Demo, and Grants.

To install the sample application, complete the following steps:

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.

Installation guide for Constellation


• Completing the prerequisite tasks

• Backing up your system

• Installing the application

©2024 Pegasystems Inc


Pega Government Platform '24.1 161

Completing the prerequisite tasks


Applies to Constellation. Before you Install your application, ensure that you complete
all of the following tasks.

1. Consult with your database administrator to determine whether the installation


process can make automatic changes to the database schema. Alternatively, the
database administrator may need to manually apply the DDL files that include
schema changes.
2. Install the latest version of Pega Platform 24.1, and ensure that you can log in as
an administrator. For more information, see the Pega Platform Install Guide for
your environment on the Deploy Pega Platform page.

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.

Backing up your system


Applies to Constellation. When installing or updating an application, back up your
system after each step to ensure that you can revert to the last working version of the
system if you encounter an issue.

Note: The deployment process modifies both the data schema and the rules
schema. Use a backup procedure that preserves both schemas.

1. Verify that all rules are checked in.


2. Shut down the Pega Platform™ application server.
3. Use your database utilities to complete an offline backup of the Pega database.

©2024 Pegasystems Inc


Pega Government Platform '24.1 162

4. Back up the configuration and environment files.


If you edited any of the following Pega Platform configuration files in the APP-
INF\classes directory of an EAR deployment, or the WEB-INF\classes
directory of a WAR deployment, include these files in the backup:
• prbootstrap.properties
• prconfig.xml
• logging file: prlogging.xml or prlog4j2.xml
• web.xml
• pegarules.keyring or any other .keyring files
5. Back up any third-party or custom JAR files that you installed.
Redeploying the Pega Platform applications might delete these files from your
application server.

Installing the application


Applies to Constellation. To install Pega Government Platform, import the application
file, and then complete the additional procedures outlined.

Before you begin:

Make sure that you complete the prerequisites for this application installation.

• Importing common application file

• Importing common government application file

• Importing Pega Government Platform application file

• Creating a system administrator operator

• Configuring OAuth 2.0 and setting the application URI

• Optional: Importing the sample data

• Optional: Installing sample application

©2024 Pegasystems Inc


Pega Government Platform '24.1 163

Importing common application file


Applies to Constellation. The system data and rulesets for Common application are
loaded during this task.

1. Log in to (https://<hostname>:<port>/prweb) 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 Configure > Application > Distribution > Import.
3. Select the /Rules/Common.jar file from your distribution media, and then
follow the wizard instructions.
4. For schema changes, depending on your site's requirements, select either
Automatic or Manual, and then continue following the wizard instructions. If you
select Manual, see Viewing and applying schema changes.
5. When the import is complete, click Done.
6. Import the picklist reference data used by data objects within the common
application by following these steps.
a. In the header of Dev Studio, click Configure > Application > Distribution >
Import.
b. Select the /ResourceKit/CommonReferenceData.jar file from your
distribution media, and then follow the wizard instructions.
c. When the import is complete, click Done.

Importing common government application file


Applies to Constellation. The system data and rulesets for Common application are
loaded during this task.

1. Log in to (https://<hostname>:<port>/prweb) 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 Configure > Application > Distribution > Import.

©2024 Pegasystems Inc


Pega Government Platform '24.1 164

3. Select the /Rules/Common-Government.jar file from your distribution media,


and then follow the wizard instructions.
4. For schema changes, depending on your site's requirements, select either
Automatic or Manual, and then continue following the wizard instructions. If you
select Manual, see Viewing and applying schema changes.
5. When the import is complete, click Done.
6. Import the picklist reference data used by data objects within the common
government application by following these steps.
a. In the header of Dev Studio, click Configure > Application > Distribution >
Import.
b. Select the /ResourceKit/CommonGovtReferenceData.jar file from
your distribution media, and then follow the wizard instructions.
c. When the import is complete, click Done.

Importing Pega Government Platform application file


Applies to Constellation. The system data and rulesets for Pega Government Platform
are loaded during this task.

1. Log in to (https://<hostname>:<port>/prweb) 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 Configure > Application > Distribution > Import.
3. Select the /Rules/PegaGP.jar file from your distribution media, and then follow
the wizard instructions.
4. For schema changes, depending on your site's requirements, select either
Automatic or Manual, and then continue following the wizard instructions.
If you select Manual, see Viewing and applying schema changes.
5. On the Aged Updates screen, select the Import aged updates checkbox, and then
click Next.
6. When the import is complete, click Done.
7. Import the picklist reference data that is used by data objects within the Pega
Government Application by following these steps.

©2024 Pegasystems Inc


Pega Government Platform '24.1 165

a. Select the /OptionalComponents/PegaGP_ReferenceData.jar file


from your distribution media, and then follow the wizard instructions.
b. When the import is complete, click Done.
8. Apply the required hotfixes by using Hotfix Manager. For more information about
applying hotfixes, see Applying the latest on-premises patch.
9. Verify the CommonDataModel service package settings
a. In the navigation pane, click Records > Integration Resources > Service
Package.
b. Open CommonDataModel rule and verify if the Service access group is
PegaGovt:Authors. If not, update the value to PegaGovt:Authors.
10. Optional: Verify the application rules.
a. In the navigation pane of , click Records > Application Definition >
Application.
b. Confirm that the following application rule is displayed in the list:
• PegaGovt 8
• PegaGovtICM 8
• PegaGPCosmos 8
• PGPICMCosmos 8
• TimeMgmt 8
• PegaGP 8
• PGPICM 8
• PGPContracts 8
• PGPComplaints 8

Creating a system administrator operator


Applies to Constellation. Create a system administrator operator for Pega Government
Platform by completing the following steps:

1. Log in to (https://<hostname>:<port>/prweb) 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 Create > Organization > Operator ID.

©2024 Pegasystems Inc


Pega Government Platform '24.1 166

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.

Configuring OAuth 2.0 and setting the application URI


Applies to Constellation. The sample data to access the Pega Government Platform
(PGP) API services and perform data operations, set the web address for the endpoint
URI of your application, and configure OAuth security settings.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 167

Note: For the implementation application to work and your rulesets to


be selected, you must set up OAuth with the appropriate access group
and update the SetCDMAuthenticationProfile with the correct authorization
profile.

Optional: Importing the sample data


Applies to Constellation. The distribution media includes sample data to help you
explore the application capabilities. The sample data includes people, business data,
and their relations information. Importing the sample data is optional, and the
provided sample data might not align with your business needs. Do not import sample
data into staging or production environments.

Before you begin:

Log in to the application as an operator who has the PegaGovt:Authors access


group. For more information about how to create operators, see Creating an
operator ID. For more information about access groups included with the
application, see Access groups included with the application.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 168

e. Click Save.

CDM - Entity data filters

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: Installing sample application


Applies to Constellation. Pega Government Platform (PGP) includes four sample
applications within the distribution media such as ICM Demo (Theme Cosmos), ICM
Demo (Constellation), PGP Demo, and Grants.

©2024 Pegasystems Inc


Pega Government Platform '24.1 169

To install the sample application, complete the following steps:

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 170

Update
• Completing the prerequisite tasks

• Backing up your system

• Updating the application

Completing the prerequisite tasks


Applies to Theme Cosmos. Before you Update your application, ensure that you
complete all of the following tasks.

1. Consult with your database administrator to determine whether the update


process can make automatic changes to the database schema. Alternatively, the
database administrator may need to manually apply the DDL files that include
schema changes.
2. Update to the latest version of Pega Platform 24.1, and ensure that you can log in
as an administrator. For more information, see the Pega Platform Update Guide for
your environment on the Deploy Pega Platform page.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 171

Backing up your system


When installing or updating an application, back up your system after each step to
ensure that you can revert to the last working version of the system if you encounter an
issue.

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.

1. Verify that all rules are checked in.


2. Shut down the Pega Platform™ application server.
3. Use your database utilities to complete an offline backup of the Pega database.
4. Back up the configuration and environment files.
If you edited any of the following Pega Platform configuration files in the APP-
INF\classes directory of an EAR deployment, or the WEB-INF\classes
directory of a WAR deployment, include these files in the backup:
• prbootstrap.properties
• prconfig.xml
• logging file: prlogging.xml or prlog4j2.xml
• web.xml
• pegarules.keyring or any other .keyring files
5. Back up any third-party or custom JAR files that you installed.

©2024 Pegasystems Inc


Pega Government Platform '24.1 172

Redeploying the Pega Platform applications might delete these files from your
application server.

Updating the application


To update Pega Government Platform, import the application file, and then complete
the additional procedures outlined.

Before you begin:

Make sure that you complete the prerequisites for this application update.

• Importing common application file

• Importing common government application file

• Importing Pega Government Platform application file

• Optional: Configuring OAuth 2.0 and setting the application URI

• Creating operator accounts

• Optional: Importing the sample data (PGP Constellation)

• Optional: Importing the sample data (PGP traditional application)

• Updating data from integration layer to data layer

• App Studio compliance changes

• Extending new case types in implementation layer

• Modifying class context data transform rule

• Modifying business context data transform rule

• Enabling operator creation in user registration functionality

©2024 Pegasystems Inc


Pega Government Platform '24.1 173

• Optimized properties

• Elasticsearch

• Performance mode

• Event life cycle changes in Pega Government Platform

• IACAuthentication service

• IACAuthentication activity

• Changes to entity search data pages in Pega Government Platform

• Updating case edit actions

• Changes to Registration.js

• Changes to Unique ID generation

• Queue processor for sending emails

• Security policies for password validation in user registration

• History and Field audit for entities

• Skip entity persistence in entity flows

• New declare indexes

• Changes to VIS.JS

• Activity plan life cycle changes

• Backward compatibility for Program configuration

• Time management lifecycle changes

• Moving countries and states

©2024 Pegasystems Inc


Pega Government Platform '24.1 174

Importing common application file


The system data and rulesets for Common application are loaded during this task.

1. Log in to (https://<hostname>:<port>/prweb) 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 Configure > Application > Distribution > Import.
3. Select the /Rules/Common.jar file from your distribution media, and then
follow the wizard instructions.
4. For schema changes, depending on your site's requirements, select either
Automatic or Manual, and then continue following the wizard instructions. If you
select Manual, see Viewing and applying schema changes.
5. When the import is complete, click Done.
6. Import the picklist reference data used by data objects within the common
application by following these steps.
a. In the header of Dev Studio, click Configure > Application > Distribution >
Import.
b. Select the /ResourceKit/CommonReferenceData.jar file from your
distribution media, and then follow the wizard instructions.
c. When the import is complete, click Done.

Importing common government application file


The system data and rulesets for Common application are loaded during this task.

1. Log in to (https://<hostname>:<port>/prweb) 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 Configure > Application > Distribution > Import.
3. Select the /Rules/Common-Government.jar file from your distribution media,
and then follow the wizard instructions.

©2024 Pegasystems Inc


Pega Government Platform '24.1 175

4. For schema changes, depending on your site's requirements, select either


Automatic or Manual, and then continue following the wizard instructions. If you
select Manual, see Viewing and applying schema changes.
5. When the import is complete, click Done.
6. Import the picklist reference data used by data objects within the common
government application by following these steps.
a. In the header of Dev Studio, click Configure > Application > Distribution >
Import.
b. Select the /ResourceKit/CommonGovtReferenceData.jar file from
your distribution media, and then follow the wizard instructions.
c. When the import is complete, click Done.

Importing Pega Government Platform application file


The system data and rulesets for Pega Government Platform are loaded during this
task.

1. Log in to (https://<hostname>:<port>/prweb) 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 Configure > Application > Distribution > Import.
3. Select the /Rules/PegaGP.jar file from your distribution media, and then follow
the wizard instructions.
4. For schema changes, depending on your site's requirements, select either
Automatic or Manual, and then continue following the wizard instructions.
If you select Manual, see Viewing and applying schema changes.
5. On the Aged Updates screen, select the Import aged updates checkbox, and then
click Next.
6. When the import is complete, click Done.
7. Import the picklist reference data that is used by data objects within the Pega
Government Application by following these steps.
a. Select the /OptionalComponents/PegaGP_ReferenceData.jar file
from your distribution media, and then follow the wizard instructions.

©2024 Pegasystems Inc


Pega Government Platform '24.1 176

b. When the import is complete, click Done.


8. Apply the required hotfixes by using Hotfix Manager. For more information about
applying hotfixes, see Applying the latest on-premises patch.
9. Verify the CommonDataModel service package settings
a. In the navigation pane, click Records > Integration Resources > Service
Package.
b. Open CommonDataModel rule and verify if the Service access group is
PegaGovt:Authors. If not, update the value to PegaGovt:Authors.
10. Optional: Verify the application rules.
a. In the navigation pane of , click Records > Application Definition >
Application.
b. Confirm that the following application rule is displayed in the list:
• PegaGovt 8
• PegaGovtICM 8
• PegaGPCosmos 8
• PGPICMCosmos 8
• TimeMgmt 8
• PegaGP 8
• PGPICM 8
• PGPContracts 8
• PGPComplaints 8

Optional: Configuring OAuth 2.0 and setting the


application URI
Starting from version 24.1, Pega Government Platform (PGP) is offered in the
constellation variant as well. Implement these steps only if you want to use the
constellation version of PGP after the upgrade; otherwise, these steps are optional. Use
the sample data to access the Pega PGP API services and perform data operations, set
the web address for the endpoint URI of your application, and configure OAuth security
settings.

©2024 Pegasystems Inc


Pega Government Platform '24.1 177

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.

Note: For the PGP constellation implementation application to work and


your rulesets to be selected, you must set up OAuth with the appropriate
access group and update the SetCDMAuthenticationProfile with the correct
authorization profile.

Creating operator accounts


If DWA (Directed Web Access) and Listener functionality are used in your application,
make sure that the following operators are available in the environment.

For UI Kit apps: For applications built on UI Kit.

OperatorID Access Group Work Group Starting activity

ExternalUserP PegaGP:Caseworker Default Data-Portal.ShowDesktop


GP

©2024 Pegasystems Inc


Pega Government Platform '24.1 178

OperatorID Access Group Work Group Starting activity

ExternalUserC PegaGP:ComplaintsWo Default Data-Portal.ShowDesktop


omp rker

ExternalUserIC PegaGP:ICMAgent Default Data-Portal.ShowDesktop


M

ExternalUserPr PegaGP:Procurements Default Data-Portal.ShowDesktop


oc Worker

ICMInvestigati PegaGP:ICMAdmin default@Peg Data-Portal.ShowDesktop


onListener aPS

For Theme Cosmos apps: For applications built on Theme Cosmos.

OperatorID Access Group Work Group Starting activity

ICMInvestigationList PGPICMTheme- default@PegaPS Data-


ener Cosmos:Administrat Portal.ShowDeskto
or p

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 179

10. Click Save to save the rule.

Optional: Importing the sample data (PGP


Constellation)
The distribution media includes sample data to help you explore the application
capabilities. The sample data includes people, business data, and their relations
information. Importing the sample data is optional, and the provided sample data
might not align with your business needs. Do not import sample data into staging or
production environments.

Before you begin:

Log in to the application as an operator who has the PegaGovt:Authors access


group. For more information about how to create operators, see Creating an
operator ID. For more information about access groups included with the
application, see Access groups included with the application.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 180

CDM- Entity data filters

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: Importing the sample data (PGP traditional


application)
The distribution media includes sample data to help you explore the application
capabilities. The sample data includes disabled sample operators that you can enable
to learn about the workspaces for each operator role. Importing the sample data is

©2024 Pegasystems Inc


Pega Government Platform '24.1 181

optional, and the sample data that is provided might not align with your business
needs.

Before you begin:

Ensure that you have already imported the application file.

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.

Updating data from integration layer to data layer


The Pega Government Platform integration layer has been refactored in the 8.3 release.
All tables are now mapped to their respective classes in the data layer. Refactoring
activities are provided for each of the applications that are shipped and for each class
that is refactored.

To ensure a successful update of your application from Pega Government Platform 8.2
and earlier, review the topics in this section.

• Optional: Enabling backward compatibility with integration layer

• Refactoring wrapper activities

• Adding properties to integration and data layers

• Customizing report definitions in implementation layer

• Customizing data pages in implementation layer

• Customizing data page response data transforms in implementation layer

©2024 Pegasystems Inc


Pega Government Platform '24.1 182

• Adding classes to communications and identifiers in implementation layer

• Modifying State drop-down menu source

• Modifying Country drop-down menu source

• State label configuration

Optional: Enabling backward compatibility with


integration layer
By default, Pega Government Platform 8.3 only works with the data layer. For backward
compatibility purposes, you can update two dynamic system settings to enable Pega
Government Platform to point back to the integration layer.

CAUTION: Do not use the integration layer with data tables as a source.

• PGP/MasterDataIntegrationRefactor – to point the Pega Government Platform


master data, such as AddressTypes, CommTypes, and so on to the integration
layer, change this value to false
• PGP/IntegrationRefactor – to point the Pega Government Platform non-master
data, such as entities, addresses, and so on to the integration layer, change this
value to false

Refactoring wrapper activities


For backward compatibility, Pega Government Platform provides an option to resave
instances of integration classes as instances of data classes. To perform this refactoring,
a few wrapping activities are available. The following table lists the refactoring wrapper
activities that are provided for each application. Each activity invokes the refactoring
activities of specific classes.

©2024 Pegasystems Inc


Pega Government Platform '24.1 183

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.

Appli Activity Ruleset Access Descripti


catio group on
n

PGPI PegaPS.Refactor_IntT PegaPSRefactoring:08-03- PegaGP:ICMA Refactors


CM oData 01 dmin the Int
classes
for the
PGP and
ICM
applicatio
ns

PGPI PegaPS.RefactorMast PegaPSRefactoring:08-03- PegaGP:ICMA Refactors


CM erInfo_IntToData 01 dmin the
master
Int
classes
for the
PGP and
ICM
applicatio
ns

PGPC PegaPS.RefactorMast PegaPSComplaintsRefacto PegaGP:Com Refactors


ompl erInfo_IntToData ring:08-03-01 plaintsAdmin the
aints master
Int

©2024 Pegasystems Inc


Pega Government Platform '24.1 184

Appli Activity Ruleset Access Descripti


catio group on
n

classes
for the
Complain
ts
applicatio
n

PGPC PegaPS.RefactorMast PegaPSProcurementsRefa PegaGP:Proc Refactors


ontra erProcInfo_IntToData ctoring:08-03-01 urementsAd the
cts min master
Int
classes
for the
Procurem
ent
applicatio
n

After running the wrapper activities, clear all the node level data pages in all the
applications.

Adding properties to integration and data layers


When adding properties to the integration and data layers in the Pega Government
Platform implementation layer, before executing the activities listed in Refactoring
wrapper activities, update the mappings in the Refactor_CopyIntToData data transform,
which is specific to the respective data class.

©2024 Pegasystems Inc


Pega Government Platform '24.1 185

Customizing report definitions in implementation


layer
When a report definition from an integration class is specialized into the Pega
Government Platform implementation layer, perform the same changes to the
corresponding report definition of the data layer class.

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.

Customizing data pages in implementation layer


When data pages are customized in the Pega Government Platform implementation
layer, update the same data page with another data source that retrieves the data from
the data layer with data layer-specific report definitions and response data transforms,
if required. Use the IsIntegrationRefactored when rule to retrieve data from the
data layer in the data page.

Note: To find the report definition and response data transforms, refer to the
data page of the latest Pega Government Platform version.

Customizing data page response data transforms in


implementation layer
When data page response data transforms are customized in the Pega Government
Platform implementation layer, make the same changes to the new response data
transforms only if required.

©2024 Pegasystems Inc


Pega Government Platform '24.1 186

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: if the response data transform CopyPersonIntToData is customized


for the D_PersonList data page, perform the same steps in the new data
transform FetchPersonListDetails.

Adding classes to communications and identifiers in


implementation layer
When classes are added to the communications and identifiers wrapper classes in the
Pega Government Platform implementation layer, customize the Refactor_Identifier and
Refactor_Comm refactoring activities accordingly to meet your requirements.

For example:

For example: if a new class PegaPS-Data-Comm-Twitter is added for capturing


Twitter account details, customize the code of the Refactor_Comm activity to set
the respective data class names to the instances of the Twitter class.

Modifying State drop-down menu source


If data refactoring is performed by following the preceding sections, modify the source
of the State drop-down menu.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 187

Modifying Country drop-down menu source


In Pega Government Platform 8.3, the Country drop-down menu source has been
changed from a report definition to a data page.

To use the Pega Government Platform out-of-the-box address-related sections,


customize the corresponding data page in the implementation layer.

State label configuration


In Pega Government Platform 8.3, state labels specific to each country have been
moved from the StateLabel decision table (PegaPS-Data-Address) to the Country data
type.

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.

App Studio compliance changes


The Pega Government Platform has been refactored to be in compliant with App Studio
in 8.5 release. As part of that, sections that are included in a wrapper section or harness
or flow actions with the user level page context have been modified to use the editable
data page.

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 188

Extending new case types in implementation layer


In 8.7 release, PGP includes the Application request, Product and License case types. In
8.8 release, PGP includes the Time entry and Item related Add, Update, and View case
types. In release '23, Pega Government Platform includes the Program definition and
Program finder case types. To include this case in an implementation application that
was built prior, complete the following steps:

1. Create a class record by using the format: <OrgName>-<AppName>-Work-


ApplicationRequest, <OrgName>-<AppName>-Work-Program, <OrgName>-
<AppName>-Work-Program-License, <OrgName>-<AppName>-Work-TimeEntry,
<OrgName>-<AppName>-Work- Entity-Item-Add, <OrgName>-<AppName>-Work-Entity-
Item-Update, <OrgName>-<AppName>-Work- Entity-Item-View, <OrgName>-
<AppName>-Work-Manage-Program, <OrgName>-<AppName>-Work-ProgramFinder.
For the class group, use the format: <OrgName>-<AppName>-Work.
2. For the directed parent class, based on the case type, use the format: for
Application request entities - PegaPS-Work-ApplicationRequest. Similarly, use
PegaPS-Work-Program, PegaPS-Work-Program-License, PegaPS-Work-TimeEntry,
PegaPS-Work-Entity-Item-Add, PegaPS-Work-Entity-Item-Update, and PegaPS-Work-
Entity-Item-View, PegaPS-Work-Manage-Program, and select the Find by name first
(Pattern) box.
3. Optimize the properties for the newly created classes that are present in the
external mappings of their corresponding directed parent class.
4. Save the class rule forms.

Modifying class context data transform rule


In Pega Government Platform 8.8, in the LoadClassContext data transform (PegaPS-Data-
Context- Application)(PegaGPCosmos:08-08-01), in steps 67-70, new work classes are
added. In Pega Government Platform '23, in the LoadClassContext data transform
(PegaPS-Data-Context-Application)(PegaGPCosmos:08-23-01) in steps 72-73, new work
classes are added.

©2024 Pegasystems Inc


Pega Government Platform '24.1 189

In Pega Government Platform '23, LoadClassContext data transform (PegaPS-Data-


Context- Application) (PegaGPCosmos:08-08-01), in steps149-150, new data classes are
added.

Add these steps to your implementation layer-specific data transform, if present.

Modifying business context data transform rule


In Pega Government Platform 8.8, in the LoadBusinessContext data transform, (PegaPS-
Data- Context-Application) (PGPCosmos:08-08-01), new steps: from steps 100 to 108 are
introduced. In Pega Government Platform '23, in the LoadBusinessContext data
transform, (PegaPS- Data- Context-Application) (PGPCosmos:08-23-01), new steps: from
steps 109 to 111 are introduced.

Enabling operator creation in user registration


functionality
For security reasons, Pega Platform operator creation is disabled in Pega Government
Platform 8.4 and later. To enable the creation of an operator, save the
CreatePGPOperator application setting with owning ruleset PegaPS to the
implementation application ruleset, and set the value to True.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 190

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.

Alternatively, in App Studio go to PGP > Application to change the settings.

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.

Event life cycle changes in Pega Government Platform


In 8.6, a couple of stages are introduced to support the latest functionality. You must
make the corresponding changes in the implementation layer-specific Event case,
based on your business scenarios.

©2024 Pegasystems Inc


Pega Government Platform '24.1 191

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.

Changes to entity search data pages in Pega


Government Platform
In Pega Government Platform 8.7, the following search data pages are updated to
support AND logical condition along with the existing OR logical condition. The default
behavior is updated to AND from OR, because OR condition is applicable only in the
search landing pages.

©2024 Pegasystems Inc


Pega Government Platform '24.1 192

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

Updating case edit actions


In Pega Government Platform 8.7, Edit case details , which is a default behavior of Pega
Platform, is removed for Transfer ownership, Task, and Request access cases as they
are not implemented. To enable the edit action, override the DisplayEditAction when
condition to the implementation layer with the appropriate condition and add
pyUpdateCaseDetails flow action to the case type rule. Else, remove the flow action from
the case type rule, if present.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 193

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.

Changes to Unique ID generation


In Pega Government Platform 8.8, Unique ID generation is changed to improve the
performance. To revert to earlier way of generating the Unique ID, Update the Optimize
unique ID generation configuration to false.

Follow these steps to set Optimize unique ID generation configuration setting to


false:

1. In the navigation pane of App Studio, click Settings > Configurations.


2. Click the Settings icon at the end of Optimize unique ID generation row.

PGP Configuration set

3. Select constant value as False to revert to earlier way of generating the Unique ID
and click Submit.

©2024 Pegasystems Inc


Pega Government Platform '24.1 194

Optimize unique ID generation config setting

Queue processor for sending emails


In Pega Government Platform 8.8, for case types that use PegaPS agent to initiate
sending an email is changed to use Queue processor. To revert to using the agent,
update the QP instead of agent configuration to false.

Follow these steps to set the QP instead of agent configuration setting to false:

1. In the navigation pane of App Studio, click Settings > Configurations.


2. Click on Settings icon at the end of the QP instead of agent row.

©2024 Pegasystems Inc


Pega Government Platform '24.1 195

PGP Configuration set

3. Select constant value as False to revert to agent and click Submit.

Configuration setting

Security policies for password validation in user


registration
In Pega Government Platform 8.8, an Edit validate rule has been added to the password
property (CL: PegaPS-Data-Registration) to support security policies for the accounts
created by the user registration feature. This has an impact on existing in-flight cases.
Take corrective action in the implementation layer, as the new validation is added to the
password property, existing accounts with invalid passwords might cause issues or will

©2024 Pegasystems Inc


Pega Government Platform '24.1 196

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.

History and Field audit for entities


In Pega Government Platform 24.1, History and Field audit is enabled for all the
supported entities in all PGP application built on Theme Cosmos.

To enable this feature after upgrade, follow these steps:

• Enable the Entity audit configuration from app studio.


• Make sure the DSS PGP/PerformanceMode is set to false and flush the
D_PerformanceMode data page for the DSS changes to take effect.

This feature does not work as expected for auditing list properties like Address List for
the entity instances which are created before upgrade.

Skip entity persistence in entity flows


In Pega Government Platform 8.8, to improve performance, the entity persistence logic
is skipped when there are no changes performed to the existing details of an entity.
This is developed for the below entity related flows in PegaPS-Work class.

• BasicPersonalInformation
• PersonInformation
• BusinessInformation
• ManageVehicle
• ManageHousehold
• ManageFacility

©2024 Pegasystems Inc


Pega Government Platform '24.1 197

New declare indexes


In Pega Government Platform 8.8, we have introduced three new declare indexes for
supporting the Activity Plan usage feature. The following are the classes to which new
declare indexes are added and this is supported only for the cases created from release
8.8.

• 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.

Activity plan life cycle changes


In Pega Government Platform release '23, reopen option is provided for Task case so
that a closed task case can be reopened to provide additional information or details.
Once the task is reopened, the respective parent cases such as goal and activity plan
are also reopened if they are already closed.

Based on your business scenarios, make the corresponding changes in the


implementation layer under specific task, goal, and activity plan cases.

©2024 Pegasystems Inc


Pega Government Platform '24.1 198

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.

Backward compatibility for Program configuration


In Pega Government Platform '23, Program definition case type is introduced to
manage and define programs. When using the Program definition feature, optionally
the existing program and license data objects created from app studio can also be
converted to cases to reuse the case type end-to-end capabilities.

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

Time management lifecycle changes


For release '23, in Time Management the time entry feature supports cascading
approval. You can control the routing of approvals based on the configuration of the
time management project.

©2024 Pegasystems Inc


Pega Government Platform '24.1 199

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.

Moving countries and states


In Pega Government Platform '23, the sample records provided for Country and State
data types are moved to PegaGP_SampleData.jar. There will not be any impact on
upgrades.

Note: Importing sample data is optional and not recommended to be


installed in the production environment as the sample data provided might not
align with your business needs.

©2024 Pegasystems Inc


Pega Government Platform '24.1 200

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.

• Pega Government Platform Implementation guide for Theme Cosmos

• Pega Government Platform Implementation guide for Constellation

Pega Government Platform Implementation


guide for Theme Cosmos
Applies to Theme Cosmos.Pega Government Platform helps you accelerate your
government application implementation in Theme cosmos by providing reusable
assets.

Pega Government Platform provides a public sector-oriented foundation with


processes, data structures, and components that you can reuse to modernize existing
government systems and accelerate implementations. The application augments
Pega Platform with public sector-specific capabilities, including a government data
model, UI templates, dashboards, reports, workflows, and case types. It accelerates
solution delivery, leveraging assets, features, and components built specifically for the
public sector and assembled using the Pega Platform tools.

The Pega Government Platform product has comprehensive case management


capabilities, which, along with the master data structures, allows you to specialize
quickly where needed.

To summarize, Pega Government Platform is:

©2024 Pegasystems Inc


Pega Government Platform '24.1 201

• A low code platform that caters to the citizen developer through easy to re-use
components (UI, flow, user actions, and case types).

• Functional as an accelerator (uses easy to configure, extensible components to


deliver better results faster).

• Not a turn-key solution

PGP application architecture

• Preparing for implementation

• Prerequisites

• Creating a new application

• Setting application utility

• Configuring your application

• Updating dynamic class referencing

• Integrating with third-party apps

• Connecting system of record

©2024 Pegasystems Inc


Pega Government Platform '24.1 202

• Entities

• Implementing case types

• Managing reference data

• Features implementation

Preparing for implementation


Applies to Theme Cosmos. A project team that implements a Pega application can use
this implementation guide to enable and extend application features to meet client
business requirements. You must complete the product installation before starting the
implementation procedures.

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:

1. Consult with your database administrator to determine whether the installation or


update process can make automatic changes to the database schema.
Alternatively, the database administrator may need to manually apply the DDL
files that include schema changes. For more information see, Install guide.
2. Install to the latest version of Pega Platform 24.1, and ensure that you can log in
as an administrator. For more information, see the Pega Platform Install or Update
Guide for your environment on the Deploy Pega Platform page.

©2024 Pegasystems Inc


Pega Government Platform '24.1 203

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.

Creating a new application


Applies to Theme Cosmos. Run the New Application wizard to create your application.

1. Create a new operator ID to run the New Application wizard.


a. Log in to Dev Studio by using the operator ID [email protected] and
the password that you specified for that operator.
b. Save a copy of the existing [email protected] operator and give it a
name that identifies it as an Application Setup operator.
c. Add the PegaGPCosmos:Administrators access group to the new operator
record, and then click the radio button to the left of the access group to
select it as the default access group.
d. Save the new Application Setup operator.
2. Log in as the Application Setup operator.
3. In the header of Dev Studio, click the name of the application, and then click New
Application.
4. Select built-on application from the list of applications (theme-cosmos) displayed
such as Pega Government Platform, Investigative Case Management, and Time
management. If you want to build your application on top of PGP UI-Kit
applications, click Search all types, and select your built-on application from the
list.
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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 204

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.

The Application Wizard creates the implementation application. The application


includes one system administrator operator so that you can log into the
application after you complete the wizard.

10. To open the new application, click Go to app.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 205

Setting application utility


Applies to Theme Cosmos. This utility helps in creating or modifying the required rules
and structures to support the implementation layer. For example, adding access groups
to operators, look up data pages, and so on.

After the implementation layer is created, perform the configurations described in the
following steps. Ensure that you are logged in as a developer.

1. Log in to Pega Government Platform using administrator operator account, you


created during new application phase.
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 PGP > Application setup.
4. Click Setup application, and then click Done.

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 the lookup data pages in base applications work classes to


implementation layer specific work classes and updates the source of lookup to
the implementation work class.

• 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 operators of base application with implementation specific access


group and sets it to default.

©2024 Pegasystems Inc


Pega Government Platform '24.1 206

• 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.

Configuring your application


Applies to Theme Cosmos. Pega Government Platform 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, such as an application feature or specific case
type.

Configuration sets in Pega Government Platform

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 207

You can change the default value of these configuration sets to alter the behavior and
enable or disable any settings.

For more information, see Creating a configuration set.

Adding field names to error messages

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:

1. Enable DSS (Dynamic Systems Settings) displayFieldNameInValidationMsg to true in


your application.
2. Ensure the error message script for the screen reader includes the name of the
field that produced a validation error and the error message.

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.

Limiting the visibilty of sensitive data items through attribute-based


access control (ABAC)

What is attribute based access control?

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 208

Pega Platform provides rules that you can use to implement access control by using
values of attributes that are present on the clipboard:

• Access Control Policy


• Access Control Policy Condition
• Access When

Use case examples

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 209

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 210

Search person

Update Person

Implement attribute-based access control

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 211

Access Control Policy: PropRead TaxID

©2024 Pegasystems Inc


Pega Government Platform '24.1 212

Access Control Policy Condition: ViewTaxID

©2024 Pegasystems Inc


Pega Government Platform '24.1 213

Access Control Policy: ViewQuestionAndAnswers

Access Control Policy: PropRead QuestionAndAnswers

©2024 Pegasystems Inc


Pega Government Platform '24.1 214

Updating dynamic class referencing


Applies to Theme Cosmos. In Pega Government Platform, once the application setup is
executed in the implementation layer, the DCR data pages automatically identifies the
respective implementation classes for the PGP provided work classes. This is
implemented in the SetDescendantWorkClasses and SetICMDescendantWorkClasses Data
transforms of both PGP and ICM applications.

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.

Integrating with third-party apps


Applies to Theme Cosmos. In Pega Government Platform, Google maps integration is
used for displaying the current location and the Nearby locations and cases feature. For
example, by integrating with Google Maps, a user of the Pega Government platform can
view the nearby entities and cases from within a certain distance of their current
location.

To integrate this feature in the application, perform the following steps in your
environment. Ensure that you are logged in as a developer.

1. Log in to the application as an administrator.


2. Navigate to Records > Sysadmin > Dynamic system settings
3. Open the DSS with setting purpose as uiengine/map/googleapikey and
OwningRuleset as Pega-EndUserUI
4. Set the Google API key in the value text box
5. Click Save
For more information, see Geographic-reference.

©2024 Pegasystems Inc


Pega Government Platform '24.1 215

Connecting system of record


Applies to Theme Cosmos. In Pega Government platform, all the classes which requires
a persistence are mapped to the tables in PegaDATA and the data gets persisted as
instances of Data- classes. These tables also have a blob which can be leveraged when
there are any embedded page or list properties to be persisted as part of the actual
object.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 216

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 history and field audit

• Entity merge

• Creating new entities

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.

• Add Person case type

• Update Person case type

©2024 Pegasystems Inc


Pega Government Platform '24.1 217

• View Person case type

Add Person case type


Applies to Theme Cosmos. Add a person case type. Using the PegaPS-Work-Entity-Person-
Add case type, you can introduce a new entity of the type Person into the system.

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 218

address, communication, communication preference, profile image, security questions,


and so on.

Adding a new field to the person intake screen

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 219

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:

The new field is automatically saved in the person table.

Updating duplicate check validation for a field

Update the existing duplicate check fields with new fields.

1. Open the CheckDuplicate (PegaPS-Data-Entity-Person) case match rule.


2. Add a new field by clicking Add must match condition.

©2024 Pegasystems Inc


Pega Government Platform '24.1 220

3. Update the filter logic accordingly.

4. Click Save as.


5. In the Context section, select an application.
6. In the Add to ruleset area, select a ruleset and the ruleset version.
7. Click Create and open.

Adding a new list item

Update an existing list of items with new items.

Add a new list item, for example, GrantsList and persist it.

©2024 Pegasystems Inc


Pega Government Platform '24.1 221

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.

5. Create a UI to capture the Grant details.

Update Person case type


Applies to Theme Cosmos. Update the existing Person case type. Using the PegaPS-Work-
Entity-Person-Update case type, you can update the details of an existing entity.

©2024 Pegasystems Inc


Pega Government Platform '24.1 222

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 223

Updating an existing list property

Update an existing list property, for example, GrantsList.

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.

1. Update the FetchPersonDetails (PegaPS-Data-Entity-Person) data transform.


2. Add a step similar to CommList or AddressList to set the details using the
corresponding grant data page of type: List.

Result:

The Update case populates the details and any changes made are persisted.

View Person case type


Applies to Theme Cosmos. View the details of a person entity. Using the PegaPS-Work-
Entity-Person-View temporary case type, you can view the complete details of an existing
person entity.

©2024 Pegasystems Inc


Pega Government Platform '24.1 224

The EntityDetails (PegaPS-Data-Entity-Person) wrapper section contains all the person


related views or sections.

Adding a field to the person view

Add new fields to an existing person view.

Add a field, for example, Spouse Name to the person view.

©2024 Pegasystems Inc


Pega Government Platform '24.1 225

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.

2. Add the new field along with the existing ones.

Showing captured list details in the person view

Show the captured list, for example, GrantsList details in the person view.

1. Create a view or section in the PegaPS-Work-Entity-Person-View class.


2. Include the section in the Main Content region of the pyCaseMainInner view.

©2024 Pegasystems Inc


Pega Government Platform '24.1 226

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 Business case type

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 227

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.

Adding a new field to the business intake screen

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 228

3. Click the Add icon and add the field created in step 1.

Result:

The new field automatically gets persisted in the business table.

Updating duplicate check validation for a field

Update the existing duplicate check fields with new fields.

1. Open the CheckDuplicate (PegaPS-Data-Entity-Business) case match rule.


2. Add a new field by clicking Add must match condition.

©2024 Pegasystems Inc


Pega Government Platform '24.1 229

3. Update the filter logic accordingly.

4. Click Save as.


5. In the Context section, select an application.
6. In the Add to ruleset area, select a ruleset and the ruleset version.
7. Click Create and open.

Adding a new list item

Update an existing list of items with new items.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 230

d. Click Submit.

4. Update the PersitEmbeddedPage (PegaPS-Data-Entity-Business) activity with a new


step looping the SubsidiaryList property and invoke the activity SaveObject by
passing the EntityID and EntityType parameters similar to CommList.

5. Create a UI to capture the subsidiary details so that they persist after you enter
the data.

Update Business case type

Update the existing business case type. Using the PegaPS-Work-Entity-Business-Update


case type, you can update the details of an existing entity.

©2024 Pegasystems Inc


Pega Government Platform '24.1 231

The Business flow supports updating the Business and Branch details as well.

©2024 Pegasystems Inc


Pega Government Platform '24.1 232

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.

Updating an existing list property

Update the existing list properties for the business entity.

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.

1. Update the FetchBusinessDetails (PegaPS-Data-Entity-Business) data transform.


2. Add a step similar to CommList or AddressList to set the details using the
corresponding subsidiary data page of type: List.

©2024 Pegasystems Inc


Pega Government Platform '24.1 233

Result:

The Update case populates the details and any changes made are persisted.

View Business case type

View the details of a business entity. Using the PegaPS-Work-Entity-Business-View


temporary case type, you can view the complete details of an existing business entity.

The Details (PegaPS-Data-Entity-Business) wrapper section contains all the business-


related views or sections.

©2024 Pegasystems Inc


Pega Government Platform '24.1 234

Adding a field to the business view

Add new fields to an existing business view.

Add a field, for example, Parent Organization to the business view.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 235

2. Add the new field along with the existing ones.

Showing captured list details in the business view

Show the captured list, for example, SubsidiaryList details in the business view.

1. Create a view or section in the PegaPS-Work-Entity-Business-View class.


2. Include the section in the main content region of pyCaseMainInner view.

©2024 Pegasystems Inc


Pega Government Platform '24.1 236

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.

Add Vehicle case type


Applies to Theme Cosmos. Add a vehicle case type. Using the PegaPS-Work-Entity-Vehicle-
Add case type, you can introduce a new entity of the type Vehicle into the system.

©2024 Pegasystems Inc


Pega Government Platform '24.1 237

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.

Adding a new field to the vehicle intake screen

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 238

Result:

The new field automatically gets persisted in the vehicle table.

Updating duplicate check validation for a field

Update the existing duplicate check fields with new fields.

1. Open the CheckDuplicate (PegaPS-Data-Entity-Vehicle) case match rule.


2. Add a new field by clicking Add must match condition.

©2024 Pegasystems Inc


Pega Government Platform '24.1 239

3. Update the filter logic accordingly.

4. Click Save as.


5. In the Context section, select an application.
6. In the Add to ruleset area, select a ruleset and the ruleset version.
7. Click Create and open.

Adding a new list item

Update an existing list of items with new items.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 240

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.

4. Update the PersitEmbeddedPage (PegaPS-Data-Entity-Vehicle) activity with a new


step looping the ServiceHistoryList property and invoke the activity SaveObject by

©2024 Pegasystems Inc


Pega Government Platform '24.1 241

passing the EntityID and EntityType parameters similar to CommList.

5. Create a UI to capture the service history details so that they persist after you
enter the data.

Update Vehicle case type


Applies to Theme Cosmos. Update the existing vehicle case type. Using the PegaPS-
Work-Entity-Vehicle-Update case type, you can update the details of an existing entity.

©2024 Pegasystems Inc


Pega Government Platform '24.1 242

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.

Updating an existing list property

Update the existing list properties for the household entity.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 243

1. Update the FetchVehicleDetails (PegaPS-Data-Entity-Vehicle) data transform.


2. Add a step similar to AddressList.

View Vehicle case type


Applies to Theme Cosmos. View the details of a vehicle entity. Using the PegaPS-Work-
Entity-Vehicle-View temporary case type, view the complete details of an existing vehicle
entity.

The Details (PegaPS-Data-Entity-Vehicle) wrapper section contains all the vehicle related
views or sections.

©2024 Pegasystems Inc


Pega Government Platform '24.1 244

Adding a field to the vehicle view

Add new fields to an existing vehicle view.

Add a field, for example, Purchase Date to the vehicle view.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 245

2. Add the new field along with the existing ones.

Showing captured list details in the vehicle view

Show the captured list, for example, ServiceHistoryList details in the vehicle view.

1. Create a view or section in PegaPS-Work-Entity-Vehicle-View class.


2. Include the section in the Main content region of the pyCaseMainInner view.

©2024 Pegasystems Inc


Pega Government Platform '24.1 246

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.

Add Household case type


Applies to Theme Cosmos. Add a household case type to the system. Using the PegaPS-
Work-Entity-Household-Add case type, you can introduce a new entity of the type
Household into the system.

©2024 Pegasystems Inc


Pega Government Platform '24.1 247

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.

Adding a new field to the household intake screen

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 248

Result:

The new field automatically gets persisted in the household table.

Adding a new list item

Update an existing list of items with new items.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 249

4. Update the PersitEmbeddedPage (PegaPS-Data-Entity-Household) activity with a new


step looping the HouseholdItemsList property and invoke the activity SaveObject
by passing the EntityID and EntityType parameters similar to AddressList.

5. Create a UI to capture the household item details so that they persist after you
enter the data.

©2024 Pegasystems Inc


Pega Government Platform '24.1 250

Update Household case type


Applies to Theme Cosmos. Update the existing household case type. Using the PegaPS-
Work-Entity-Household-Update case type, you can update the details of an existing entity.

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.

Updating an existing list property


Applies to Theme Cosmos. Update the existing list properties for the household entity.

©2024 Pegasystems Inc


Pega Government Platform '24.1 251

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.

1. Update the FetchHouseholdDetails (PegaPS-Data-Entity-Household) data transform.


2. Add a step similar to AddressList.

Result:

The Items list details are available for the user to update in the update case.

Update Manage members case type


Applies to Theme Cosmos. Update the existing members of a household case type.
Using the PegaPS-Work-Manage-Member case type, you can update the details of the
existing members of a household.

©2024 Pegasystems Inc


Pega Government Platform '24.1 252

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 253

View Household case type


Applies to Theme Cosmos. View the details of a household entity. Using the PegaPS-
Work-Entity-Household-View temporary case type, you can view the complete details of
an existing household entity.

The Details (PegaPS-Data-Entity-Household) wrapper section contains all the household


related views or sections.

©2024 Pegasystems Inc


Pega Government Platform '24.1 254

Adding a field to the household view

Add new fields to an existing household view.

Add a field, for example, Is Remote location to the household view.

1. To add the field, navigate to the Details wrapper section to show the field, or
navigate to the Case details section.

2. Add the new field along with the existing ones.

©2024 Pegasystems Inc


Pega Government Platform '24.1 255

Showing captured list details in the household view

Show the captured list, for example, HouseholdItemsList details in the household view.

1. Create a view or section in the PegaPS-Work-Entity-Household-View class.


2. Include the section in the Main content region of the pyCaseMainInner view as a
tab.

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.

Add Facility case type


Applies to Theme Cosmos. Add a facility case type to the system. Using the PegaPS-
Work-Entity-Facility-Add case type, you can introduce a new entity of the type Facility into
the system.

©2024 Pegasystems Inc


Pega Government Platform '24.1 256

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.

Adding a new field to the facility intake screen

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 257

Result:

The new field automatically gets persisted in the household table.

Introducing duplicate check validation for a field

Create duplicate check fields and update them with new fields.

1. Create the CheckDuplicate (PegaPS-Data-Entity-Facility) case match rule.


2. Add a new field by clicking Add must match condition, similar to how you add for
Vehicle entity.

©2024 Pegasystems Inc


Pega Government Platform '24.1 258

3. Update the filter logic accordingly.

©2024 Pegasystems Inc


Pega Government Platform '24.1 259

4. Create an activity: CheckDuplicate (PegaPS-Data-Entity-Facility), and include the steps


2 and 3 by referring to the activity of the Vehicle entity.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 260

Adding a new list item

Update an existing list of items with new items.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 261

c. In the Data object list, select Inspection.


d. Click Submit.

4. Update the PersitEmbeddedPage (PegaPS-Data-Entity-Facility) activity with a new


step looping the InspectionList property and invoke the activity SaveObject by

©2024 Pegasystems Inc


Pega Government Platform '24.1 262

passing the EntityID and EntityType parameters similar to CommList.

5. Create a UI to capture the facility details so that they persist after you enter the
data.

Update Facility case type


Applies to Theme Cosmos. Update the existing facility case type. Using the PegaPS-Work-
Entity-Facility-Update case type, you can update the details of an existing entity.

©2024 Pegasystems Inc


Pega Government Platform '24.1 263

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.

Updating an existing list property

Update an existing list property, for example, InspectionList.

Fetch the facility details to update the list of item details in a facility that are captured as
a part of Add Facility.

1. Update the FetchFacilityDetails (PegaPS-Data-Entity-Facility) data transform.

©2024 Pegasystems Inc


Pega Government Platform '24.1 264

2. Add a step similar to AddressList.

View Facility case type


Applies to Theme Cosmos. View the details of a facility entity. Using the PegaPS-Work-
Entity-Facility-View temporary case type, you can view the complete details of an existing
facility entity.

The Details (PegaPS-Data-Entity-Facility) wrapper section contains all the facility related
views or sections.

©2024 Pegasystems Inc


Pega Government Platform '24.1 265

Adding a field to the facility view

Add new fields to the existing facility view.

Add a field, for example, Permission Date to the facility view.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 266

2. Add the new field along with the existing ones.

Showing captured list details in the facility view

Show the captured list, for example, InspectionList details in the facility view.

1. Create a view or section in PegaPS-Work-Entity-Facility-View class.


2. Include the section in the Main content region of the pyCaseMainInner view.

©2024 Pegasystems Inc


Pega Government Platform '24.1 267

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:

Entity Harness class Harness name

Person PegaPS-Data-Portal Person

Business PegaPS-Data-Portal Business

Facility PegaPS-Data-Portal Facility

Vehicle PegaPS-Data-Portal Vehicle

Household PegaPS-Data-Portal Household

The following table shows a list of data pages and report definitions that you can use
for each entity search from the landing pages.

Entity Data page Report definition

Person D_PersonList PersonList

Business D_BusinessList BusinessList

Facility D_FacilityList FacilityList

Vehicle D_VehicleList VehicleList

Household D_SearchHouseholdList SearchHouseholdList

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:

©2024 Pegasystems Inc


Pega Government Platform '24.1 268

Entity Section Class Section name

Person PegaPS SearchPersonTable

Business PegaPS SearchBusinessTable

Facility PegaPS SearchFacilityTable

Vehicle PegaPS SearchVehicleTable

Household PegaPS SearchHouseholdTable

Introducing new search criteria

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.

Add Item case type


Applies to Theme Cosmos. Add an item case type. Using the PegaPS-Work-Entity-Item-
Add case type, you can introduce a new entity of the type Item into the system.

©2024 Pegasystems Inc


Pega Government Platform '24.1 269

Add item case type

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.

Adding a new field to the item intake screen

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 270

Add new field in item case type

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 271

Add new field - item intake form

Result:

The new field is automatically saved in the item table.

Updating duplicate check validation for a field

Update the existing duplicate check fields with new fields.

1. Open the CheckDuplicate (PegaPS-Data-Identifier) case match rule.


2. Add a new field by clicking Add must match condition.
3. Update the filter logic accordingly.

©2024 Pegasystems Inc


Pega Government Platform '24.1 272

Duplicate check validation

4. Click Save as.


5. In the Context section, select an application.
6. In the Add to ruleset area, select a ruleset and the ruleset version.
7. Click Create and open.

Enable or disable duplicate check

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.

Follow these steps to enable or disable duplicate check:

1. Login to Pega Government Platform with admin credentials and switch to App
studio.

©2024 Pegasystems Inc


Pega Government Platform '24.1 273

2. From the left pane, click Settings > Configuration.

Enable/disable duplicate check

3. Click gear icon of duplicate check row.


4. Change the value of constant dropdown. Select True to enable the duplicate check
else False to disable the duplicate check.

©2024 Pegasystems Inc


Pega Government Platform '24.1 274

Configuration setting to enable/disable duplicate check

Adding a new list item

Update an existing list of items with new items.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 275

Adding a new list item

5. Create a UI to capture the SellerList details.

Update Item case type


Applies to Theme Cosmos. Update the existing Item case type. Using the PegaPS-Work-
Entity-Item-Update case type, you can update the details of an existing entity.

©2024 Pegasystems Inc


Pega Government Platform '24.1 276

Update item case type

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.

Updating an existing list property

Update an existing list property, for example, SellerList .

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 277

1. Update the FetchItemDetails (PegaPS-Data-Entity-Item) data transform.


2. Add a step similar to ValuesList or AddressList to set the details using the
corresponding SellerList data page of type: List.

Updating a existing list property for Item entity

Result:

The Update case populates the details and any changes made are persisted.

View Item case type


Applies to Theme Cosmos. View the details of a item entity. Using the PegaPS-Work-
Entity-Item-View case type, you can view the complete details of an existing item entity.

©2024 Pegasystems Inc


Pega Government Platform '24.1 278

View item case type

The EntityDetails (PegaPS-Data-Entity-Item) wrapper section contains all the item related
views or sections.

View item case type

Adding a field to the item view

Add new fields to an existing item view.

Add a field, for example, Short name to the item view.

©2024 Pegasystems Inc


Pega Government Platform '24.1 279

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.

Add field in item view

2. Add the new field along with the existing ones.

Showing captured list details in the item view

Show the captured list, for example, SellerList details in the item view.

1. Create a view or section in the PegaPS-Work-Entity-Item-View class.


2. Include the section in the Main Content region of the pyCaseMainInner view.

©2024 Pegasystems Inc


Pega Government Platform '24.1 280

Showing captured list details

Copy item to a new case type

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.

The following are some of the features of entity attachments:

©2024 Pegasystems Inc


Pega Government Platform '24.1 281

• 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.

Extending attachments for a new entity type

Hold documents for the entities of a new entity type in the implementation layer.

1. In pyCaseMainInner section of entity view class, in the Utils area, add a


Documents section with the Page context as Use clipboard page and context
value as Entity Page.

For example: For Person entity, in the pyCaseMainInner section (CL:PegaPS-Work-


Entity-Person-View), in the Utils region, add a Documents section with Page context
as Use clipboard page and context value as .Person.

©2024 Pegasystems Inc


Pega Government Platform '24.1 282

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.

Entity history and field audit


Applies to Theme Cosmos. Pega Government Platform provides support for History and
Field auditing for necessary fields, for entities.

The following are some of the features of entity history and field audit:

©2024 Pegasystems Inc


Pega Government Platform '24.1 283

• 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

©2024 Pegasystems Inc


Pega Government Platform '24.1 284

Field audit

Extend History and Field audit to a new entity

Applies to Theme Cosmos. To add history to a new entity open pyCaseMainInner of


entity view class and add Entity History section with the Page context as Use clipboard
page and context value as Entity Page.

Note: Use SaveEntity(CL:PegaPS-Work) to Persist the entity.

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 285

pyTrackSecurityChanges data transform with data-class of the entity and add fields to
audit.

Extend field audit to a new field of an existing entity

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 286

Architecture

Merge entities consists of two parts:

• Configuring Scalar and List merge attributes (Properties) in the design time.

• Executing the merge for the selected entities at run time.

Merge attributes can be configured from App Studio by navigating to the PGP > Merge
entities landing page.

Scalar attributes can be configured by providing the following details:

• Name of the property


• Property supported for merge and
• Data type of the property

List attributes can be configured by providing the following details:

• Name of the attribute


• Data page that fetches the list items and
• Properties to be shown to the user

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.

Technical details for merging entities

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 287

• MergeStatus (Possible values: Active/Inactive)


• MergedTo

For example, let’s assume below are the entities before merge

Entity ID Merge Status Merged To

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.

Entity ID Merge Status Merged To

PERSON-1 Active --

PERSON-2 Inactive PERSON-1

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.

Technical details for merging list items

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.

• MergeStatus (Possible values: MasterInactive/Inactive/Active)


◦ MasterInactive: Used to inactivate the master list items (only if not selected),
these are omitted and not shown in master profile.
◦ Inactive: Used to inactivate the duplicate list items (irrespective of selection
is made or not.)

©2024 Pegasystems Inc


Pega Government Platform '24.1 288

◦ 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.

Address ID Entity ID Merge Status RefID User selection

Address-1 PERSON-1 -- -- Selected by


(Master) user

Address-2 PERSON-1 -- -- Not selected


(Master)

Address-3 PERSON-2 -- -- Selected by


(Duplicate) user

Address-4 PERSON-2 -- -- Not selected


(Duplicate)

In the above scenario, one address from each entity is selected by the user and below
are the address details after the merge.

Address ID Entity ID Merge Status RefID

Address-1 PERSON-1 (Master) Active --

Address-2 PERSON-1 (Master) MasterInactive --

Address-3 PERSON-2 Inactive --


(Duplicate)

Address-4 PERSON-2 Inactive --


(Duplicate)

Address-5 PERSON-1 (Master) Active Address-3

Below is the explanation for each address how its handled in the above scenario.

©2024 Pegasystems Inc


Pega Government Platform '24.1 289

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.

Creating new entities


• What are PGP entities?

• New Entity overview

• Development steps

• Create Case types

• Enabling for App Studio

• Rule inventory

What are PGP entities?


Applies to Theme Cosmos. Pega Government Platform (PGP) entities are a collection of
robust data structures that model data elements commonly used in government

©2024 Pegasystems Inc


Pega Government Platform '24.1 290

processes. The PGP entities are persistent data classes that come pre-configured as a
part of PGP.

• Person
• Business
• Vehicle
• Facility
• Household

Entity data structures serve two distinct purposes within PGP:

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

Persistent data store

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).

Case type embedded page

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 291

New Entity overview


Applies to Theme Cosmos. This guide will step through the process of extending the
PGP Entity data structure addding a new entity called Item built in a PGP
implementation layer.

In the following examples PGPImp is the organization name of the implementation


application and DemoPGP is the name of the implementation application. The class
PGPImp-DemoPGP-Work inherits (directed) from the PegaPS-Work class.

Create the Persistent Datastore

PGPImp-DemoPGP-Data-Entity-Item

• Properties relevant to the entity


• View(s) for editing, reviewing
• Data Pages for retrieving
• Optional: Case match rule to avoid duplicates, and validation rules for data

Extend the Work Class Properties

In the primary work class of the implementation application, PGPImp-DemoPGP-Work,


add a page property of type PGPImp-DemoPGP-Data-Entity-Item to hold Item data during
case management processing.

Create the Data Management Case Types

• PGPImp-DemoPGP-Work-Entity-Item-Add
• PGPImp-DemoPGP-Work-Entity-Item-View
• PGPImp-DemoPGP-Work-Entity-Item-Search
• PGPImp-DemoPGP-Work-Entity-Item-Update

Enable for App Studio

• Use views and design templates to construct the user interface

©2024 Pegasystems Inc


Pega Government Platform '24.1 292

• 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.

Create persistent datastore

Applies to Theme Cosmos. Create a persistent data type and supporting rules for the
new entity.

Create Data Type Ancestor

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 Create > SysAdmin > Class to create a new class


a. For the Label use Entity
b. For the Class Name use PGPImp-DemoPGP-Data-Entity
c. Create and open
d. For Select class type use Abstract
e. For Created in version use the current version
f. For Parent class (directed) use PegaPS-Data-Entity
2. Save the rule.

©2024 Pegasystems Inc


Pega Government Platform '24.1 293

Create Data Type

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

Create View UI for the New Data Type

Build the basic data layer UI rules to present the data of the new Item data type.

1. Create View ItemDetail with Applies-To of PGPImp-DemoPGP-Data-Entity-Item


a. Place all the relevant properties from the Item data type
2. Create View ItemDetailRO with Applies-To of PGPImp-DemoPGP-Data-Entity-Item
a. Place all the relevant properties from the Item data type, with the
Presentation -> Edit Options set to Read-Only.

Extend the work ancestor class

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 294

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.

Review entity data type rules

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 Rule Name Rule Type Description Comment

PGPImp- Class Abstract


DemoPGP-
Data-Entity

Item Data Type

PGPImp- Class Concrete Key pyID


DemoPGP-
Data-Entity-
Item

PGPImp- Database Persistence


DemoPGP- Table
Data-Entity-
Item

PGPImp- ItemName Property Text


DemoPGP-
Data-Entity-
Item

©2024 Pegasystems Inc


Pega Government Platform '24.1 295

Applies -to Rule Name Rule Type Description Comment

PGPImp- … more Property Text


DemoPGP- properties
Data-Entity-
Item

D_Item Data Page Page Source=Looku


p

D_ItemList Data Page Page List Source=Report


Definition

D_ItemSavable Data Page Page

PGPImp- DataTableEdito Report All Item


DemoPGP- rReport Definition Properties
Data-Entity-
Item

Create Case types

Create abstract support work classes

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.

1. Use Create > SysAdmin > Class to create a new class.


a. For the Label use Entity
b. For the Class Name use PGPImp-DemoPGP-Work-Entity
c. Create and open
d. For Select class type use Abstract
e. For Created in version use the current version
f. For Parent class (directed) use PegaPS-Work-Entity

©2024 Pegasystems Inc


Pega Government Platform '24.1 296

g. Save the rule


2. Use Create > SysAdmin > Class to create a new class
a. For the Label use Entity Item
b. For the Class Name use PGPImp-DemoPGP-Work-Entity-Item
c. Create and open
d. For Select class type use Abstract
e. For Created in version use the current version
f. For Parent class (directed) use PGPImp-DemoPGP-Work-Entity
g. Save the rule

Create data management case types


Applies to Theme Cosmos. Use Case types -> +Add a case type to add new case types to
the implementation layer. Use the Advanced Settings to select the directed and
patterned ancestors for the new case type.

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.

Create Add case type

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 297

b. Use PGPImp-DemoPGP-Work-Entity-Item as the directed ancestor


c. 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 Capture 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. From the step parameters panel (right) click Configure the View
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-Add from
Add to Add item
6. Save the Case

Create Update case type

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 298

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 299

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

Create View case type

In PGP the View case type for Entities shows a comprehensive snapshot of an entity
instance’s data.

1. Create a new Case Type named View


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 Stage Name field for the Create stage use the smart-prompt to select
PegaPS-Work-Entity.View from the list of available stage processes.
4. In the Stage Name field for the Create stage use the smart-prompt to select
PegaPS-Work-Entity.View from the list of available stage processes.
5. Save the case
6. Override/SaveAs the PegaPS.Details section as PGPImp-DemoPGP-Work-Entity-
Item-View.Details
a. Include the section PGPImp-DemoPGP-Data-Entity-Item.Details using
the .Item property as the page context.
7. Save the section
8. Edit the pyDefault data transform rule for the View work type to set the initial
values on the .Item page from lookup data page
a. Switch to the Parameters tab and add a parameter named EntityID of type
String

©2024 Pegasystems Inc


Pega Government Platform '24.1 300

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
9. Save the data transform

Create Search case type

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.

1. Create a new Case Type named Search


a. Expand the Advanced section and specify the ancestry
1. Use PGPImp-DemoPGP-Work-Entity-Item as the directed ancestor
2. ii. Use PGPImp-DemoPGP-Work-Entity-Item as the patterned ancestor
2. Create a Workflow for the new case type
3. In the Stage Name field for the Create stage use the smart-prompt to select the
PegaPS-Work.Search stage from the list of available stages
4. Override/Save As the PegaPS-Work.Search section as PGPImp-DemoPGP-Work-
Entity-Item-Search.Search
5. Edit the PGPImp-DemoPGP-Work-Entity-Item-Search.Search section
6. UseStructural > Embedded Section to include the section PegaPS-Data.Search in
the dynamic layout
a. For Page context choose Use clipboard page
b. For Class enter PGPImp-DemoPGP-Data-Entity-Item
c. For Clipboard page select .Item from the list
d. For Section choose By name and select Search from the list
e. For PARAMETER ShowSearchType set Value to nothing
f. Click Submit
7. Save the section
8. Override/SaveAs the PegaPS-Data.SearchCriteria section as PGPImp-DemoPGP-Data-
Entity-Item.SearchCriteria
a. Add the key properties for PGPImp-DemoPGP-Data-Entity-Item to this section
b. Save the section

©2024 Pegasystems Inc


Pega Government Platform '24.1 301

9. Override/SaveAs the PegaPS-Data.SearchResults section as PGPImp-DemoPGP-Data-


Entity-Item.SearchResults
10. Edit the PGPImp-DemoPGP-Data-Entity-Item.SearchResults section
11. Use Structural -> Table to add a table layout to the section and Configure the table
a. For Source choose Data page
b. For Data page select D_ItemList from the list
c. For Parameters check Pass the parameter page
d. Submit
12. Save the section

Enabling for App Studio


Applies to Theme Cosmos. To enable for App Sudio, follow these:

• Use views and design templates to construct the user interface.


• Manage the new entity’s rules in relevant records so that appropriate choices will
appear in the App Studio smart prompts.
• For appropriate case types, set the Show in ‘New’ menu checkbox under Settings >
General to enable the case type to appear on +Create nav.

Rule inventory
Applies to Theme Cosmos. The following is a list of rules created in this exercise.

Applies -to Rule Name Rule Type Description Comment

PGPImp- Class Abstract


DemoPGP-
Data-Entity

PGPImp- Class Concrete Key EntityID


DemoPGP-
Data-Entity-
Item

©2024 Pegasystems Inc


Pega Government Platform '24.1 302

Applies -to Rule Name Rule Type Description Comment

PGPImp- Database Persistence


DemoPGP- Table
Data-Entity-
Item

PGPImp- ItemName Property Text


DemoPGP-
Data-Entity-
Item

PGPImp- ItemType Property Text


DemoPGP-
Data-Entity-
Item

PGPImp- ItemDetail Section View


DemoPGP-
Data-Entity-
Item

PGPImp- ItemDetailRO Section View


DemoPGP-
Data-Entity-
Item

D_Item Data Page Page Source=Looku


p

D_ItemList Data Page Page List Source=Report


Definition

PGPImp- ItemList Report All Item


DemoPGP- Definition Properties
Data-Entity-
Item

©2024 Pegasystems Inc


Pega Government Platform '24.1 303

Applies -to Rule Name Rule Type Description Comment

PGPImp- .Item (PGPImp- Page


DemoPGP- DemoPGP-
Work Data-Entity-
Item)

PGPImp- .ItemList Page


DemoPGP- (PGPImp-
Work DemoPGP-
Data-Entity-
Item)

PGPImp- Class Abstract


DemoPGP-
Work-Entity

PGPImp- Class Abstract


DemoPGP-
Work-Entity-
Item

Add Case Type

PGPImp- Class Concrete Case Type


DemoPGP-
Work-Entity-
Item-Add

PGPImp- pyDefault Case Type Case Type


DemoPGP-
Work-Entity-
Item-Add

PGPImp- CreateForm_D Flow Case Type


DemoPGP- efault
Work-Entity-
Item-Add

©2024 Pegasystems Inc


Pega Government Platform '24.1 304

Applies -to Rule Name Rule Type Description Comment

D_Add Data Page Case Type

D_AddList Data Page Case Type

PGPImp- pyDefault Data Case Type


DemoPGP- Transform
Work-Entity-
Item-Add

PGPImp- pySetFieldDefa Data Case Type


DemoPGP- ults Transform
Work-Entity-
Item-Add

PGPImp- ItemInformatio Flow Case Type


DemoPGP- n_Flow
Work-Entity-
Item-Add

PGPImp- Create Flow Action Case Type


DemoPGP-
Work-Entity-
Item-Add

PGPImp- Create Section Case Type


DemoPGP-
Work-Entity-
Item-Add

PGPImp- ItemDetails Flow Action Case Type


DemoPGP-
Work-Entity-
Item-Add

PGPImp- ItemDetails Section Case Type


DemoPGP-

©2024 Pegasystems Inc


Pega Government Platform '24.1 305

Applies -to Rule Name Rule Type Description Comment

Work-Entity-
Item-Add

Implementing case types


Applies to Theme Cosmos. This section describes standard cases available with Pega
Government Platform along with how these end-to-end case types can be used,
extended, and customized for various business needs.

• Initiate event

• Investigative Case Management

• 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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 306

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.

Adding a field to existing event details form

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.

1. Create a property in the PegaPS-Data-Event class.


2. Add the newly created property to the EventDetails (PegaPS-Data-Event) section.

Capturing an additional address for an event

Applies to Theme Cosmos. By default, when creating an event, one address is captured.

To capture an additional address, complete the following steps.

1. Create a record in the AddressType (PegaPS-Data-Config-AddressType) data type with


the new address details.
2. Add a step in the pySetFieldDefaults (PegaPS-Data-Event) data transform for the new
address type initialization.

©2024 Pegasystems Inc


Pega Government Platform '24.1 307

3. Update the EventInformation (PegaPS-Work) section to include the new address


type with the PageContext set as .Event.AddressList(2).

Adding a field to existing review actions in event review screen

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.

1. Create a record in the Option Map (PegaPS-Data-Config-OptionMap) data type with


the new review action.
2. Specify the field name as C_EventReview for the Pega Government Platform
application.
3. Create a record in the ICM Option Map (PegaPS-Data-Config-OptionMap-ICM) data
type with the new review action.
4. Specify the field name as C_EventReviewAction for the ICM application.
5. Open the ReviewEvent (PegaPS-Work-Event-Initiate) flow and click the Save as
button.
6. Update the connectors that result from the decision shape with the newly
introduced actions.

View event
Applies to Theme Cosmos. Pega Government Platform and Investigative Case
Management users can view events and their associated data.

Extending Event view page

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 308

2. Add the created property in the Details (PegaPS-Data-Event) section.


3. To display a new utility, create the utility in the PegaPS-Work-Event-Initiate class, and
add the utility to the pyCaseMainInner (PegaPS-Work-Event-Initiate) section.

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.

Adding new search criteria

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.

Adding a field to Search event search results

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.

Event creation through email


Applies to Theme Cosmos. The system can create an event work item for an inbound
email from a reporter. The system can also parse the email and map the information
from the email to an event work item.

©2024 Pegasystems Inc


Pega Government Platform '24.1 309

Customizing response message

To customize the response message, complete the following steps.

1. Save as the following HTML rules:


• EmailHeader (Work-)
• EmailResponse (Work-)
2. Update the rules based on your requirements.

Setting up an email listener for event creation

To configure an email listener in an implementation layer to initiate an event through


email, complete the following steps.

1. Create an email account.


a. Click Records > Integration-Resources, then click Email Account.
b. Save as the PegaPS-Work-ICM email account in the implementation layer, for
example, PegaPS-ICMImpl-Work-ICM.
c. Update the email address in the sender section and receiver section as
necessary.
2. Save as the ICMImplEventListener operator and change the access group to the
administrator access group of the implementation application.
3. Configure the email listener.
a. Click Records > Integration-Resources, then click Email Listener.
b. Save as the ICMEventEmailListener listener to the implementation layer, for
example, ICMImplEventEmailListener.
c. In the email account section of the listener, update it to use the email
account that was created earlier, which in this example, is PegaPS-ICMImpl-
Work-ICM.
d. Save as the service package (EmailApproval) and change the access group to
the administrator access group of the implementation application.
e. Update the service package in the Listener properties section of the email
listener.

©2024 Pegasystems Inc


Pega Government Platform '24.1 310

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 listener displays in the list.

Investigative Case Management


Applies to Theme Cosmos. The Investigative Case Management application is meant for
a different set of users, such as Investigators and ICMAgents. Use the application to
manage the entire life cycle of an investigation.

The following list details some of the features of Investigative Case Management:

• Create investigations either standalone or from an event.


• Capture details for a case by using components such as interview, evidence,
subject, and activity plans.
• Set the authorization of a user and how they search for, and view cases.
• Create case reports with features such as custom audits, visualizations, timeline
control, and case closure.

©2024 Pegasystems Inc


Pega Government Platform '24.1 311

• 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.

Adding a field to existing investigation details form

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:

1. Create the new property in the PegaPS-Data-Investigation class in the


implementation layer.
2. Add the newly created property to the CaptureInvestigationInformation (PegaPS-
Data-ICM-Investigation) section. Save as the section in the implementation layer.
3. Add a new property to an external organization:
a. Create the new property in PegaPS-Data-Entity-Business, if the property does
not exist.
b. By adding a column in the table, add the newly created property in the
OrganizationList (PegaPS-Data-ICM-Investigation) section.
c. Update the BusinessListWithAddress report definition with the new property
created above.

©2024 Pegasystems Inc


Pega Government Platform '24.1 312

Viewing an investigation

As an Investigative Case Management user, view an investigation and the associated


data collected during the investigation.

The case view shows the relevant information about the investigation in different tabs.

Investigation-specific data is displayed on the Details tab as an overview.

Add the property to display in the Details (PegaPS-Data-ICM-Investigation) section.


For information about adding a property, see Adding a field to the existing investigation
details form.

Adding a search field

Search investigations in the system by using basic information such as investigation


name, investigation ID, status, and reported activity.

To add a search field, complete the following steps.

1. Open the D_SearchInvestigationResults data page and the InvestigationResults


(PegaPS-Work-ICM-Investigation-Initiate) report definition. Add a parameter under
the Parameters tab to both the rules.
2. On the Query tab of the InvestigationResults (PegaPS-Work-ICM-Investigation-Initiate)
report definition, add the filter condition for the respective column.
3. Open the SearchInvestigationTable (PegaPS-Data-Portal) section. Open the table
properties and pass the search text to the newly added parameter of the data
page.
4. To show the new field in the results, add the new column to the table in the
section with the property.

Adding field in the search results

You can search the investigations in the system by using basic information such as date
range, investigation ID, category, and so on.

©2024 Pegasystems Inc


Pega Government Platform '24.1 313

To add a field in the search results, complete the following steps.

1. On the Query tab of the InvestigationList (PegaPS-Work-ICM-Investigation-Initiate)


report definition, add the column to display in results.
2. Open the SearchResults (PegaPS-Data-ICM-Investigation) section. Add a column to
the table and set it to the property to retrieve from the report definition.

Setting up an email listener for investigation acceptance in an


implementation layer

To configure an email listener in an implementation layer for the acceptance of


investigation through email, complete the following steps.

1. Create an email account.


a. Click Records > Integration-Resources, and then click Email Account.
b. Save as the PegaPS-Work-ICM-Investigation-Initiate email account to the
implementation class of the investigation, for example, PegaPS-ICMImpl-
Work-ICM-Investigation-Initiate.
c. Update the email address as necessary in the sender section and the
receiver section.
2. Save as the ICMInvestigationListener operator and change the access group to the
administrator access group of the implementation application.
3. Configure an email listener.
a. Click Records > Integration-Resources, and then click Email Listener.
b. Save as the InvestigationAcceptEmailListener listener, for example,
InvestigationAcceptEmailImpl.
c. In the email account section of the listener, update it to the email account
that was created in step 1, for example, PegaPS-ICMImpl-Work-ICM-
Investigation-Initiate.
d. Save as the service package (InvestigationEmailDefault) and change the access
group to the administrator access group of the implementation application.
e. Update the service package in the Listener properties section of the email
listener.

©2024 Pegasystems Inc


Pega Government Platform '24.1 314

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.

Adding a field to the existing subject details form

To capture more details when adding a subject to the system, complete the following
steps.

Add a new subject type.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 315

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.

• To open the subject view page, click the Name link.


• To view the newly created entity details, create the SubjectDetailsRO view in the
newly created entity class.

For more details, refer to EntityDetails (PegaPS-Work-ICM-Subject-Initiate) class.

Adding a search field for a subject

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 search field, complete the following steps.

1. Open the D_SearchSubjectResults data page and the SearchSubjectResults (PegaPS-


Work-ICM-Subject-Initiate) report definition. Add a parameter under the
Parameters tab to both the rules.
2. On the Query tab of the SearchSubjectResults (PegaPS-Work-ICM-Subject-Initiate)
report definition, add the filter condition for the respective column.
3. Open the SearchSubjectTable (PegaPS-Data-Portal) section. Open the table
properties and pass the search text to the newly added parameter of the data
page. If the new parameter does not display, reenter the data page name.
4. Add the new column to the table in the section with the property to show the new
filed in the results.

Adding a field in the search results for a subject

To add a field in the search results for a subject, complete the following steps.

©2024 Pegasystems Inc


Pega Government Platform '24.1 316

1. On the Query tab of the SearchSubjectList (PegaPS-Work-ICM-Subject-Initiate) report


definition, add the column to display in results.
2. Open the SearchResults (PegaPS-Data-ICM-Entity) section. Add a column to the
table and set it to the property to retrieve from the report definition.

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.

Adding a field to an existing interview details form

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:

1. Create the property in the PegaPS-Data-Interview class.


2. Add the newly created property to the InterviewInfo (PegaPS-Data-Interview)
section.
3. Add a property to interview participants:
a. Create the property in the PegaPS-Data-Association class.
b. Add the newly created property to the ParticipantsList (PegaPS-Data-
Association) section.
4. Add an interview template:
a. Switch to App Studio and click the PGP wrench icon.
b. Click Interview templates and add new template to the existing list.

©2024 Pegasystems Inc


Pega Government Platform '24.1 317

Viewing an interview

An Investigative Case Management user can view an interview and the associated data
that was collected during the interview.

1. Add the property to display in the InterviewInfoRO (PegaPS-Data-Interview) section.


For information about adding a property, see Adding a field to the existing
interview details form.
2. Update the InterviewList (PegaPS-Data-Interview) report definition to retrieve the
property.

Extending the Interview case

The Interview case type can be extended to any other cases by completing the following
steps.

1. Click Case types.


2. Click the vertical ellipsis, and then click Open.
3. Add the Interview case as a child case type.
4. Save your changes.
5. To show the list of interviews of a case type, include the InterviewTab (PegaPs-Work)
section in the pyCaseMainInner section as a new tab.

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.

Extending evidence case

The Evidence case type can be extended to any other cases by completing the following
steps.

1. Click Case types.


2. Click the vertical ellipsis and then select Open.

©2024 Pegasystems Inc


Pega Government Platform '24.1 318

3. Add the Evidence case as a child case type.


4. Save your changes.
5. To show the list of evidences of a case type, include the EvidenceTab (PegaPs-Work)
section in the pyCaseMainInner section as a new tab.

Capture item from evidence case

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.

Configuring capture item details case designer

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.

1. Log in to Pega Government Platform as an administrator.


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 evidence case type.

©2024 Pegasystems Inc


Pega Government Platform '24.1 319

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.

Extending Evidence data

To extend Evidence data, complete the following steps.

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.

1. Add the property to display in the EvidenceInfoRO (PegaPS-Data-Evidence) section.


2. Update the EvidenceList (PegaPS-Data-Evidence) report definition to retrieve the
property.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 320

You can launch the Associations case from User Portal by performing either of the
following actions:

• On Create menu, click Associations link.


• On Entity view screen or from case instance, in the Associations utility widget,
click Gear icon.

Manage associations case architecture

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.

LinkedToID is the ID to which the association is mapped. Associations are retrieved


from the D_AssociationListDetails data page which inturn invokes D_AssociationList.
The following are passed as parameters to the data page EntityID, EntityType and built-
on application CSV.

• 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.

The D_AssociationList is sourced from the PegaPS-Data-Link (Link) database table by


using the EntityAssociations report definition. This report definition excludes entries
from the Link table that have pyMemo set as Associate, Bid, Branch, Experience,
Reporter, or Training that represents associations for other widgets of the entity view
that are skipped in the Manage associations case to avoid redundancy.

FetchAssociationListDetails (Code-Pega-List) is the response data transform that is run


on D_AssociationList. This iterates through the results from the Link table and forms
Primary.pxResults, which is of the PegaPS-Data-Association. This data transform has the

©2024 Pegasystems Inc


Pega Government Platform '24.1 321

logic to set the LinkedFromID, LinkedToID, LinkedClassFrom, LinkedClassTo, Role,


IsReverseRole, and Entity Image data class fields, that are defined in the PegaPS-Data-
Association class or its inheritance class to support associations.

Different categories of roles are maintained in the Option map (PegaPS-Data-Config-


OptionMap) table, such as for example, PersonPerson, PersonBusiness, and
BusinessFacility. This table holds all of the possible roles between the Person to Person,
Person to Business, and other associations.

Reverse roles are defined in the AssociationsRoleMapping and


ICMAssociationsRoleMapping (PegaPS-Data-Association) decision tables for PGP and ICM
layer. The FetchAssociationListDetails data transform uses this decision table to
retrieve the reverse role if the associations are to be displayed in the context of the
LinkedToID but not in the context from where the association is created.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 322

To update or add new validations, update the CheckDuplicateAssociation (PegaPS-


Work-Manage-Associate) activity and the ManageAllAssociations (PegaPS-Work-
Manage-Associate) validate rule.

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."

Adding a data element

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.

1. Add a property to the PegaPS-Data-Association class, for example, Place.


2. Add a property to the PegaPS-Data-Link class, for example, Place.
3. Add a column to the database table that is mapped to the PegaPS-Data-Link class.
4. Fetch the property in the EntityAssociations report definition.
5. Add a mapping to the property in FetchAssociationListDetails.
6. Add the new property to the AssociationList (PegaPS-Work-Manage-Associate)
section.
7. Add the new property to the SaveAllAssociaties (PegaPS-Work-Manage-Associate)
activity and SaveLink (PegaPS) activity

Adding an entity type

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 323

1. In the Option map (PegaPS-Data-Config-OptionMap) data type, in the


field FromAssocType, add a new entry for Land.
2. In the Option map (PegaPS-Data-Config-OptionMap) data type, for the new field
value LandAssocType, add entries for Person, Business, Facility, and Vehicle.
3. Flush D_OptionMapList data page and D_PGPOptionMapList for PGP,
D_ICMOptionMapList for ICM.
4. Update the D_EntityList data page to add logic for land to fetch the list of Land
details.
5. Update the PreFromAssociateSearch (PegaPS-Work) data transform to add logic
for the new entity type. Refer to the existing steps added for a Person Entity in the
PreFromAssociateSearch data transform and add steps in data transform for
Land entity accordingly.
6. Create a FromAssociateSearch section for the new entity to add search criteria
and results.
7. Update the PreAddAllassociates and ResetAddAssociate data transforms to
add logic for Land. Refer to the existing steps added for a Person Entity in the data
transforms and add steps for Land entity accordingly.
8. Create AssociateLand section and Update the AddAllAssociates section to include
the AssociateLand section and add a visibility condition based on the
AssociateType.
9. Create a data transform for initializing a new Land page, which is referenced when
a new Land is created and added as an associate.
10. Create a new validate rule for validating Land Entity related fields and update
ValidateAssociations validate rule to call the new validate rule.
11. Update PostAddAllAssociates activity to add logic for Land. Refer to the existing
steps related to Person Entity and add the same for Land accordingly.
12. Update CheckduplicateAssociation activity to add logic for Land.
13. Update SaveAllAssociates activity to add logic for Land.

©2024 Pegasystems Inc


Pega Government Platform '24.1 324

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.

1. Adding new associations.


2. Modifying the existing association details like role, change in time period.
3. Removing the associations.

Extend audit history for an association

To extend audit history for a new field, update PropertiesToCompare (CL:PegaPS-Data-


Association) data transform to set a new field.

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

Creating new associations from a case type

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 layer case type: Inspection

Implementation class : PGPGov-PGPImpl-Work-Inspection

©2024 Pegasystems Inc


Pega Government Platform '24.1 325

Inspection case type

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 326

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.

Insvestigation use case

©2024 Pegasystems Inc


Pega Government Platform '24.1 327

Extending associations for a new case type

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:

1. Save as pyCaseMainInner section from PegaPs-Work (RS:


PGPCosmosOverride:08-06-01) to your implementation layer work class for the
respective case type i.e., PGPGov-PGPImpl-Work-Inspection.
2. Navigate to Utils region and click on + icon on the region.
3. Click Data display and select embedded section.
4. From the section drop-down select AssociationUtility section and click Submit.
5. Once the embedded section is added, click on save.
6. Create Inspection case and add association.
7. Once the case is created and associated, you can see the association widget in the
case utility panel with the association details.
8. In the association details in association widget and visualization, currently we will
only see the case ID of the new case type.
9. An extension point is provided in the data transform IdentifyAssociationItems to
add any additional properties.
10. To represent the label of the case type instead of ID in Association widget, create
IdentifyAssociationItems_ImplExt data transform in PegaPs-Data-Association class in
implementation layer ruleset and add the code to set few properties such as
AssociateName, AssociateType, and so on.
In this example for Inspection case type, we can set the properties as below

©2024 Pegasystems Inc


Pega Government Platform '24.1 328

Extending associations

11. Create IdentifyAssociationItems_ImplExt_Img in implementation layer ruleset to add


any image related properties.

Extending visualization for a new case type

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.

1. Create a custom image record in Data-Content-Image class for Inspection case


type.
2. Save as the EntityAssociationControl rule into implementation layer and add the
code for new case type created for setting the custom image and label. In this
case for inspection case type, add the code snippets.

©2024 Pegasystems Inc


Pega Government Platform '24.1 329

Entity association control

Entity association control

3. Once the above snippets are added, we can see the image and label in association
visualization.

©2024 Pegasystems Inc


Pega Government Platform '24.1 330

Visualize

Association visualization

Extending associations for a new entity

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 331

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:

Data class - PGPGov-PGPImpl-Data -Entity-Asset

Work classes -

• PGPGov-PGPImpl-Work-Entity-Asset-Add
• PGPGov-PGPImpl-Work-Entity-Asset-View
• PGPGov-PGPImpl-Work-Entity-Asset-Update

Follow these steps to extend Associations for new entity:

1. Save as pyCaseMainInner section from PegaPs-Work (RS:


PGPCosmosOverride:08-06-01) to your implementation layer work class for the
respective case type i.e., PGPGov-PGPImpl-Work-Entity-Asset-View.
2. Navigate to Utils region and click on + icon on the region.
3. Click Data display and select embedded section.
4. From the section drop-down select AssociationUtility section and click Submit.
5. Provide the page context for the section as .Asset.
6. Once the embedded section is added, click Save.

©2024 Pegasystems Inc


Pega Government Platform '24.1 332

©2024 Pegasystems Inc


Pega Government Platform '24.1 333

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 334

D_Entity data page

10. An extension point is provided in the data transform IdentifyAssociationItems to


add any additional properties.
11. To represent the label of the Entity instead of ID in Association widget , create the
IdentifyAssociationItems_ImplExt data transform in PegaPs-Data-Association class in
implementation layer ruleset and add the code to set few properties such as
AssociateName, AssociateType, and so on for the entity type asset.
In this example for Asset entity, we can set the properties as below:

Asset entity

12. Create IdentifyAssociationItems_ImplExt_Img in implementation layer ruleset to add


any image related properties.

©2024 Pegasystems Inc


Pega Government Platform '24.1 335

Extending visualization for a new 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.

Let’s say Asset is a new Entity created in implementation layer.

1. Create custom image record in Data-Content-Image class for Asset.


2. Save as the EntityAssociationControl rule into implementation layer and add the
code for new entity.
3. In this case for Asset entity, add asset value to the strEntityList.

String[] strEntityList = { "person","business","vehicle","facility","household","ite


m","asset" };

Extending visualization

4. Once the above code is added, we can see the image and label in association
visualization.

©2024 Pegasystems Inc


Pega Government Platform '24.1 336

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 337

selected through Application request. After a user applies for a license or program it is
sent for review.

©2024 Pegasystems Inc


Pega Government Platform '24.1 338

Application request

If the application is approved, an instance of license/program is created and these are


listed in “Programs” tab of entity.

©2024 Pegasystems Inc


Pega Government Platform '24.1 339

The following image shows programs/licenses of a person:

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 340

Program finder case type

Technical description

The following work class is used for Program finder case type in PGP.

PegaPS-Work-ProgramFinder

Extensions

A decision table named ProgramsEligible is introduced in program Finder case type to


check the eligibility criteria based on the responses and display the eligible programs
and licenses. This decision table is available as extension and can be customized as per
the requirement. Currently from PGP, this decision table is shipped empty.

To extend this, save as this rule into implementation layer and add the conditions to
decision table as per the requirement.

©2024 Pegasystems Inc


Pega Government Platform '24.1 341

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.

Managing reference data


Applies to Theme Cosmos. Manage reference data in cases and applications.

Option map feature

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 342

The following are the benefits of this pattern:

• 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

Building blocks of the option map feature.

The option map consists of three basic elements.

• 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.

Data type definition

Label Property Description

ID .pyID Unique Instance ID

Display Value .pyLabel Display Name

Code .Code Value

Display Order .DisplayOrder Integer index

Field Name / Group .Purpose Field Group (Category)

Option Map Data Management

©2024 Pegasystems Inc


Pega Government Platform '24.1 343

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.

Option map data type record editor

D_OptionMapList Data Page

The D_OptionMapList is a Requestor scoped data page that takes two parameters.

• FieldName (required) which supplies the label common to a collection of


OptionMap instances.
• Code (optional) which may be provided in special circumstances to retrieve a
specific OptionMap instance.

©2024 Pegasystems Inc


Pega Government Platform '24.1 344

LoadOptionMapList Data Transform

The D_OptionMapList data page is populated by the LoadOptionMapList data


transform which may be superseded or overridden in an implementation layer should
detailed control of the list be required.

Using Option map data in a picker control

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.

Option map auto complete list source

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 345

Reports on investigation

Users logging with ICMCosmosSupervisor,ICMCosmosAgent access have reports


related to investigations in dashboard.

The following are the reports:

• 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

Users with access other than “ICMCosmosSupervisor,” “ICMCosmosAgent” have reports


related to events in dashboard.

The following are the reports:

• 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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 346

Events Report

To make changes open “EventsByLocation”(CL: PegaPS-Work-Event-Initiate) section


and “EventsByLocation” (CL: PegaPS-Work-Event-Initiate) report definition.

• Event by Status: The following is a pie chart representing event cases against their
status.

Events report by status

©2024 Pegasystems Inc


Pega Government Platform '24.1 347

To make changes, open “EventsByStatus”(CL PegaPS-Work-Event-Initiate) section


and “EventsByStatus” (CL: PegaPS-Work-Event-Initiate) report definition.

Note: The above report excludes resolved cancelled status.

Reports on application request

Users logging into PGPCosmos and ICMComos applications have reports on application
requests in dashboard.

The following are the reports:

• Application Request by Status: The following Bar graph represents the count of
applications based on their status.

Application request by status

To make changes open “AppRequestByStatus”(CL: PegaPS-Work-ApplicationRequest)


section and “AppRequestByStatus” (CL: PegaPS-Work-ApplicationRequest) report
definition.

©2024 Pegasystems Inc


Pega Government Platform '24.1 348

Note: The above report excludes resolved cancelled status.

• Recent certificates issued: The following line graphs show different certificates
approved in the last seven days.

Certificates issued recently

Nearby cases chart

This chart provides the information on cases within the given range of distance.

©2024 Pegasystems Inc


Pega Government Platform '24.1 349

Nearby cases chart

Adding a new report or chart to dashboard

Easily add new reports or charts to your dashboard or edit chart labels with our simple
step-by-step guide.

To add a new report or chart to dashboard, follow these steps:

1. Open pyDefautUserDashboard and add a step.


2. Set action as Update Page.
3. In Target, give .pySlots(number).pyWidgets(number) and set the following values as
shown in example

Add report/chart

©2024 Pegasystems Inc


Pega Government Platform '24.1 350

Edit labels of a chart

To edit lables of a chart, follow these steps:

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.

Search program landing page


Applies to Theme Cosmos. The landing page can be accessed from the left navigation
pane. Programs/Licenses can be searched using details such as category, subcategory,
name of program/License and entity type, entity name. The ID and Entity Name
columns are provided as links to view details if required.

Adding a search field

To add a search field, complete the following steps:

1. Open D_SearchProgramListdata page and add a parameter under the Parameters


tab.
2. In Data Sources, open all the reports included as source.
3. In each report add parameter and update the filter conditions accordingly.

Adding field in search results

To add a field in the search results, complete the following steps:

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 351

Adding field to search criteria

To modify the search criteria open "SearchProgramTableHeader"(CL-PegaPS) and add


or deletes fields as required.

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.

In Pega Government Platform, document configuration can be done in two ways.

1. Review checklist configuration from App studio

2. Checklist config component configuration in runtime

©2024 Pegasystems Inc


Pega Government Platform '24.1 352

Configuring review checklist from App Studio

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.

Using review checklist

Configure a checklist type and add the component to a step in a stage.

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.

Configuring a checklist 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.

1. In the navigation pane of App Studio, click PGP.


2. In the PGP explorer, click Review checklist.
3. Click the New checklist button to create a new review checklist.
4. In the Purpose box, enter a purpose for the checklist.
5. In the Checklist items section, click Add checklist item to add a new checklist item.
6. In the Label box, enter a label for the review checklist items. The corresponding
code appears in the Code box.
7. Click Save.

©2024 Pegasystems Inc


Pega Government Platform '24.1 353

Configuring review checklist in case designer

Configure the review checklist component in App Studio to use in a case type, as a step,
in any of the stages.

1. Log in to Pega Government Platform as an administrator.


2. In the header of your studio, click the Switch Studio menu, and then click .
3. In the navigation pane of , 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 > Review Checklist.
7. Click the Select button.
8. In the Checklist details section, in the Source list, select the name of the checklist
type that the Review Checklist shows:
• To choose a specific checklist type, select By name, and then, in the Checklist
type list, click one of the items.
• To specify a property in the work class that supplies a specific checklist type
at run time, select By property, and then enter a property value that is a
valid checklist type.
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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 354

Figure: Section showing the routing details

10. Click Save.

Configuring checklist component in runtime

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.

User can configure the Checklist sub-configuration as follows:

• Select existing: Users can choose from existing configurations.

©2024 Pegasystems Inc


Pega Government Platform '24.1 355

• 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.

The following validations are provided as part of this component:

• 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.

Configuring checklist config component in case designer

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.

Follow these steps to configure the section component:

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).

©2024 Pegasystems Inc


Pega Government Platform '24.1 356

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 357

©2024 Pegasystems Inc


Pega Government Platform '24.1 358

Persist checklist

Persist configurations

3. To add Validation from App studio


a. Navigate to Configure view of step and switch to Validations tab. Search for
IsChecklistEmpty to validate the empty config list (select if required).

©2024 Pegasystems Inc


Pega Government Platform '24.1 359

Configure view

b. For duplicate entry, search for IsChecklistDuplicate in When condition.

Duplicate entry

4. To invoke validation rule, Open Flow action from Dev Studio.


a. For all validations Call ValidateChecklistConfig (under Validate tab).

Validation criteria

Adding a new checklist purpose

Follow these steps to add a new Checklist configuration as a step or view for one of the
case types.

1. Create a case and navigate to Checklist Config section .


2. Select Create new and provide a name for the new checklist set.
3. Enter the other details and click Submit.

Once the case is submitted and a new checklist set is created.

©2024 Pegasystems Inc


Pega Government Platform '24.1 360

New checklist set

Extending review checklist

Implement a simple data-driven review component. If your application requires more


robust question and answer capabilities, use the Pega Government Platform
Assessments feature.

©2024 Pegasystems Inc


Pega Government Platform '24.1 361

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.

• MapConfiguration (PegaPS-Work): Wrapper Data Transform with Extension. Extra


Parameters can be defined and form respective configuration list based on logic.
• ResetConfigValues (PegaPS-Work): Wrapper Data Transform with Extension. Extra
Parameters can be added and Reset config values based on parameters
• SetConfigsToCaseProperties_Ext (PegaPS-Work): Extension Data Transform to set
config properties to Case type

Note: The review checklist feature is provided as a simple reusable self-


contained table-driven control. Use the review checklist feature as-is without
rule or UI customization. Overriding the rules that compose review checklist
and CheckListMap is not recommended and may cause unexpected behavior
during Pega Government Platform version upgrades.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 362

In Pega Government Platform (PGP), Consent agreement configuration can be done in


two ways.

• Consent agreement configuration from App Studio


• Consent agreement configuration in runtime case

©2024 Pegasystems Inc


Pega Government Platform '24.1 363

Configuring consent agreement from App studio

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.

1. Log in to Pega Government Platform as an administrator.


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 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 > Consent
agreement.
7. Click the Select button.
8. In the Consent agreement details section, in the Source list, select a source.
a. Select By name, and in the Consent agreement template list, select an
agreement type.
b. Alternatively, select By property to specify a property on the work class that
supplies the specific agreement type at run-time.
9. Select the Is e-signature required? check box to include an e-signature.
10. 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.
11. Click Save.

©2024 Pegasystems Inc


Pega Government Platform '24.1 364

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.

Configuring consent agreement in runtime case


Applies to Theme Cosmos. Consent agreement config is a section component that can
be used in any case type screen to configure it at runtime. You can select the consent
agreement whichever is required to be configured for your case in run time case. Users
will also have an option to enable capturing digital signatures.

Configuring consent agreement config component in case designer

This section component can be used in any case type as a step in any of the stages or
as a view.

1. Log in to Pega Government Platform as an administrator.


2. In the header of your workspace, click 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 Consent agreement config and click + icon.

©2024 Pegasystems Inc


Pega Government Platform '24.1 365

Configuring consent agreement

Extensions

To set additional configuration properties to case type, use the following extension data
transform. Extend it in implementation layer for any customization.

SetConfigsToCaseProperties_Ext (PegaPS-Work) data transform : Extension data transform


to set config properties to case type.

Extending consent agreement


Applies to Theme Cosmos.Extend the Consent Agreement feature to add additional
templates or edit the existing template text.

Note: To create new consent agreement templates, you must switch to Dev
Studio.

1. In the navigation panel of Dev Studio, click Records.


2. Click Data Model > Property.
3. Click the filter for Property Name, and then search for
ConsentAgreementTemplate.
4. Click the property.

©2024 Pegasystems Inc


Pega Government Platform '24.1 366

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.

Figure: Adding a new consent agreement template

13. Click Save.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 367

Document intake
Applies to Theme Cosmos. Document intake enables you to attach the required
documents for a particular category.

You can do the following from App Studio.

• 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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 368

In PGP, document configuration can be done in two ways.

• Document configuration from App studio


• Document configuration in runtime case

Configuring document from App studio

Configuring document intake in case designer

Applies to Theme Cosmos. Use the Document intake process component in a case type
as a step in any of the stages.

1. Log in to Pega Government Platform as an administrator.


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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 369

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.

Viewing the added documents in read-only view

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.

Editing or adding a new document purpose

Applies to Theme Cosmos. Add a new document purpose with a list of documents.

©2024 Pegasystems Inc


Pega Government Platform '24.1 370

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.

1. Log in to Pega Government Platform as an administrator.


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 PGP, and then click Document intake.
4. Click a document category to edit it, or click the New document button to create a
new document category.
5. In the Purpose box, enter the purpose of the document category.
6. In the Document items section, click Add documents to add them to the category.
7. Configure the document items as desired and click Save.

©2024 Pegasystems Inc


Pega Government Platform '24.1 371

Configuring document in runtime case


Applies to Theme Cosmos. Document config is a section component which 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.

User can configure the document sub-configuration in any run time case as follows:

• Select existing: Users can choose from existing document configurations.

• 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.

Configuring document config component in case designer

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.

Follow below steps to configure the section component:

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 372

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 373

©2024 Pegasystems Inc


Pega Government Platform '24.1 374

Persist document set checkbox

Persist configurations

3. To add validation from App studio:

a. Navigate to configure view of step, switch to Validations tab and search for
IsDocumentSetListEmpty to validate the empty config list . (Select if needed)

©2024 Pegasystems Inc


Pega Government Platform '24.1 375

Validating from App studio

b. Search for IsDocumentSetDuplicate when condition as shown for duplicate


entry.

Validating duplicate entry

4. To invoke validation rule, open Flow action from Dev studio.

For all validations call ValidateDocumentSetConfig (under validate tab).

©2024 Pegasystems Inc


Pega Government Platform '24.1 376

Validation criteria

Adding a new document purpose

Document configuration added as step or view for one of the case type.

1. Create Case and navigate to Document config section.


2. Select Create New and provide a name for the new document set.
3. Once the case is submitted, a new document set is created.

©2024 Pegasystems Inc


Pega Government Platform '24.1 377

New document set

©2024 Pegasystems Inc


Pega Government Platform '24.1 378

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.

MapConfiguration (PegaPS-Work): Wrapper Data Transform with Extension. Extra


Parameters can be defined and form respective configuration list based on logic.

ResetConfigValues (PegaPS-Work): Wrapper Data Transform with Extension. Extra


Parameters can be added and Reset config values based on parameters

SetConfigsToCaseProperties_Ext (PegaPS-Work): Extension Data Transform to set config


properties to Case type

Extending document intake


Applies to Theme Cosmos. Override the UploadDocument (PegaPS-Work) wrapper section
that is shown to the user at run time to a specific application or to a specific case to
update the UI as per your requirement.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 379

Users can opt to approve or reject each document with comments and configure
rejection stage to route only the rejected documents.

©2024 Pegasystems Inc


Pega Government Platform '24.1 380

Verify document

Configuring verify document in case designer

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.

1. Log in to Pega Government Platform as an administrator.


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 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 > Verify document.
7. Click the Select button.
8. In the Routing details area, select an operator:
• To route the assignment to the current operator, click Current operator.

©2024 Pegasystems Inc


Pega Government Platform '24.1 381

• 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.
9. In the Reject stage list select a stage to configure the rejection stage when
documents are rejected as a part of the review process.
10. Check the Approve or Reject specific docs check box to reject or approve each
document.
11. Click Save.

Extending verify document

Applies to Theme Cosmos. Add more document review options in addition to the
existing options.

VerifyDocument section (PegaPS-Work)


The wrapper section shown to the user at run time. You can override the section
to a specific application or to a specific case to update the UI as per the
requirement.
VerifyDocument flow (PegaPS-Work)
The flow that holds the logic of routing to other stage when the verification is
rejected. You can override the flow to a specific class or application as per the
requirement.

1. In the navigation panel of Dev Studio, click Data types.


2. Click Data types > Option map.
3. Click the Records tab.
4. Click the filter for the Field name / Group column.
5. In the Search Text box, enter Doc review action and then click Apply.
6. Click Add record to add a new record, for example, Pending.

©2024 Pegasystems Inc


Pega Government Platform '24.1 382

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 383

Configuring Nearby locations

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.

1. Log in to Pega Government Platform as an administrator.


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 the New button to create a
new case type.

©2024 Pegasystems Inc


Pega Government Platform '24.1 384

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 385

Extending Nearby locations

Extend the Nearby locations component depending on the business use case and
requirement.

Enabling a new case type for nearby cases search

Enable a new case type to retrieve on search.

1. Log in to Pega Government Platform as an administrator.


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 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 > Persist proximity
location.
7. Click the Select button.
8. Expand Parameters and pass the property, which has the location to the process,
as a parameter.

Extending a new entity for nearby entity search

Add a new entity apart from the PGP-provided entities, as a part of nearby entity
search, in the Nearby locations component.

©2024 Pegasystems Inc


Pega Government Platform '24.1 386

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

1. In the navigation panel of Dev Studio, click Data types.


2. Click Data types > Option map.
3. Click the Records tab.
4. Click Add record to add a new entity with Field Name / Group as Entity .

©2024 Pegasystems Inc


Pega Government Platform '24.1 387

5. Save as NearbyCasesList_Ext data transform and set pyClassName to new entity


class when pyLabel is new entity.
6. Save as FetchProximityEntity report definition (CL:PegaPS-Data-Entity-Facility) into
New entity class and remove the Name property from columns.
7. Create a new data page similar to D_FetchFacilityProximity and call the report
definition created in the previous step.
8. To show a different marker pin, on the map, for the new entity, save as
SetEntityMarker data transform into the new entity class and set the MarkerImage
property with any binary file.
9. Save as SetNearbyAddressList_Ext activity, and load the data page created in step 7.
10. Save as SetNearbyCasesEntitesResult_Ext data transform and append data page
results to NearbyCasesEntities property.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 388

In PGP, Evaluate configuration can be done in two ways.

• Evaluate configuration from App studio

• Evaluate configuration in runtime case

Evaluating configuration from App studio

Configuring evaluate in case designer

Applies to Theme Cosmos. Use the Evaluate process component in a case type as a step
in any of the stages.

1. Log in to Pega Government Platform as an administrator.


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 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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 389

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.

Adding a new evaluation type

Applies to Theme Cosmos. Add a new evaluation type with list of evaluation criteria.

1. In the navigation pane of App Studio, click PGP.


2. In the PGP explorer, click Evaluation criteria.
3. Click the New criteria button to create a new evaluation type. You can also update
the existing evaluation criteria.
4. In the Evaluation type box, enter an evaluation type.
5. In the Evaluation items section, click Add evaluation item to add a new evaluation
item.
6. Enter the Evaluation criteria, Evaluation code, Maximum score, and Weight.

Note: The sum of all the weights of the criteria list must be equal to 100.

©2024 Pegasystems Inc


Pega Government Platform '24.1 390

7. Click Save.

Evaluate configuration in runtime case


Applies to Theme Cosmos. Evaluation criteria configuration 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.

User can configure the evaluation sub-configuration as follows:

• Select existing: Users can choose from existing configurations.

• 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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 391

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.

Validations provided as part of this component are as follows:

• 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.

Configuring evaluation criteria config component in case designer

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.

Follow these steps to configure the section component:

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 392

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 393

©2024 Pegasystems Inc


Pega Government Platform '24.1 394

Persist doc set

©2024 Pegasystems Inc


Pega Government Platform '24.1 395

Evaluate case lifecycle

Persist configurations

3. To add Validation from App studio


a. Go to Configure view of step, switch to Validations tab. Search for
IsEvaluationSetListEmpty to validate empty config list. (Select if needed)

Evaluation validation

b. Search for IsEvaluationSetDuplicate when condition as shown for duplicate


entry.

©2024 Pegasystems Inc


Pega Government Platform '24.1 396

Duplicate entry

4. To invoke validation rule, open Flow action from Dev studio.


a. For all validations call ValidateEvaluationSetConfig (under Validate tab).

Validation criteria

Adding a new evaluation type

Evaluation configuration added as view for one of the case type.

1. Create Case and navigate to Evaluation config section

©2024 Pegasystems Inc


Pega Government Platform '24.1 397

2. Select Create New and provide new evaluation set name


3. Once the case is submitted, a new evaluation set is created.

New evaluation set

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 398

MapConfiguration (PegaPS-Work): Wrapper Data Transform with Extension. Extra


Parameters can be defined and form respective configuration list based on logic.

ResetConfigValues (PegaPS-Work): Wrapper Data Transform with Extension. Extra


Parameters can be added and Reset config values based on parameters

SetConfigsToCaseProperties_Ext (PegaPS-Work): Extension Data Transform to set config


properties to Case type

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 399

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 400

©2024 Pegasystems Inc


Pega Government Platform '24.1 401

©2024 Pegasystems Inc


Pega Government Platform '24.1 402

Report for plans and option to convert to template

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 403

Activity plan usage

Sequencing an 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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 404

New activity plan template

©2024 Pegasystems Inc


Pega Government Platform '24.1 405

New activity plan template

Activity plan

©2024 Pegasystems Inc


Pega Government Platform '24.1 406

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 407

Add activity plan

©2024 Pegasystems Inc


Pega Government Platform '24.1 408

Assign work sequence

List of activity plans

Timeline for activity plan

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 409

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 410

Configuring activity plan in case designer

Applies to Theme Cosmos. Create an activity plan component as a step in an


investigation case. You can add from the existing activity plan template, create a custom
activity plan, and delete or update activity plans for the investigation.

1. Log in to Pega Government Platform as an administrator.


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 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 Add activity plan.
7. Click the Select button.
8. In the add activity plan details section, in the Operators list type, select a type.
a. When Participants is selected, the list of work parties of the case type from
where the plan is launched are populated while assigning the goals and
tasks.
b. Alternatively, select All operators to show all the available operators in the
system while assigning the goals and tasks.
9. In the Source, Select a source.
a. Select By Name, Select existing plans available in the system from the
Activity plan template dropdown. This option is used to populate the plan
details based on the selected plan in dropdown instead of selecting the plan
in every run.
b. Select By property reference, Select the property from the autocomplete.
This option is used to populate the plan details based on the selected
property value. Here property value will refer to the plan name.
c. Select By configuration set. This option is used to populate the plan details
based on the configuration set.
10. In the Routing details area, select an operator:

©2024 Pegasystems Inc


Pega Government Platform '24.1 411

a. To route the assignment to the current operator, click Current operator.


b. 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.
c. 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.
11. Click Save.

Enabling or disabling Activity plan 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

©2024 Pegasystems Inc


Pega Government Platform '24.1 412

descriptions of Plan, goal, and task cases in runtime after the creation. Disabling will
not display the Edit button in the case.

To enable/disable the timesheet deadline validation at runtime, follow these steps:

1. On the navigation pane of App Studio, click Settings > Configurations


2. Click Settings at the end of the Edit plan or goal or task details row.
3. Select constant value as True to enable editing and click Submit.
4. Select constant value as False to disable editing and click Submit.

Configure setting

Configuration set

©2024 Pegasystems Inc


Pega Government Platform '24.1 413

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.

Extending work queue assignments

Extending task details

Applies to Theme Cosmos. Create, update, and delete tasks in activity plans. You can
add custom tasks and create SLAs in days and hours.

1. Log in to Pega Government Platform as an administrator.


2. In the header of your workspace, click the Switch Studio menu, and then click App
Studio.
3. In the App Studio navigation pane, click Data, and then click the Task case type.
4. Click Add field to create a field, for example, Title.
5. In the Tasks tab of the Activity plan landing page, click the Add task button.
6. Navigate to the Add task view.

©2024 Pegasystems Inc


Pega Government Platform '24.1 414

7. Click the Add icon and add a new field.

8. Click Save.

Extending goal details

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.

1. Log in to Pega Government Platform as an administrator.


2. In the header of your workspace, click the Switch Studio menu, and then click App
Studio.
3. In the App Studio navigation pane, click Data, and then click the Goal case type.
4. Click Add field to create a field, for example, Title.
5. In the Goals tab of the Activity plan landing page, click the Add goal button.
6. Navigate to the Add goal template view.
7. Click the Add icon and add new field.

©2024 Pegasystems Inc


Pega Government Platform '24.1 415

8. Click Save.

Extending plan details

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.

1. Log in to Pega Government Platform as an administrator.


2. In the header of your workspace, click the Switch Studio menu, and then click App
Studio.
3. In the App Studio navigation pane, click Data, and then click the Plan case type.
4. Click Add field to create a field, for example, Title.
5. Click the Add activity plan button from the landing page.
6. Navigate to the Plan template information view.
7. Click the Add icon and add a new field.

©2024 Pegasystems Inc


Pega Government Platform '24.1 416

8. Click Save.

Include an existing template while converting to template

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:

1. Create similar property (for example, SLADuration) in Index-PegaPS-Activity class.


2. Add the property for indexing in declare index rules – SaveIndexForActivityPlan,
SaveIndexForGoal, and SaveIndexForTask.

©2024 Pegasystems Inc


Pega Government Platform '24.1 417

Declare index rule - SaveIndexForActivityPlan

©2024 Pegasystems Inc


Pega Government Platform '24.1 418

Declare index rule - SaveIndexForGoal

©2024 Pegasystems Inc


Pega Government Platform '24.1 419

Declare index rule - SaveIndexForTask

3. Update the following report definitions to include the property as a column.


a. GetChildCasesListNew
b. GetCustomChildCases
c. GetKeysUsingTemplate
d. GetNewPlanDetails

©2024 Pegasystems Inc


Pega Government Platform '24.1 420

Report definition - GetChildCasesListNew

4. Add a new step in GetPlanDetails data transform and set the property.

Data transform - GetPlanDetails

5. Add a new step in SetIndexDetailsToConfig data transform and set the property.

©2024 Pegasystems Inc


Pega Government Platform '24.1 421

Data transform - setIndexDetailsToConfig

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.

In Pega Government Platform, access to Assessment landing page is given to a specific


access group, for example, the manager access group. To show the Assessment landing
page for another access group, update the setting from the Portals &pages tab.

©2024 Pegasystems Inc


Pega Government Platform '24.1 422

For Investigative Case Management, Assessment is added only for the ICM Manager
access group.

Summary of features

Configuration of assessment includes providing an SLA name and interpretation with


minimum or maximum score range. The following are the typical steps in working with
assessments:

1. Configure the assessment for SLA and interpretations.


2. Conduct an assessment from a case, for example, from an investigation case.
3. View the conducted assessments from a case with interpretation score and status.
4. Calculate risk.

In Pega Government Platform, Assessments configuration is done in two ways:

• Assessment configuration from App Studio


• Assessment configuration in runtime case

Configuring assessments from App studio

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 423

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.

1. Log in to Pega Government Platform as an administrator.


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 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 > Conduct
assessment.
7. Click the Select button.
8. From configuration panel, select the source of the assessment.

Configuring Assessment in runtime case

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.

Configuring Assessment config component in case designer

This section component can be used as a step in any case type in one of the stages or
as a view.

1. Log in to Pega Government Platform as an administrator.

©2024 Pegasystems Inc


Pega Government Platform '24.1 424

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

Configure SLA and interpretations based on score of the assessment answers.


Configure interpretations for the assessment.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 425

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.

Adding a field to an assessment configuration

Add a new data field or property and extend an existing assessment.

1. In the navigation pane of , click Records.


2. Expand the SysAdmin category, and then click Class.
3. Click the filter for Class Name.
4. In the Search Text field, enter PegaPS-Data-Config-Assessment and click Apply.
5. Click the rule to open it.
6. Create a property in the PegaPS-Data-Config-Assessment class.
7. Include the newly created property in the AssessmentConfiguration (Rule-PegaQ-
Questionnaire) section.
8. Update the D_AssessmentConfigurationList data page report definition to include
the newly created property.

©2024 Pegasystems Inc


Pega Government Platform '24.1 426

Adding a service level agreement (SLA) to an assessment


configuration

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.

Multiple entity intake


Applies to Theme Cosmos. The multiple entity intake feature enables you to capture
information about multiple persons in a single step.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 427

Multiple entity intake components

For multiple persons feature, Pega Government Platform offers components that you
can use from App Studio for the following scenarios.

Manage multiple persons (flow)


Use to capture the details of multiple persons: person ID, role, salutation, first
name, last name, email, country, and address. This flow also validates the
information added. After submission, the person details are persisted to the
person table.

Capture multiple persons details (flow action)


Use to capture details of multiple persons: person ID, role, salutation, first name,
last name, email, country, and address.

Persist multiple persons (flow)


Use to persist new persons details to person table.

©2024 Pegasystems Inc


Pega Government Platform '24.1 428

Multiple persons RO (section)


Use to display the list of persons captured.

Implementing multiple entity intake

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.

Configuring and extending multiple entity intake in a single


screen
Applies to Theme Cosmos. Configure and extend the multiple entity intake feature in a
single screen.

1. Log in to Pega Government Platform as an administrator.


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 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 > Manage multiple
persons.
7. Click the Select button.
8. In the Parameters section, in the Label box, enter a title for the component, for
example, Dependent details.
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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 429

• 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.

Adding new fields to the intake screen

Update the BasicPersonDetails (PegaPS-Data-Entity-Person) report definition to add new


fields to the intake screen for each person that is captured.

1. Log in to Pega Government Platform as an administrator.


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 Add person.
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 > Manage person
with basic details.
7. Click Save and run.
8. Click the Edit form icon to configure the view.
9. Click the section to which you want to add a field.
10. Click the Add icon.
11. Expand Fields, and then click the Add to view icon.
12. Click Submit.

Updating relationship list values

Add new or update the existing values of the relationship list.

1. In the navigation panel of Dev Studio, click Data types.


2. Click Data types > Option map.
3. Click the Records tab.
4. Click the filter for the Field name / Group column.

©2024 Pegasystems Inc


Pega Government Platform '24.1 430

5. In the Search Text box, enter PersonPerson and then click Apply.

A list of all the possible values for the relationships appears.

6. Click a record to open it, and update it as required.


7. If you want to add a new record, click Add record.
8. Click Save.

Configuring and extending multiple entity intake in separate


screens
Applies to Theme Cosmos. Configure and extend the multiple entity intake feature in
separate screens.

The following are the supported components.

• Manage person with basic details


• Manage person with complete details

©2024 Pegasystems Inc


Pega Government Platform '24.1 431

1. Log in to Pega Government Platform as an administrator.


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 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 > Manage person
with basic details.
7. Click the Select button.
8. Click Save.

Capturing the details of another person

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 432

14. Click the Workflow tab and configure the process that you added.

©2024 Pegasystems Inc


Pega Government Platform '24.1 433

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 434

Label
Provide an instruction to the user, for example, Enter father details.

Extending multiple entity intake in separate screens

To add new fields to the screens, update BasicPersonInfo or PersonDetails (PegaPS-Data-


Entity-Person) based on the component used.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 435

Configuring case report in case designer

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.

1. Log in to Pega Government Platform as an administrator.

©2024 Pegasystems Inc


Pega Government Platform '24.1 436

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.

Configure case report

9. Click Save to save the changes.

©2024 Pegasystems Inc


Pega Government Platform '24.1 437

Adding new data to the generated report

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.

1. In the Dev Studio Explorer panel, click App.


2. Click the Classes tab, and in the Search box, enter PegaPS-Work.
3. Click Data Model > Data Transform > PreDocumentGeneration.

Note: If you are unable to view the PreDocumentGeneration data


transform, click Show all results.

4. Click the data transform to open it.


5. Click the Save as button to save the data transform to the required class.
6. In the Data Transform Record Configuration section, in the Label box, enter a
title.
7. In the Context section, select an application.
8. In the Apply to area, enter or select the required class.
9. In the Add to ruleset area, select a ruleset and the ruleset version.
10. In the Current work item section,enter or select a work item to associate.
11. Click the Create and open button.
12. Click the Add a row icon to add a new data transform to which you want to add
data.
13. In the newly added data transform, in the Target box, enter or select
the .DocumentationReportproperty.
14. In the Source box, append the required content in HTML format.
15. Click Save.

©2024 Pegasystems Inc


Pega Government Platform '24.1 438

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.

1. In the Dev Studio Explorer panel, click App.


2. Click the Classes tab, and in the Search box, enter PegaPS-Work.
3. Click User Interface > Section > Contents.
4. Click the Save as button.
5. In the Data Transform Record Configuration section, in the Label box, enter a
title.
6. In the Context section, select an application.
7. In the Apply to area, enter or select a class.
8. In the Add to ruleset area, select a ruleset and the ruleset version.
9. In the Current work item section,enter or select a work item to associate.
10. Click the Create and open button.
11. Click the Add icon, and then click Pickers > Checkbox.
12. Double-click the newly added check box.
13. In the Cell Properties dialog box, enter the required details and then click Submit.
14. Update the ShowItemsSelection (PegaPS-Work) When condition with the new
property created above.
15. Create a property in the PegaPS-Work class to hold the list of items for the user to
select.
16. Update the PreSelectItems (PegaPS-Work) data transform to set the details to list
property.
17. Update the SelectItems (PegaPS-Work) section to show the list of details for the user
to select.
18. Follow the steps mentioned in the Adding new data to the generated report
section, to include the selected items in the generated report.

©2024 Pegasystems Inc


Pega Government Platform '24.1 439

Using a Microsoft Word template

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.

1. Click Create > SysAdmin > WordTemplate.


2. In the Word Template Record Configuration section, in the Label box, enter a title.
3. In the Context section, select an application.
4. In the Apply to area, enter or select a class.
5. In the Add to ruleset area, select a ruleset and the ruleset version.
6. In the Current work item section,enter or select a work item to associate.
7. Click the Create and open button.
8. In the Template section, click Upload file to upload the required Word template,
and then click Save.
9. In the Dev Studio Explorer panel, click App.
10. Click the Classes tab, and in the Search box, enter PegaPS-Work.
11. Click Process > Flow Action > Preview.
12. Click Save as to save the flow action into the case where you need a new template.
13. In the Flow Action Record Configuration section, in the Label box, enter a title.
14. In the Context section, select an application.
15. In the Apply to area, enter or select a class.
16. In the Add to ruleset area, select a ruleset and the ruleset version.
17. In the Current work item section,enter or select a work item to associate.
18. Click the Create and open button.
19. Click the Action tab.
20. In the Apply data transform box, enter or select PostPreview.
21. In the Post-processing section, in the Parameters area, enter the new template
name and the class.
22. Click Save.

©2024 Pegasystems Inc


Pega Government Platform '24.1 440

Changing the PDF file styling

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>"

1. Save the PostPreview (CL:PegaPS-Work) data transform to the implementation layer.


2. Update the new styling for the PDF document in step 4.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 441

The program configurator enables you to do the following:

• Provide seamless, and simple licensing and certification processes for


constituents, businesses, facilities, and vehicles.
• Reduce processing steps and minimize touch points to provide straight-through
processing.
• Provide a modern government platform to meet future requirements and enable
policy changes by business users.
• Reduce project implementation time and accelerate project delivery.
• Improve communication and interaction with constituents and businesses
through omni-channel interactions.

Editing or adding a new program

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.

1. Log in to Pega Government Platform as an administrator.


2. In the header of your studio, click the Switch Studio menu, and then click .
3. In the navigation pane of App Studio, click PGP, and in the quick launch menu,
click Program configuration.
4. In the Category list, select Program or License.
5. Click any program or license to edit it, or click the New configuration button to
create a new program or license.
6. Enter the details about the program and upload the image if required.
7. Click Save.

©2024 Pegasystems Inc


Pega Government Platform '24.1 442

Extending program configuration by adding new field

1. Create a new property in the PegaPS-Data-Config-Program class.


2. Update the ProgramConfigurationDetails (CL:PegaPS-Data-Config-Program) section
and include the newly created property.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 443

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:

• Define new program

• Edit program

• Copy program

©2024 Pegasystems Inc


Pega Government Platform '24.1 444

• Searching for a program

Program definition case life cycle

Define new 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

• Unique identifier of the program

• Enter program details such as

◦ Entity applicable

©2024 Pegasystems Inc


Pega Government Platform '24.1 445

◦ 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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 446

Program definition actions

You can perform the following actions on an active program screen:

• 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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 447

• 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

Program definition case is accessible only to supervisors/managers. Case workers


cannot define or manage programs. Supervisors and managers have capabilities to
define, update, and manage the programs and license configurations. Case workers
cannot define or manage programs. This is achieved using RBAC feature.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 448

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

Adding a new program configuration and creating a new program case

Implementation layer classes:

• PGPGov-PGPCosmo-Data-Config-Program
• PGPGov-PGPCosmo-Data-Config-Program-Grants

©2024 Pegasystems Inc


Pega Government Platform '24.1 449

• PGPGov-PGPCosmo-Data-Program
• PGPGov-PGPCosmo-Data-Program-Grants
• PGPGov-PGPCosmo-Work-Program
• PGPGov-PGPCosmo-Work-Program-Grants

1. In the header of , click Data types.


2. Click Options > Add data type.
3. In the Label box, enter a name, for example, Grants.
4. Expand the Advanced section and in the Parent class box, enter or select the
PegaPS-Data-Config-Program class, and then click Submit.

5. On the Records tab, click the Configure source button.


6. Select the Use as key check box for the pyID identifier.
7. Delete EntityID and EntityType columns.
8. In the Database box, enter or select PegaDATA.
9. Click Submit, and then click Close.

©2024 Pegasystems Inc


Pega Government Platform '24.1 450

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.

15. Click Save to save the Grants data type.


16. In the header of Dev Studio, click Data types, and then click Option map.
17. On the Records tab, filter the Field name / Group column by typing
ProgramCategory in the Search Text box.
18. Add the new program.

©2024 Pegasystems Inc


Pega Government Platform '24.1 451

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.

20. Click Save to save the Option map data type.


21. Open the D_PGPOptionMapList and D_OptionMapList data pages and on the Load
Management tab, click on Clear data page.
22. If you have deleted any required fields in step 12, delete the property in the
ValidateMandatoryDetails validation rule.
23. In the header of , click Create > SysAdmin > Class.
24. Enter the details in the Class Record Configuration and the Context sections, and
then click Create and open.

©2024 Pegasystems Inc


Pega Government Platform '24.1 452

25. In the Created in version box, enter or select the ruleset version, on the History
tab enter a description and then click Save.

©2024 Pegasystems Inc


Pega Government Platform '24.1 453

26. Open the Implementation Program work class and click Save as.
27. Enter the details and click Save.

©2024 Pegasystems Inc


Pega Government Platform '24.1 454

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 455

Operator Case Involvement (Touch) reporting


Applies to Theme Cosmos. Review reports and analyze the day-to-day work of
operators in the investigative case management applications. Touch reports provide
insights about the work of an operator, on investigation cases, for a given time period.

• 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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 456

©2024 Pegasystems Inc


Pega Government Platform '24.1 457

Changing filter conditions

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 458

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 459

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.

Adding new column to reports

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.

1. Save the InvestigationTouchReportForOperator (CL: History-PegaPS-Work) report


definition into the implementation ruleset.
2. Click Add column and enter the property that you want to display as a column
and save.
3. Save the InvestigationTouchReportForTeam (CL: History-PegaPS-Work) report
definition into the implementation ruleset.
4. Click Add column and enter the property that you want to display as a column
and save.

©2024 Pegasystems Inc


Pega Government Platform '24.1 460

Creating similar reports for other case

As a manager or a team member, create similar reports for different case types.

1. Log in with an operator which points to the ICM implementation app.


2. In the user portal, in left navigation pane, click on Reports.
3. Click the All Reports tab, and search for the touch point of the operator for
investigation and click that.
4. In the header, click Actions and then click Save as.
5. Enter the Title, Description and Category, and click on Submit.
6. Click the Object Class of this instance filter and provide the class value of the new
case type for which similar report is required.
7. Click the Apply Changes button.
8. In the header, click the Done editing button. A new report for the new case gets
created.
Similarly we can follow same steps for Touch points of team for investigation.

©2024 Pegasystems Inc


Pega Government Platform '24.1 461

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.

Data tables used in Time Management application are as follows:

• 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

©2024 Pegasystems Inc


Pega Government Platform '24.1 462

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

Follow these steps, to enable 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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 463

Records

Extensions

Applies to Theme Cosmos. The following are the extensions for Time management
feature.

Adding new fields to project tables

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 464

Project table data object

3. On the Data model tab, check all the existing fields.


4. Click Add field.
5. Click Save.

©2024 Pegasystems Inc


Pega Government Platform '24.1 465

Data model

Adding new fields to Time code data objects

Add a new field to a Time code data object to xxx

1. In the navigation pane of App Studio, click Explore Data.


2. In the Data objects and integrations window, click the Time code data object.

The Time code data object

3. On the Data model tab, review the existing fields.


4. Optional: To add a new field, click Add field.

©2024 Pegasystems Inc


Pega Government Platform '24.1 466

The Data model tab of the Time code window

Adding new fields to the time entry view

Add a new field to the time entry view xxx.:

1. In the navigation pane of App Studio, click Explore Data.


2. In the Case types window, click Time entry.

Time entry case type

3. On the Data model tab, review the existing fields.


4. Optional: To add a new field, at the end of the list click Add field.

©2024 Pegasystems Inc


Pega Government Platform '24.1 467

Time entry - Data model tab

5. Click Views > Time entry.

Time entry - the Views tab

6. Search for and add the new field to the view.

Adding new fields to time entry log data objects

Add a new field to time entry log data objects to xxx.

1. In the navigation pane of App Studio, click Explore Data.

©2024 Pegasystems Inc


Pega Government Platform '24.1 468

2. In the Data objects and integrations window, click the Time entry log data
object.

The Time entry log data object

3. On the Data model tab, review the existing fields.


4. Optional: To add a new field, click Add field.

Time entry log - Data model tab

5. Switch to Dev Studio.


6. In Dev Studio, save the TimeEntry_TimeEntryLogs (CL:PS-TimeMgmt-Work-
TimeEntry) section and add the newly added field as a column to the table layouts.

©2024 Pegasystems Inc


Pega Government Platform '24.1 469

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

Adding time entry to a case

Open case type in app studio, Optional actions > add a new process to a stage > add
step > More > Processes > Time Entry

Adding a time tab (view time in case)

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.

Time entry flow

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 470

time entry flow

View time in case

This feature allows user to view the summary chart and reports on time entry logs for a
particular case.

Time entry in Investigation

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 471

Manager view - Manage time

Time management also provides restricted access to time entries, which is enforced by
attribute based access control (ABAC) rules:

1. Users access their own entries.


2. Managers access entries for themselves and from case workers in their work
group.
3. Administrators view all entries.

Configurations
Applies to Theme Cosmos. The following are the configurations for Time mangement
feature.

Adding, deleting, or updating records in a project table

Add, delete, or update records in project table:

1. In the navigation pane of App Studio, click Data > Data objects and integrations.
2. In the list of data objects, click Project table.

©2024 Pegasystems Inc


Pega Government Platform '24.1 472

Project table data object

3. Click the Records tab.

©2024 Pegasystems Inc


Pega Government Platform '24.1 473

Records tab in of the project table

4. Click on any row to update the project record.


5. Click the Delete icon to delete the project record.
6. Click Add record to add a new project.

Adding, deleting, or updating records in Time code data objects

Add, delete, or update records in Time code data objects to xxx.

1. In the navigation pane of App Studio, click Explore Data.

Time code data object

2. In the Data objects and integrations window, click the Records tab to view the
time codes that are available in the system.

©2024 Pegasystems Inc


Pega Government Platform '24.1 474

Time code records

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.

Enable or disable timesheet deadline validation

Configure timesheet deadline validation to enable or disable on runtime. Enabling


deadline validation will validate the timesheet due. Disabling deadline validation in
configuration will skip the timesheet due validation in runtime.

To enable/disable the timesheet deadline validation at runtime, follow these steps:

1. In the navigation pane of App Studio, click Settings > Configurations.


2. Click the Settings icon at the end of the deadline validation row.
3. Select constant value as True to enable deadline validation and click Submit.
4. Select constant value as False to disable deadline validation and click Submit.

©2024 Pegasystems Inc


Pega Government Platform '24.1 475

Deadline vaildation

Configure setting

Changing the due time of a time sheet

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.

1. In the navigation pane of App Studio, click Settings > Configurations.


2. Click the Settings icon at the end of the Time sheet due row.
3. Select Specific time from the list and then click Submit.

©2024 Pegasystems Inc


Pega Government Platform '24.1 476

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

Pega Government Platform Implementation


guide for Constellation
Applies to Constellation.The Pega Government Platform (PGP) provides a rich set of
features designed to enhance customer experience, improve user productivity, and
increase customer satisfaction. The solution provides reusable components or
processes used to build an application or case by using Pega App Studio or Pega Dev
Studio.

Pega Government Platform provides a public sector-oriented foundation with


processes, data structures, and components that you can reuse to modernize existing
government systems and accelerate implementations. The application augments
Pega Platform with public sector-specific capabilities, including a government data
model, UI templates, dashboards, reports, workflows, and case types. It accelerates
solution delivery, leveraging assets, features, and components built specifically for the
public sector and assembled using the Pega Platform tools.

The Pega Government Platform product has comprehensive case management


capabilities, which, along with the master data structures, allows you to specialize
quickly where needed.

To summarize, Pega Government Platform is:

©2024 Pegasystems Inc


Pega Government Platform '24.1 477

• A low code platform that caters to the citizen developer through easy to re-use
components (UI, flow, user actions, and case types).

• Functional as an accelerator (uses easy to configure, extensible components to


deliver better results faster).

• Not a turn-key solution

PGP Constellation architecture

• Preparing for implementation

• Prerequisites

• Configuring access groups

• Creating a new application

• Connecting system of record

• Entities

• Implementing case types

©2024 Pegasystems Inc


Pega Government Platform '24.1 478

• Managing reference data

• Appendix: Integrating Pega Government Platform (PGP) with Pega Customer


Service for Constellation

Preparing for implementation


Applies to Constellation. A project team that implements a Pega application can use
this implementation guide to enable and extend application features to meet client
business requirements. You must complete the product installation before starting the
implementation procedures.

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:

1. Consult with your database administrator to determine whether the installation or


update process can make automatic changes to the database schema.
Alternatively, the database administrator may need to manually apply the DDL
files that include schema changes. For more information see, Install guide.
2. Install to the latest version of Pega Platform 24.1, and ensure that you can log in
as an administrator. For more information, see the Pega Platform Install or Update
Guide for your environment on the Deploy Pega Platform page.
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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 479

Configuring access groups


Applies to Constellation. Pega Government Platform includes preconfigured access
groups for typical application personas, such as Case worker, Manager, and
Administrator. An access group identifies one or more access roles that apply to users
assigned to that access group. After you create your implementation application, you
can define your operator records, and then assign the operators to the appropriate
access groups.

The following are the access groups for the Pega Government Platform (PGP):

Access Group Persona Description

PegaGovt:Authors PGP application Provides access to App


administrator studio and Dev studio

PegaGovt:CaseWorker Case worker Provides access to case


worker portal with access to
create incidents and entities

PegaGovt:Manager Manager Provides access to case


worker portal with access to
review the incidents and
entities created

The following are the access groups for the Investigative Case Management (ICM)
application:

Access group Persona Description

PegaGovtICM:Authors ICM Application Provides access to App


administrator studio and Dev studio

PegaGovtICM:ICMAgent Investigation agent Provides access to case


worker portal with access to
conduct the investigation

©2024 Pegasystems Inc


Pega Government Platform '24.1 480

Access group Persona Description

with role as owner or


officer.

PegaGovtICM:ICMIntakeSpe Intake specialist Provides the access to


cialist create the incidents.

PegaGovtICM:ICMSuperviso Investigation supervisor Provides access to case


r worker portal with access to
review the incidents, entities
and create or launch a new
investigation.

Creating a new application


Applies to Constellation. Run the New Application wizard to create your application.

1. Create a new operator ID to run the New Application wizard.


a. Log in to Dev Studio by using the operator ID [email protected] and
the password that you specified for that operator.
b. Save a copy of the existing [email protected] operator and give it a
name that identifies it as an Application Setup operator.
c. Add the PegaGovt:Authors ands PegaGovtICM:Authors access group to
the new operator record, and then click the radio button to the left of the
PegaGovt: Authors access group to select it as the default access group.
d. Save the new Application Setup operator.
2. Log in as the Application Setup operator.
3. In the header of Dev Studio, click the name of the application, and then click New
Application.
4. Select built-on application from the list of applications (Constellation) displayed
such as Pega Government Platform and Investigative Case Management. Choose
the right option by going through the description of the application list and select
the one which has constellation as part of the description.

©2024 Pegasystems Inc


Pega Government Platform '24.1 481

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.

The Application Wizard creates the implementation application. The application


includes one system administrator operator so that you can log into the
application after you complete the wizard.

10. To open the new application, click Go to app.

• Configuring the new application

©2024 Pegasystems Inc


Pega Government Platform '24.1 482

Configuring the new application


Applies to Constellation. Before setting up the new implementation layer, identify an
Application tag to use for the new application. Assume the tag is PGPImpl for now.

1. Creating a toggle for the new application.


a. Navigate to Configure > System > Release > Toggles and click Create new
toggle.
b. Select the Application context as the newly created application.
c. Enter the Toggle identifier as CDM_<AppTag>, where the AppTag is PGPImpl,
as identified.
d. Select Enable toggle for all.
2. Override the DetermineExtension_Ext decision table in the implementation layer
and add the application tag (created above) in the following format “_<AppTag>”.
3. Similarly, override the DetermineApplicationTag_Ext decision table in the
implementation layer and add application tag (created above).
4. Updating the dynamic class referencing: Updating the Dynamic Class Reference
(DCR) values with implementation layer work classes.
a. If the application is built on Pega Government Platform (PGP) directly, then
save the ClassSettings_PGP data transform with a new name as
ClassSettings_<AppTag> and update the values of all work classes with
the implementation layer class values.
b. If the application is built on top of Investigative Case Management (ICM),
save the ClassSettings_ICM data transform with a new name as
ClassSettings_<AppTag> and update the values of all work classes with
the implementation layer class values.
5. Updating the General settings with the implementation layer specific
values:
a. Create a new data transform with the name GeneralSettings_<AppTag> in the
Common-Admin-ApplicationSetting class.
b. Now refer to the General settings Data Transforms of PGP and ICM
applications GeneralSettings_PGP, GeneralSettings_ICM and override the

©2024 Pegasystems Inc


Pega Government Platform '24.1 483

individual property values in the implementation layer data transform


GeneralSettings_<AppTag>.
Example: Override the ICMAgentAccessGroup property value defined in
GeneralSettings_ICM with the implementation layer-specific value, for
example, "ICMImpl:IcmAgent" in the GeneralSettings_<AppTag> data
transform.
6. Creating the OAuth 2.0 Client registration
a. Navigate to Records > Security > OAuth 2.0 Client RegistrationCreate a
record with the name as CDM_OAuth_<AppTag>.
b. In Supported grant types section, update the Set Operator context to
Access group and select the Implementation Authors access group.
c. Click Regenerate client secret, then click View and Download.
d. Provide or associate a ruleset to this rule and then click Save .
7. Creating authentication profile
a. Navigate to Records > Security > Authentication Profile Create a profile with
the name as CDM_OAuth_<AppTag> with Type as OAuth 2.0.
b. Fill the Client Identifier and Secret with the downloaded details from the
previous client registration setup.
c. Enable Use refresh token if available checkbox.
8. Save the SetCDMAuthenticationProfile data transform and update the value of
the AuthenticationProfile property with the name of the Authentication profile
created.
9. Updating lookup data pages: Save as lookup data pages of the case types to
implementation layer by updating the Object type value to the corresponding
implementation layer class.
a. If the application is directly built on Pega Government Platform, override the
below list of data pages.
• D_Subject
• D_Incident
• D_Interview
• D_Evidence
• D_Business

©2024 Pegasystems Inc


Pega Government Platform '24.1 484

• 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:

©2024 Pegasystems Inc


Pega Government Platform '24.1 485

Configuration sets

Connecting system of record


Applies to Constellation. Pega Government Platform provides a robust foundation to
use Data Pages. Data Pages are helpful in retrieving data stored in any external system
that is required for case processing.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 486

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

• Creating new entities

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

Investigation officer Associate victim, suspect, or eyewitness to a


hit and run case

Department of transportation customer Capture person details as part of driving


service staff license application

©2024 Pegasystems Inc


Pega Government Platform '24.1 487

Persona Action

Taxpayer Create your own profile on the department


of tax site and use the details to file tax
returns every year

Farmer Create a profile in the department of


agriculture to apply for grants

Military Capture department of defense employee


details for deployments

Reusable features

Person entity provides the following reusable features.

Case type(s) Person


Supports standalone Adding
and Updating of person
entity information.

Usage: Used to update the


profile from WSS portal by
end user

View(s) 360-person Complete details of a


person entity

Search and select Search and select of a


person entity

People landing page Landing page to support


searching the person
entities

Basic person information


Collect info or search and
select

©2024 Pegasystems Inc


Pega Government Platform '24.1 488

Usage: Reusable view to


collect the basic info of
citizen or person.

Flow Basic person information


Collect info or search and
select, duplicate check,
validate, and persist.

Usage: Used to collect the


citizen info from user
registration where
persistence happens right
after the collection of info.

Flow action(s) Basic person information


Collect info or search and
select, duplicate check, and
validate.

Usage: Used to collect the


citizen info for a License or a
Grant application where the
collected details are in the
case type without
persistence to SOR till
application is approved.

For more functional details visit Product overview - Person

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 489

PGP Class CDM class

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.

Person case type

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 490

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 to initialize object

• PrepareObject to prepare object for data persistency

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:

• Create Secondary Email page property in Common-LDM-Entity-Contact class


in respective Ruleset version.

• 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

©2024 Pegasystems Inc


Pega Government Platform '24.1 491

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

Extending case type

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 492

Extensions Example References

Adding a scalar field Height or Weight https://docs.pega.com/


bundle/common-data-
model/page/common-data-
model/implementation/
create-property.html

Extending reference data Gender, Country list or state https://docs.pega.com/


(pick list value) list bundle/common-data-
model-88/page/common-
data-model/
implementation/reference-
data-overview.html

Creating Embedded page Secondary email https://docs.pega.com/


bundle/common-data-
model/page/common-data-
model/implementation/
adding-embedded-
object.html

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 493

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

No explicit configurations required

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),

©2024 Pegasystems Inc


Pega Government Platform '24.1 494

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

No explicit configurations required.

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.

Contact full page view

©2024 Pegasystems Inc


Pega Government Platform '24.1 495

Consider the example of adding a new field ‘Height’ under ‘personal information’ in the
above screen shot.

1. Click Details tab and navigate to the respective view.


2. Click Details > Display personal information > Display person details > Person
general information and add the new field in personal general information view.

Contact data type

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 496

Configuraton instructions

No explicit configurations required.

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:

Extensions CDM documentation

Extending search criteria <<Link-FDBK to CDM>>

Extending search results

To add a new field to SearchPerson results, follow these steps:

1. Search for SearchPerson view in PegaGp-Work class.


2. Click Person.

Search person view

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 497

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."

©2024 Pegasystems Inc


Pega Government Platform '24.1 498

Add column in Search person

People landing page

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

No explicit configruations required.

©2024 Pegasystems Inc


Pega Government Platform '24.1 499

Extensions

Extending landing page

Entities landing page is defined under web portal (Channel interfaces). You will find
people tab inside this landing page.

Entities landing page

To add a new field to People landing page, click People > All contact view > Add and
select the required field.

©2024 Pegasystems Inc


Pega Government Platform '24.1 500

Adding new column

People landing page view

Basic person information - view

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

View - Basic person information (Common-LDM-Entity-Contact) offers UI to capture


person details.

©2024 Pegasystems Inc


Pega Government Platform '24.1 501

Configuration instructions

No explicit configurations required.

Extensions

To add a new field to this view, for example, spouse name, click Add button and
proceed with next steps.

Basic person info view

Basic person information - flow and flow action

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.

Basic person can be used as a flow or flow action.

• Flow – The person details are persisted in the database and can be used in other
use cases.

©2024 Pegasystems Inc


Pega Government Platform '24.1 502

• 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

Person entity offers OOTB flow, flow action and view.

• Flow - BasicPersonInformation(PegaGP-Work) offers to capture and


persist person details in the database. Save entity is a reusable flow that is used
to persist person information. Refer to Save entity for further details.
• Flow action - BasicPersonInfo (PegaGP-Work) flow action component only
captures person 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.

Let us consider an example of a person applying for driver’s license.

Scenario 1: A case worker at government department searches for a person’s record


who wants to apply for a license. If the record is not found in the system, the case
worker creates a new record and saves the data into the system, then continues to
proceed further with the process of applying for license. This scenario is an example of
basic person flow component.

Scenario 2: A case worker at government department searches for a person’s record


who wants to apply for a license. If the record is not found in the system, the case
worker captures only the basic details but does not save them in the system (If the
person is not willing to save their details) and proceeds further with the process of
applying for a license. The person’s details are available in case type and can be saved
to the system at any point in time. This scenario is an example of basic person flow
action component.

©2024 Pegasystems Inc


Pega Government Platform '24.1 503

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

No explicit custom extensions. Follow Pega extension guidelines.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 504

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.

The following are the examples for Business entity:

Persona Action

Investigation officer Associate a pharmaceutical company to a


financial fraud case .

Small business owner Applying online for a restaurant’s liquor


license.

Procurement head View all vendor businesses eligible for office


supplies. Update the Better Business Bureau
about the new branch opened in
Massachusetts.

Reusable features

You can extend the following features in your application.

Case type Business case Supports standalone adding


and updating of business
entity information

Usage: Used to update the


profile from WSS portal.

View 360-business view

Search businesses Search and select of


business entity

©2024 Pegasystems Inc


Pega Government Platform '24.1 505

Businesses landing page Landing page to support


searching the person
entities

Basic business information Collect info or search and


select Usage: Reusable view
to collect the basic info of
citizen or person

Flow Basic business information


Collect info or search and
select, duplicate
check,validate, and persist.

Usage: Used to collect the


organization info from user
registration where
persistence happens right
after the collection of info.

Flow action Basic business information


Collect info or search and
select, duplicate check, and
validate

Usage: Used to collect the


business info for a license
or permission where the
collected details are in the
case type without
persistence to System Of
Record (SOR) until
application is approved.

For more functional details visit Product overview - Business

©2024 Pegasystems Inc


Pega Government Platform '24.1 506

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.

PGP Class CDM class

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.

Business case type

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.

• SetDefaults to initialize object


• PrepareObject to prepare object for data persistency

©2024 Pegasystems Inc


Pega Government Platform '24.1 507

Set Defaults Data Transform

Set Defaults data transform of Common-LDM-Entity-Account-Business class is


used to initialize business entity with default values.

Setdefaults data transform

PrepareObject Data Transform

Thisdata transform, of Common-LDM-Entity-Account-Business class, is used to


prepare the object by updating the data as needed for data persistency. For example,
To capture properties that are not present on UI but must be persisted, such
transformations can be defined using this data transform.

©2024 Pegasystems Inc


Pega Government Platform '24.1 508

prepareobject data transform

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.

Consider a scenario of introducing a new embedded page, for example secondary


email to person case type. Here are the detailed steps to be followed to add a new
embedded page to email page list.

• Create Secondary email page property in Common-LDM-Entity-Account-


Business class in respective ruleset version.
• In SetDefaults data transform, set Is Primary property to false, since this is
secondary email. Set Type to personal or work as appropriate.
• In PrepareObject data transform, append the newly created Secondary Email
page property to email list. Use when conditions to check the existence of values.
Refer to Primary Email step in PrepareObject data transform.

©2024 Pegasystems Inc


Pega Government Platform '24.1 509

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.

Note: Capture contact person checkbox is applicable only while creating a


new business.

©2024 Pegasystems Inc


Pega Government Platform '24.1 510

Capture contact person

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.

Extensions Example References

Adding a scalar field Organization incorporated


https://docs.pega.com/
date
bundle/common-data-
model/page/common-data-
model/implementation/
create-property.html

©2024 Pegasystems Inc


Pega Government Platform '24.1 511

Extensions Example References

Extending reference data Ownership type, Country list


https://docs.pega.com/
(pick list value) or state list
bundle/common-data-
model-88/page/common-
data-model/
implementation/reference-
data-overview.html

Creating Embedded page Secondary email https://docs.pega.com/


bundle/common-data-
model/page/common-data-
model/implementation/
adding-embedded-
object.html

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 512

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

No explicit configurations required.

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

No explicit configurations required

©2024 Pegasystems Inc


Pega Government Platform '24.1 513

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.

Let us consider an example of adding a new field "organization incorporated date"


under business information in the above screen shot.

• 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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 514

Basic business info

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

No explicit configurations required

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:

Extensions CDM documentation

Extending search criteria <<Link-FDBK to CDM>>

©2024 Pegasystems Inc


Pega Government Platform '24.1 515

To add a new field to SearchBusinesses results, follow these steps:

1. Navigate to PegaGP-Work class and search for SearchBusinesses view.


2. Click Business.
3. Under Input settings, Check the “enable search” checkbox to get list of fields
used in search criteria. Click Add to include new field to search criteria.
4. All the fields shown in search results are listed under columns. If you want to add
new field to search results, click Add.

Business landing page

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

No explicit configurations required

Extensions

Extending landing page

Entities landing page is defined under web portal (Channel interfaces). You will find the
businesses tab inside this landing page.

©2024 Pegasystems Inc


Pega Government Platform '24.1 516

Entities landing view

To add a new field to Businesses landing page, click Businesses > All accounts view ,
click Add option and select required field.

Business landing page view

©2024 Pegasystems Inc


Pega Government Platform '24.1 517

Business landing page view

Basic business info - view

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

View - Basic business information (Common-LDM-Entity-Account-Business) offers UI


to capture business details.

©2024 Pegasystems Inc


Pega Government Platform '24.1 518

Configuration instructions

No explicit configurations required.

Extensions

To add a new field to this view, (for example, Organization incorporated date), click +
Add and select the required field.

Basic business info - flow and flow action

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

Business entity offers OOTB flow, flow action and view.

• Flow – BasicBusinessInformation(PegaGP-Work) offers to capture, validate,


check for duplicate records and persist business details to database using Save
entity.
• Flow action – BasicBusinessInfo (PegaGP-Work) flow action is used to capture
business details. Validate information also checks for duplicate records. This flow
action only captures business details and doesn’t persist data. This is typically
used in scenarios where business details are captured in multiple steps (not at
once). After capturing all the details, call save entity explicitly (which is a reusable
flow) to persist the data. Refer to Save entity for further details.

Configuration instructions

To capture basic business details, use OOTB flow and flow action.

©2024 Pegasystems Inc


Pega Government Platform '24.1 519

Let us consider examples of a drone business organization applying for exemption to


fly a drone

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.

Note: Capture contact person checkbox is applicable only while creating a


new business.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 520

• Work queue: Select work queue or work basket, and the available user picks the
case.

Extensions

No explicit custom extensions. Follow Pega extension guidelines.

Creating new entities


Applies to Constellation. Pega Government Platform (PGP) entities are a collection of
robust data structures that model data elements commonly used in government
processes. The PGP entities are persistent data classes that come pre-configured as a
part of PGP.

For detailed information on creating a new entity, refer Adding a new entity.

Implementing case types


Applies to Constellation. This section describes standard cases available with Pega
Government Platform along with how these end-to-end case types can be used,
extended, and customized for various business needs.

• Incident

• Subject

• Interview

• Evidence

• Investigative Case Management

• Associations

©2024 Pegasystems Inc


Pega Government Platform '24.1 521

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.

Incident case type provides the following capabilities:

• 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

Teacher Report an incident to the school safety office


about a suspicious bag found in the bus loop
of the school.

Employee Create an incident to report discrimination


complaint against a colleague at office.

Traffic inspector Create an incident to report traffic signal not


working

©2024 Pegasystems Inc


Pega Government Platform '24.1 522

Persona Action

Citizen Report an incident to prevent accidents


caused by potholes and to take certain
action.

Reusable features

You can extend the following features in your application.

Case type
• Incident case type

View
• 360-incident view

• Incident landing page

Incident case type

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.

PGP class Data class ICM class

PegaGP-Work-Incident Common-LDM-Data- PegaGP-Work-ICM-


Incident Incident

©2024 Pegasystems Inc


Pega Government Platform '24.1 523

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

Assigning incident to work queue for review

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 524

You can change the case match rule from App Studio, by modifying the these
conditions based on your need as shown below.

Incident review screen in ICM

• 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.

Adding a new property to incident details screen

For adding a field to incident details capture screen, complete the following steps.

1. Create a property in the Common-LDM-Data-Incident class.


2. Add the new property to the Incident information
Common-LDM-Data-Incident view.

Adding a field to existing review actions in incident review screen

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 525

• Need additional information


• Issue a warning
• No Action needed
◦ Invalid incident
◦ Duplicate incident

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.

Incident landing page

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

No explicit configurations required

©2024 Pegasystems Inc


Pega Government Platform '24.1 526

Extensions

Adding a field to search incident landing page results

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

Investigation officer Capture person, business as subjects for the case

Citizen Raise a concern for noise in neighborhood and associate


neighbor for playing loud music at midnight

Reusable features

PGP Subject case type provides the following reusable features.

©2024 Pegasystems Inc


Pega Government Platform '24.1 527

Case type
• Subject case type

View
• 360-subject
• Subject landing page
• Related subjects list

Flow
• Create subject

Subject case type

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

PGP Class PegaGP-Work-Subject

ICM Class PegaGP-Work-ICM-Subject

Data classes

Subject-data class Common-LDM-Data-Subject

Subject-person data class Common-LDM-Data-Subject-Person

Subject-business data class Common-LDM-Data-Subject-Business

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 528

Persist information (flow) – Save subject entity information by calling the save entity
activity and passing parameters based on the entity type.

Configuration instructions

Capture contact person - To capture contact person, follow these steps:

1. In Dev Studio, click Create Subject case type.


2. On the right pane under General tab, select the CaptureBusinessContactPerson
checkbox to capture contact person details for a business.

Note: If this option is not selected, contact person details are not
captured when creating a new business.

Note: Capture contact person checkbox is applicable only when creating


a new business.

capture business contact person

©2024 Pegasystems Inc


Pega Government Platform '24.1 529

Extension

Extending new entity in subject case type

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:

1. Create item data class, for example, Common-LDM-Data-Subject-Item


2. Add Item in subject type reference data and the view.
3. Change the class dynamically as mentioned in the technical details.
4. Create respective views in the Item entity class. For example,
basicitemdetails to capture the item entity details and more.
5. Save the new item entity details in persist information, as mentioned in the
technical details.

Subject landing page

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

No explicit configurations required.

Extensions

Extending subject landing page

©2024 Pegasystems Inc


Pega Government Platform '24.1 530

The subject landing page is defined under the web portal (channel interfaces). You will
find the Subject tab inside this landing page.

Subject view 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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 531

Subject list view

©2024 Pegasystems Inc


Pega Government Platform '24.1 532

Subject list view

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 533

Reusable subjects list

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

The following are the class details of create subject component:

• Create subject process ( PegaGP-work) class


• Subjects list details view ( work- ) class

Create subject

©2024 Pegasystems Inc


Pega Government Platform '24.1 534

Configuration instructions

To get list of associated subjects in the subject tab of a case, create Subject tab and
invoke subject list details view.

Adding subject list details

©2024 Pegasystems Inc


Pega Government Platform '24.1 535

Subject list view

Extensions

No explicit custom extensions. Follow Pega extension guidelines.

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.

The following are the business examples of an interview case.

Persona Action

Investigation case supervisor Interview the suspect of a hit and run case

Recruitment manager Setup interviews for candidates for an open


position

©2024 Pegasystems Inc


Pega Government Platform '24.1 536

Reusable features

PGP interview case provides the following reusable features.

Case type
• Interview case type

View
• 360-interview view

• Interview list view

Flow
• Create interview

For more functional details, refer to Product overview.

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.

PGP Class CDM data class

PegaGP-Work-Interview Common-LDM-Data-Interview

©2024 Pegasystems Inc


Pega Government Platform '24.1 537

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:

• ALL - List of operators in system


• Invoking case participants - List of invoking case stake holders
• Team - Members of initiator’s default team and reporters

configure settings

Extensions

No explicit custom extensions required. Follow Pega extension guidelines.

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 538

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

The following are the class details of create interview component:

• Create interview process ( PegaGP-work) class.


• Interviews list details view ( work- ) class

Configuration instructions

To get list of associated interviews in the interview tab of a case, create Interviews tab
and invoke Interview list details view.

©2024 Pegasystems Inc


Pega Government Platform '24.1 539

Create interview

©2024 Pegasystems Inc


Pega Government Platform '24.1 540

Interview tab

intervw list details

Extensions

No explicit custom extensions required. Follow Pega extension guidelines.

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 541

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.

Interview template component enables users to create pre-defined set of open-ended


questions and answer format - short text, long text, and rich text, for an interview.
Interviewer can ask these questions during the interview and capture responses.

The following are the business examples for templates feature.

Persona Action

Investigation officer See all the list of questions to be asked in the


interview based on the template chosen.

Reusable features

PGP interview template provides the following reusable features.

Case type
• Create interview template

View
• 360-interview template view
• Template landing page

Create interview template

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 542

Configuration instructions

No explicit configurations required.

Extensions

Extending templates landing page

The Interview template landing page is defined under the web portal (Channel
interfaces). You will find the Templates tab inside this landing page.

Interview template landing page

To add a new column to the Templates landing page, click Interview and navigate to
the Interview template list view.

©2024 Pegasystems Inc


Pega Government Platform '24.1 543

Templates 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.

The following is the business example for evidence case type:

Persona Action

Investigation agent Create an evidence case to capture evidence


details and associate the evidence with the
investigation, enabling you to view the
details of all evidence related to the case at
any time.

Reusable features

©2024 Pegasystems Inc


Pega Government Platform '24.1 544

The evidence case type provides the following reusable features.

Case type
• Evidence case type

View
• 360-evidence view

Flow
• Create evidence

For more functional details, refer to Product overview - evidence case.

Evidence case type

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.

PGP Class CDM data class

PegaGP-Work-Evidence Common-LDM-Data-Evidence

Configuration instructions

No explicit configurations required

Extensions

No explicit custom extensions required. Follow Pega extension guidelines.

©2024 Pegasystems Inc


Pega Government Platform '24.1 545

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

• The Create evidence process is in the PegaGP-Work class.


• The evidence list details view is in the Work- class

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.

Create evidence tab

©2024 Pegasystems Inc


Pega Government Platform '24.1 546

evidence list details

Evidence list preview

Extensions

No explicit custom extensions required. Follow Pega extension guidelines.

Investigative Case Management


Applies to Constellation. Pega Government Platform (PGP) offers the Investigative case
management process to orchestrate all aspects of investigations right from initiating

©2024 Pegasystems Inc


Pega Government Platform '24.1 547

the investigation through subject management, conducting interviews, capturing


evidence, adding notes and more. Additionally provides automated audit trials, views of
relationships with entities, cases and all associations, to help navigate the investigation
to a closure.

The following list details some features of ICM:

• Create investigations either standalone or from an incident.


• Capture details for a case by using components such as interviews, evidence, and
subjects.
• Set user authorization and define how they search for and view cases

The following are the business examples for investigation case management:

Persona Action

FBI agent
To investigate an incident, work on the
following tasks:

• Associate items and people with the


case.
• Conduct witness interviews.
• Collaborate with other internal and
external officers.
• Conclude the investigation and submit
a report.

Fraud investigator Investigate a case of fraud involving Covid-19


relief funds for businesses, collaborate with
various agencies, and submit an
investigation report.

Child welfare state employee Investigate complaint of a child by looking at


relationships with biological parents and

©2024 Pegasystems Inc


Pega Government Platform '24.1 548

Persona Action

foster parents and review any earlier


complaints or investigations involving them.

Reusable features

ICM provides the following reusable features.

Case type
• Investigation case type

View
• 360-investigation view

• Investigation landing page

Investigation case type

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.

ICM Class CDM data class

PegaGP-Work-ICM-Investigation Common-LDM-Data-Investigation

Configuration instructions

No explicit configurations required.

©2024 Pegasystems Inc


Pega Government Platform '24.1 549

Extensions

No explicit custom extensions. Follow Pega extension guidelines.

Generative 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.

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:

1. In App Studio, navigate to Settings > Configurations.


2. Under Configuration set: PGP-Investigation, edit Case summary using GenAI.
3. Enable the default value to True to generate the Case summary using Gen AI.

Config setting to case summary using Gen AI

©2024 Pegasystems Inc


Pega Government Platform '24.1 550

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.

To enable Pega Gen AI, see Enabling GenAI in Pega Cloud.

Investigation landing page

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

No explicit configurations required

Extensions

Extending landing page

The Investigation landing page is located within the web portal (Channel interfaces).
You can find the Investigations tab on this landing page.

©2024 Pegasystems Inc


Pega Government Platform '24.1 551

Investigations landing page view

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.

Investigation landing page view

Extending investigation 360-view

©2024 Pegasystems Inc


Pega Government Platform '24.1 552

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.

Investigation summary view

Creating a new tab in 360-view

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 553

Investigation full page view

Including a new field in investigation case details 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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 554

Display investigation information

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 555

Child details display view

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 556

PrepareReportInfo data transform

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.

The following are the business examples for associations:

©2024 Pegasystems Inc


Pega Government Platform '24.1 557

Persona Action

Investigation officer Create or view associations of a hit and run


case victim with suspects, witness, and prior
accidents on those intersections.

Restaurant license approver manager Check the history of all owners and their
prior businesses and violations by owners
and their businesses, before approving.

Child welfare worker Verify child's biological and foster parents'


relationship and history of any cases against
them.

PGP provides the following reusable features in Associations.

Case type Manage associations

View Association list view

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):

PGP class Data class

PegaGP-Work-Manage-Association Common-LDM-Data-RelatedWork data


class is used to hold the case-to-case
association details for CRUD operations.

DB classes to store associations:

©2024 Pegasystems Inc


Pega Government Platform '24.1 558

The Pega platform uses the Link-Association-RelatedWork class to store case-


to-case associations Out-Of-The-Box (OOTB).

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.

Note: Currently, case-to-entity association is not implemented in the manage


association case, but it is implemented as part of the automatic associations.
Such as subject case to person or business association.

Reusable flows

You can use the SaveAssociation flow rule to initiate the persistence logic for any case
or entity associations conditionally.

For automatic associations: The CreateAssociation flow component is available in


the PegaGP-Work work pool class for reuse purposes. The flow requires all necessary
parameters (such as fromID, toID, fromLabel, and toLabel) to create an association
between cases and entities. You can use this flow component to create associations
from any case.

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 559

Configuration set for associations

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 560

Manage associations view

• 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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 561

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.

Associations list view

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:

D_AssociationCases_List of type Work- . It calls a CDM data page,


D_Relation_List , which provides a unified list of all existing associations between
the current case or entity and other cases and entities in the system.

Configuration instructions

No explicit configurations required.

Extensions

The CDM data page D_Relation_List has a post-load processing activity,


RelationList_Datapage_PostProcessing , which in turn calls an extension
activity, RelationList_Datapage_PostProcessing_Ext , for customizing the data
page results. Implementers can override this activity in their layer for any customization
to the association list.

©2024 Pegasystems Inc


Pega Government Platform '24.1 562

Managing reference data


Applies to Constellation. Manage reference data in cases and applications.

For more information on managing reference data, refer Adding a new picklist single-
value field.

Appendix: Integrating Pega Government Platform


(PGP) with Pega Customer Service for Constellation
Applies to Constellation. Pega Government Platform (PGP) customers can now
integrate PGP with Customer Service (CS) in a more efficient manner. PGP product
management provides the new integration approach and supporting ruleset to reduce
the PGP with CS project setup time. This integration enables the use of all PGP core
case types in CS, with full interaction driver support, and integrates Person View and
Business View. Additionally, CS contact search is integrated with PGP person entity, CS
business search is integrated with PGP business entity, and shared work pool enables
cases created in the CS layer to be processed in the PGP layer. PegaCall Demo-Pop
support is also available for common PGP Demo personas.

1. Create implementation layer on top of Customer service – Constellation. Follow


https://docs.pega.com/bundle/customer-service/page/customer-service/
constellation-implementation/get-started/new-application-standalone-
constellation.html.

©2024 Pegasystems Inc


Pega Government Platform '24.1 563

Implementation layer

2. Open Application Definition, add your PGP application at the top in newly
created CS implementation application.

Application definition

3. Update DetermineApplicationTag_Ext decision table rule.


a. Include your application tag that is added to the application stack.
b. Include built on applications tag.
For example, Including PGPImpl to the application stack. PGPImpl is built on
top of PegaGovt application. Refer below screenshot for reference.

©2024 Pegasystems Inc


Pega Government Platform '24.1 564

DetermineApplicationTag_Ext table rule

4. Update DetermineExtension_Ext Decision table rule.


a. Include your application tag which is added to the application stack.
b. Include built on applications tag.
For example, Including PGPImpl to the application stack. PGPImpl is built on
top of PegaGovt application. Refer below screenshot for reference.

©2024 Pegasystems Inc


Pega Government Platform '24.1 565

DetermineExtension_Ext table rule

5. From application definition, Switch to Cases and Data tab, add our PGP case
classes in the Case Types list.

Cases and Data tab

6. Create task categories to display our cases in interaction portal.


a. Open Interaction case type.
b. Click Settings > Create case categories.

©2024 Pegasystems Inc


Pega Government Platform '24.1 566

c. Under Case categories, click + Add task category.

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

©2024 Pegasystems Inc


Pega Government Platform '24.1 567

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.

©2024 Pegasystems Inc


Pega Government Platform '24.1 568

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.

• Hotfixes for Pega Government Platform 8.x

• Hotfixes for Pega Government Platform 7.x

Hotfixes for Pega Government Platform 8.x


Pega Government Platform 8.8

The following table lists the required Pega Government Platform 8.8 hotfixes.

©2024 Pegasystems Inc


Pega Government Platform '24.1 569

Pega Platform version Hotfix number Observed behavior

8.8 HFIX-A668 Rule availability change for


SaveObject activity.

HFix-85100
BAC pre-registration for
activities.

Note: This hotfix


has a prerequisite
of Pega Platform
patch 8.8.1 and
Pega Government
Platform patch
8.8.1.

Pega Government Platform 8.7

The following table lists the required Pega Government Platform 8.7 hotfixes.

Pega Platform version Hotfix number Observed behavior

8.7 HFix-84901
BAC Pre Registration for
activities

Note: This hotfix


has a prerequisite
of platform hotfix
HFIX-84702.

©2024 Pegasystems Inc


Pega Government Platform '24.1 570

Pega Government Platform 8.6

The following table lists the required Pega Government Platform 8.6 hotfixes.

Pega Platform version Hotfix number Observed behavior

8.6 HFix-84878
BAC Pre Registration for
activities

Note: This hotfix


has a prerequisite
of platform 8.6.6
patch .

HFix-82530
Enhancement- App Factory
Support for PGP 8.6.

Provided Authors Access


group for both
PegaGPCosmos and
PGPICMCosmos apps.

HFix-80896 Google key configured as


default value in parameters.

HFix-80827
The following issues are
addressed:

• SetObjClass data
transform throwing
error from @baseclass.

©2024 Pegasystems Inc


Pega Government Platform '24.1 571

Pega Platform version Hotfix number Observed behavior

• 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.

Pega Government Platform 8.5

The following table lists the required Pega Government Platform 8.5 hotfixes.

©2024 Pegasystems Inc


Pega Government Platform '24.1 572

Pega Platform version Hotfix number Observed behavior

8.5.1 HFix-80897
• Google key configured
as default value in
parameters
• Global context issues
for Image Prefix

HFix-80828 No error messages while


attaching a file to data
attachments in PGP UI Kit.

HFix-80760 Unexpected error from


pzSaveAttachments.

HFix-69879 Browser hangs when


browser refresh is used
while user is in Entity home
pages in PGP Cosmos
application.

HFix-70536 After user updated the


entity details, user details
are not refreshed in Entity
view.

HFix-80010 Delegated rules are not


getting localized.

8.5 HFix-84884
BAC Pre Registration for
activities.

Note: This hotfix


has a prerequisite

©2024 Pegasystems Inc


Pega Government Platform '24.1 573

Pega Platform version Hotfix number Observed behavior

of platform hotfix
HFix-84421.

Pega Government Platform 8.4

The following table lists the required Pega Government Platform 8.4 hotfixes.

Pega Platform version Hotfix number Observed behavior

8.4.3 HFix-68611 The offline packaging is


picking the wrong section
rule
pyAttachmentScreen . It
is picking the rule from the
Theme-Clarity application.
The Theme-Clarity should
be removed from the PGP
built-on apps.

HFix-70417 Unable to resolve the case


after opening the case
document in inline mode.

8.4 HFix-80895 Google key configured as


default value in parameters.

HFix-67465 SEC update – B20 (PGP 8.4


on Pega Platform 8.4.3)

HFix-65249 File upload to the external


repositories failing with Null
Pointer Exception.

©2024 Pegasystems Inc


Pega Government Platform '24.1 574

Pega Platform version Hotfix number Observed behavior

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.

Pega Government Platform 8.3

The following table lists the required Pega Government Platform 8.3 hotfixes.

Pega Platform version Hotfix number Observed behavior

8.3.4 HFix-67402 SEC update – B20 (PGP 8.3


on Pega Platform 8.3.4)

8.3 HFix-57961 Changes are required to


address the following
issues:

©2024 Pegasystems Inc


Pega Government Platform '24.1 575

Pega Platform version Hotfix number Observed behavior

• 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).

Pega Government Platform 8.2

The following table lists the required Pega Government Platform 8.2 hotfixes.

©2024 Pegasystems Inc


Pega Government Platform '24.1 576

Pega Platform version Hotfix number Observed behavior

8.2.8 HFix-68102 SEC update – B20 (PGP 8.2


on Pega Platform 8.2.8)

8.2 HFix-69905 Removing Unique ID


generation for person
Image if ID doesn’t exist
while retrieving the person
details.

Pega Government Platform 8.1

The following table lists the required Pega Government Platform 8.1 hotfixes.

Pega Platform version Hotfix number Observed behavior

8.1.9 HFix-67795 SEC update – B20 (PGP 8.1


on Pega Platform 8.1.9)

8.1 HFix-57445 Files not uploading to S3


bucket using PGP
framework.

HFix-48238 Changes are required to


address the following
issues:

• Visualize in PGP layer


is showing the Subject
cases.
• While uploading
image, the selection of
cropped part is not
working.
• PegaPS ruleset was
unlocked.

©2024 Pegasystems Inc


Pega Government Platform '24.1 577

Pega Platform version Hotfix number Observed behavior

• 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.

Hotfixes for Pega Government Platform 7.x


Pega Government Platform 7.4

The following table lists required Pega Platform hotfixes for Pega Government
Platform 7.4.

Pega Platform version Hotfix number Observed behavior

7.4 HFix-46018 Unique IDs are not getting


generated on checkbox, if
they configured on page list/
page group property.

HFix-45746 The pyLabel property max


length issue in

©2024 Pegasystems Inc


Pega Government Platform '24.1 578

Pega Platform version Hotfix number Observed behavior

pyAttachApprovalEmail
activity.

The following table lists required required Pega Government Platform 7.4 hotfixes.

Pega Platform version Hotfix number Observed behavior

7.4 HFix-67796 SEC Update - B20 (PGP 7.4


on Pega Platform 7.4)

HFix-65487 The entries in the CommList


pagelist property were not
mapped correctly to the
Email and Phone.

HFix-46678 Changes are required to


address the following
issues:

• Unable to validate the


participants while
editing the Interview.
• Previous case owner
unable to view the
investigation details
once the ownership is
accepted by the new
owner.
• Unable to delete the
multi-line case notes.
• Investigation address
map is not loading
because of the case
note address issue.

©2024 Pegasystems Inc


Pega Government Platform '24.1 579

Pega Platform version Hotfix number Observed behavior

• The end user is able to


open the Entity view
page from the confirm
screen through the link
displayed.
• Procurements case
status is not being
updated on rejecting
the Review plan.
• Application building on
ICM are failing because
the ICMAdmin
accessgorup is
referring to
PegaDeveloper ruleset
in production rulesets.
• Issues related to
Manage associations
fixed.
• CustomAudit section is
not visible in Subject
case on Mobile device.

Pega Government Platform 7.31

The following table lists required Pega Government Platform 7.31 hotfixes.

Pega Platform version Hotfix number Observed behavior

8.1 HFix-47979 Changes are required to


address the following
issues:

©2024 Pegasystems Inc


Pega Government Platform '24.1 580

Pega Platform version Hotfix number Observed behavior

• 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.

7.4 HFix-67213 The entries in the CommList


pagelist property were not
mapped correctly to the
Email and Phone.

7.3 HFix-39330 Removing the length


restriction in PGP data
model.

HFix-36427 Broken attachment icons in


the submit bid case.

HFix-41369 Missing empty hotfix ruleset


versions for all the apps.

HFix-41488 Hotfix for upgrade PGP 7.31


from UI-Kit 9 to UI-Kit 10.

Pega Government Platform 7.21

The following table lists required Pega Government Platform 7.21 hotfixes.

©2024 Pegasystems Inc


Pega Government Platform '24.1 581

Pega Platform version Hotfix number Observed behavior

7.3 HFix-35637 Delete Document Page


error is displayed while
logging into the system.

HFix-29562 Password mismatch error


while creating account.

7.2.2 HFix-29562 Password mismatch error


while creating account.

7.2.1 HFix-34240 Saving the PegaPS-Data


items is not working as
expected.

HFix-30345 Mandatory field validations


are thrown when user clicks
on save.

Pega Government Platform 7.16

The following table lists required Pega Foundation for Government 7.16 hotfixes.

Pega Platform version Hotfix number Observed behavior

7.3.1 HFix-35635 Changes are required to


address the following
issues:

• Opening a case from


search complaint
encounters an error.
• Logging out from the
PFG Operator page
encounters an error
page.

©2024 Pegasystems Inc


Pega Government Platform '24.1 582

Pega Platform version Hotfix number Observed behavior

• The Create Operator


link is not working.
• Users cannot view the
Add business button in
the Create operator
page.

HFix-30967 Error in the Login screen


after clicking on cancel
button.

HFix-29612 Password mismatch error


while creating operator.

HFix-28036 Delete Document Page


error is displayed while
logging into the system.

7.3 HFix-35635 Changes are required to


address the following
issues:

• Opening a case from


search complaint
encounters an error.
• Logging out from the
PFG Operator page
encounters an error
page.
• The Create Operator
link is not working.
• Users cannot view the
Add business button in

©2024 Pegasystems Inc


Pega Government Platform '24.1 583

Pega Platform version Hotfix number Observed behavior

the Create operator


page.

HFix-32809 Support for Pega


Certification and Licensing
for Government 7.21
release.

HFix-30967 Error in the Login screen


after clicking on cancel
button.

HFix-29612 Password mismatch error


while creating operator.

HFix-28036 Delete Document Page


error is displayed while
logging into the system.

7.2.2 HFix-32809 Support for Pega


Certification and Licensing
for Government 7.21
release.

HFix-30967 Error in the Login screen


after clicking on cancel
button.

HFix-29612 Password mismatch error


while creating operator.

7.2.1 HFix-30967 Error in the Login screen


after clicking on cancel
button.

©2024 Pegasystems Inc


Pega Government Platform '24.1 584

Pega Platform version Hotfix number Observed behavior

HFix-28036 Delete Document Page


error is displayed while
logging into the system.

7.2 HFix-30967 Error in the Login screen


after clicking on cancel
button.

©2024 Pegasystems Inc


Pega Government Platform '24.1 585

Resources
Find supplemental about Pega Government Platform.

• Pega Certification and Licensing for Government hotfixes

Pega Certification and Licensing for


Government hotfixes
The following tables list required hotfixes the Pega Certification and Licensing for
Government application requires. 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 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.

• Hotfixes for Pega Certification and Licensing for Government 8.x

• Hotfixes for Pega Certification and Licensing for Government 7.x

Hotfixes for Pega Certification and Licensing for


Government 8.x

©2024 Pegasystems Inc


Pega Government Platform '24.1 586

Pega Certification and Licensing for Government 8.5

The following table lists the required Pega Certification and Licensing for
Government 8.5 hotfixes.

Pega Platform Version Hotfix Number Observed Behavior

8.5.3 HFix-81747 Addressed the issues with


FetchActiveLicenseCount
report.Hotfix is provided to
update the column case to
match the case defined on
external mapping for the
classes.

Pega Certification and Licensing for Government 8.4

The following table lists the required Pega Certification and Licensing for
Government 8.4 hotfixes.

Pega Platform Version Hotfix Number Observed Behavior

8.4 HFix-67424 In Pega Certification and


Licensing for Government
8.4, security has been
enhanced on a number of
rules by the addition of an
existing privilege “AllFlows”.

Pega Certification and Licensing for Government 8.3

The following table lists the required Pega Certification and Licensing for
Government 8.3 hotfixes.

©2024 Pegasystems Inc


Pega Government Platform '24.1 587

Pega Platform Version Hotfix Number Observed Behavior

8.3 HFix-67641 In Pega Certification and


Licensing for Government
8.3, security has been
enhanced on a number of
rules by the addition of an
existing privilege “AllFlows”.

Hotfixes for Pega Certification and Licensing for


Government 7.x
Pega Certification and Licensing for Government 7.31

The following table lists required Pega Certification and Licensing for Government
7.31 hotfixes.

Pega Platform Version Hotfix Number Observed Behavior

8.1 HFix-49065 Not able to cancel the


adjudication work object
when it is created via
summon case.

HFix-47984 Changes are required to


address the following
issues:

• Status fail screen is


shown on click of
Create Operator link
on the login screen.
• Username and
password text overlaps
with the text input

©2024 Pegasystems Inc


Pega Government Platform '24.1 588

Pega Platform Version Hotfix Number Observed Behavior

fields on the login


screen.
• Click on Finish button
in Apply for License
process does not
trigger an action.

7.4 HFix-49065 Not able to cancel the


adjudication work object
when it is created via
summon case.

HFix-43465 Changes are required to


address the following
issues:

• Processing error while


creating ‘Apply for
exam’ flow.
• Create Operator link is
not visible properly.

7.3.1 HFix-49065 Not able to cancel the


adjudication work object
when it is created via
summon case.

HFix-47490 Next Category button is


displayed even when no
categories exist.

HFix-46670 The below properties are


missing for the Data page
D_CitizenProfile: Internal

©2024 Pegasystems Inc


Pega Government Platform '24.1 589

Pega Platform Version Hotfix Number Observed Behavior

Notes, Personal Address


Type, Person Citizenship
Text,State Residence
Indicator.

HFix-46482 Error occurs upon running


the D_StateList datapage.

HFix-46034 Property validation errors


are observed when testing
the database connection for
the PegaGov-Data-
CitizenProfile class.

HFix-43465 Changes are required to


address the following
issues:

• Processing error while


creating ‘Apply for
exam’ flow.
• Create Operator link is
not visible properly.

Pega Certification and Licensing for Government 7.21.01

The following table lists required Pega Certification and Licensing for Government
7.21.01 hotfixes.

Pega Platform Version Hotfix Number Observed Behavior

7.3.1 HFix-40867 Address section misaligned


when using OOTB entity
address section.

©2024 Pegasystems Inc


Pega Government Platform '24.1 590

Pega Platform Version Hotfix Number Observed Behavior

HFix-32809 Support for Pega


Certification and Licensing
for Government 7.21
release.

HFix-35628
Changes are required to
address the following
issues:

• The Create Operator


page user interface is
not working as
expected.
• Logging out from the
PFG Operator page
encounters an error
page.
• The Post-Suspension
page contains a
correspondence issue.
• The Edit-Suspension
process does not show
correspondence.
• Opening a complaint
case from search
complaint encounters
an error.
• The return to login
page screen has a
blank display.

©2024 Pegasystems Inc


Pega Government Platform '24.1 591

Pega Platform Version Hotfix Number Observed Behavior

• Users cannot view the


Add business button in
the Create operator
page.

7.3 HFix-40867 Address section misaligned


when using OOTB entity
address section.

HFix-32809 Support for Pega


Certification and Licensing
for Government 7.21
release.

HFix-35628
Changes are required to
address the following
issues:

• The Create Operator


page user interface is
not working as
expected.
• Logging out from the
PFG Operator page
encounters an error
page.
• The Post-Suspension
page contains a
correspondence issue.
• The Edit-Suspension
process does not show
correspondence.

©2024 Pegasystems Inc


Pega Government Platform '24.1 592

Pega Platform Version Hotfix Number Observed Behavior

• 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.

7.2.2 HFix-40867 Address section misaligned


when using OOTB entity
address section.

Pega Certification and Licensing for Government 7.15.01

The following table lists the required Pega Platform hotfixes for Pega Certification
and Licensing for Government 7.15.01.

Pega Platform Version Hotfix Number Observed Behavior

7.1.9 DL-50540, HFix-24020 Not able to Lock and save


the ruleset.

DL-50541, HFix-24403 Accessibilty Issue: Confirm


Message is not the first
message.

The following table lists the required Pega Certification and Licensing for Government
7.15.01 hotfixes.

©2024 Pegasystems Inc


Pega Government Platform '24.1 593

Pega Platform Version Hotfix Number Observed Behavior

7.2.2 HFix-26659 Need to lock the existing


two open ruleset versions.

HFix-27191 Upgrades to Pega


Certification and Licensing
for Government 7.15
introduce incorrect
database table name.

HFix-27532 Expertise section is not


reachable for a constituent.

HFix-29612 Password mismatch error


while creating operator.

HFix-29858 Missing class key for


Address and CommOptions
classes.

7.2.1 HFix-25503 A voided License is not


displayed as withdrawn for
Pega Certification and
Licensing for Government.

HFix-25625 No products are displayed


for New-BEIssueLicense
flow, when "Marine
Harvesting" category is
selected.

HFix-25889 Incorrect suspension type


displayed for Summons
Admin Process.

HFix-26074 Error came up after


payment is submitted in
Renew License flow.

©2024 Pegasystems Inc


Pega Government Platform '24.1 594

Pega Platform Version Hotfix Number Observed Behavior

HFix-26659 Need to lock the existing


two open ruleset versions.

HFix-27191 Upgrades to Pega


Certification and Licensing
for Government 7.15
introduce incorrect
database table name.

HFix-27532 Expertise section is not


reachable for a constituent.

HFix-29858 Missing class key for


Address and CommOptions
classes.

7.2 HFix-25503 A voided License is not


displayed as withdrawn for
Pega Certification and
Licensing for Government.

HFix-25625 No products are displayed


for New-BEIssueLicense
flow, when "Marine
Harvesting" category is
selected.

HFix-25889 Incorrect suspension type


displayed for Summons
Admin Process.

HFix-26074 Error came up after


payment is submitted in
Renew License flow.

HFix-26659 Need to lock the existing


two open ruleset versions.

©2024 Pegasystems Inc


Pega Government Platform '24.1 595

Pega Platform Version Hotfix Number Observed Behavior

HFix-27191 Upgrades to Pega


Certification and Licensing
for Government 7.15
introduce incorrect
database table name.

HFix-27532 Expertise section is not


reachable for a constituent.

7.1.9 HFix-26659 Need to lock the existing


two open ruleset versions.

HFix-27191 Upgrades to Pega


Certification and Licensing
for Government 7.15
introduce incorrect
database table name.

HFix-27532 Expertise section is not


reachable for a constituent.

Pega Certification and Licensing for Government 7.13.01

The following table lists required Pega Certification and Licensing for Government
7.13.01 hotfixes.

Pega Platform Version Hotfix Number Observed Behavior

7.1.5 HFix-27808 Incompatible datatypes


exist with Integration layer.

HFix-29811 Additional rules required to


support missing default
value of FishingTime
property in CLF framework.

©2024 Pegasystems Inc


Pega Government Platform '24.1 596

Pega Platform Version Hotfix Number Observed Behavior

HFix-30129 Two map rules required for


FishingTime property in CLF
framework.

©2024 Pegasystems Inc

You might also like