certification and licensing for government · all pega 7 have a self-documenting feature that...

Certification and Licensing for Government

IMPLEMENTATION GUIDE

Version 7.15

© Copyright 2015 Pegasystems Inc., Cambridge, MA

All rights reserved.

Trademarks

For Pegasystems Inc. trademarks and registered trademarks, all rights reserved. Other brand or product names are trademarks of their respective holders.

For information about the third-party software that is delivered with the product, refer to the third-party license file on your installation media that is specific to your release.

Notices

This publication describes and/or represents products and services of Pegasystems Inc. It may contain trade secrets and proprietary information that are protected by various federal, state, and international laws, and distributed under licenses restricting their use, copying, modification, distribution, or transmittal in any form without prior written authorization of Pegasystems Inc.

This publication is current as of the date of publication only. Changes to the publication may be made from time to time at the discretion of Pegasystems Inc. This publication remains the property of Pegasystems Inc. and must be returned to it upon request. This publication does not imply any commitment to offer or deliver the products or services described herein.

This publication may include references to Pegasystems Inc. product features that have not been licensed by you or your company. If you have questions about whether a particular capability is included in your installation, please consult your Pegasystems Inc. services consultant.

Although Pegasystems Inc. strives for accuracy in its publications, any publication may contain inaccuracies or typographical errors, as well as technical inaccuracies. Pegasystems Inc. may make improvements and/or changes to the publication at any time.

Any references in this publication to non-Pegasystems websites are provided for convenience only and do not serve as an endorsement of these websites. The materials at these websites are not part of the material for Pegasystems products, and use of those websites is at your own risk.

Information concerning non-Pegasystems products was obtained from the suppliers of those products, their publications, or other publicly available sources. Address questions about non-Pegasystems products to the suppliers of those products.

This publication may contain examples used in daily business operations that include the names of people, companies, products, and other third-party publications. Such examples are fictitious and any similarity to the names or other data used by an actual business enterprise or individual is coincidental.

This information is the property of:

Pegasystems Inc. One Rogers Street Cambridge, MA 02142-1209 USA Phone: (617) 374-9600 Fax: (617) 374-9620 www.pega.com

Document: Certification and Licensing for Government Implementation Guide

Software Version: 7.15

Updated: December 2015

CONTENTS

About this Document ..................................................................................................... i Intended Audience ......................................................................................................................... i

Guide Organization ........................................................................................................................ i

Overview ..................................................................................................................... 1-1

What is Already Set Up .............................................................................................. 2-1

System Administrator Account .................................................................................................. 2-1

Documenting Your Application .................................................................................................. 2-1

Application Rules and Rulesets Hierarchy ................................................................................ 2-1 Organizational Structure ............................................................................................................ 2-2

Actors and Responsibilities ....................................................................................................... 2-2

Access Roles ............................................................................................................................. 2-4

Work Classes ............................................................................................................................ 2-5

Data Classes ............................................................................................................................. 2-7

Extending CLG ........................................................................................................... 3-1

Build the Implementation Layer ................................................................................................. 3-1

Perform Configuration Steps ..................................................................................................... 3-4 Modify the class context data transform rule ........................................................................ 3-4 Setup and update access groups ......................................................................................... 3-5 Setup operators ..................................................................................................................... 3-9 Update the default email account ......................................................................................... 3-9

Data Tables ................................................................................................................. 4-1

Affiliations .................................................................................................................................. 4-1

Category .................................................................................................................................... 4-1

Courts ........................................................................................................................................ 4-1

Credit Types .............................................................................................................................. 4-2

Disclosures ................................................................................................................................ 4-2 Disposition ................................................................................................................................. 4-3

Disposition values ...................................................................................................................... 4-3

Documents ................................................................................................................................ 4-3

Event Exam Map ....................................................................................................................... 4-3

Exam Configurations ................................................................................................................. 4-4

Exams ........................................................................................................................................ 4-4

Expertise Configuration ............................................................................................................. 4-5 Feet and Inches ......................................................................................................................... 4-5

Gear ........................................................................................................................................... 4-5

Offenses .................................................................................................................................... 4-5

Ports .......................................................................................................................................... 4-6

Product ...................................................................................................................................... 4-6

Product Category Mapping ...................................................................................................... 4-10 Product Credit Score ............................................................................................................... 4-11

Product Dependencies ............................................................................................................ 4-11

Product Disclosures ................................................................................................................. 4-11

Product Upgrade ..................................................................................................................... 4-12

Qualification Product ............................................................................................................... 4-12

Species .................................................................................................................................... 4-12 Supplement Preferences ......................................................................................................... 4-12

Processes and Extensions ........................................................................................ 5-1

Apply for License ....................................................................................................................... 5-1 How to add a new product (License) .................................................................................... 5-1 How to update eligibility criteria of a product ........................................................................ 5-2 How to configure product dependencies .............................................................................. 5-2 How to configure product disclosure ..................................................................................... 5-2 How to configure supplement preferences of a product ....................................................... 5-3 How to extend supplements .................................................................................................. 5-3 How to add new Document Category ................................................................................... 5-4 How to configure the documents requirements of a product ................................................ 5-4 How to change the disclosure agreement ............................................................................ 5-4 How to extend Payments ...................................................................................................... 5-5 How to update review logic of license application ................................................................ 5-5 How to update routing strategies of license .......................................................................... 5-5 How to extend entity home pages ......................................................................................... 5-6 How to update the email contents ......................................................................................... 5-6 How to update the paragraphs .............................................................................................. 5-7

Reprint License .......................................................................................................................... 5-7 How to update the payment configuration ............................................................................ 5-7

Void License .............................................................................................................................. 5-7 How to update the email contents ......................................................................................... 5-7 How to update the paragraphs .............................................................................................. 5-7

Upgrade License ....................................................................................................................... 5-7 How to update the paragraphs .............................................................................................. 5-8

Update License .......................................................................................................................... 5-8

Renew License .......................................................................................................................... 5-8 How to update the paragraphs .............................................................................................. 5-8 How to update the expertise check ....................................................................................... 5-8

Compliance Report .................................................................................................................... 5-8 How to configure a product for reporting............................................................................... 5-9 How to update the email contents ......................................................................................... 5-9

Notify Non Compliance (Mass Mailing) ..................................................................................... 5-9 How to update the email contents ......................................................................................... 5-9 How to update the paragraphs .............................................................................................. 5-9

Enter/Issue Warning .................................................................................................................. 5-9 How to configure offense title, section and description in warning details screen ................ 5-9

Update/Void Warning .............................................................................................................. 5-10

Cancel Summon ...................................................................................................................... 5-10

Suspend License (Manual) ...................................................................................................... 5-10 How to update the paragraphs ............................................................................................ 5-11 How to update email contents ............................................................................................. 5-11 How to update routing strategies for Hearing ..................................................................... 5-12 How to update routing strategies for Hearing review .......................................................... 5-12

Update Suspension ................................................................................................................. 5-12 How to change content of PDF ........................................................................................... 5-12

Miscellaneous Payment........................................................................................................... 5-12 How to update email content .............................................................................................. 5-13

Apply Course Credit ................................................................................................................ 5-13

Add Course Attendance .......................................................................................................... 5-13

New Course Request .............................................................................................................. 5-13 How to update email contents ............................................................................................. 5-13

Score Exam ............................................................................................................................. 5-14 How to update email contents ............................................................................................. 5-14

Apply for Exam ........................................................................................................................ 5-14 How to update fee waiver percentage ................................................................................ 5-14 How to update eligibility criteria for qualifications ............................................................... 5-15 How to update routing strategy of exam applications ......................................................... 5-15

Create Exam Schedule............................................................................................................ 5-15

Manage Exam Schedule ......................................................................................................... 5-15

View Roster ............................................................................................................................. 5-15

Portals and Dashboards ............................................................................................ 6-1

Portals........................................................................................................................................ 6-1

Dashboard customization .......................................................................................................... 6-1

End user portal .......................................................................................................................... 6-2

Appendix A, Global Settings .................................................................................... A-1 Payment Mode ..................................................................................................................... A-1 PDF Generation mode ......................................................................................................... A-1 Product Short Form .............................................................................................................. A-1 License Print Cost ................................................................................................................ A-2

Intended Audience This guide is intended for the following individuals:

Business Managers — responsible for evaluating the application solution and possess a general, non-technical understanding of its features and capabilities.

Project Managers / Business Analysts — responsible for implementing an application solution that can be applied to specific business requirements, and ensures compliance and continuous improvement across organizations.

System Architects / Application Developers — responsible for building, maintaining, modifying, and extending the application.

System and Database Administrators — responsible for the installation, security, and ongoing operational functions of the application such as access, tuning, and troubleshooting. These users are presumed to be experienced with system operations.

Guide Organization This guide contains the following sections:

Chapter 1: Overview Provides an overview of CLG. Chapter 2: What is Already Set Up Describes the Pega-provided components of CLG. Chapter 3: Extending CLG Describes how to extend CLG. Chapter 4: Data Tables Describes details of various data tables of CLG. Chapter 5: Processes & Extensions Describes the processes of CLG and how to extend those processes. Chapter 6: Portals & Dashboards Describes CLG portals.

About this Document

Certification and Licensing for Government Implementation Guide i

Pega’s Certification & Licensing for Government (CLG) is a comprehensive and configurable solution that provides an end-to-end process for government agencies to manage the lifecycle of their certification and licensing processes from application intake through payments, reviews, renewals, enforcements, inspections, transfers and activity reporting. This multi-channel solution enables agencies to configure their licenses processes to match their policies, and interact with constituents and business entities to manage their licensing needs. CLG is built on the Pega Foundation for Government (PFG) application, and it utilizes the core constituent and business management capabilities of that application, as well as Pega’s leading BPM and dynamic stage-based case management capabilities. The core objectives of CLG are:

Provide a seamless and simple process for constituents, businesses and agency employees

Reduce paper processing and minimize touch points to provide straight-through processes

Modernize the platform for issuing certificates and licenses

Reduce the project implementation time and accelerate project delivery

Build for change in order to accommodate business policy changes by business users

Improve communication and interaction with the constituents and business entities

For a detailed list of product functions and features, refer to CLG’s product function map.

1 Overview

Certification and Licensing for Government Implementation Guide 1-1

This chapter describes defaults and data samples that are already set up and ready for use in the Application. It is expected that many of these features are used for extending the application.

The topics include:

System Administrator Account

Documenting Your Application

Application Rules and Rulesets Hierarchy

Actors and Responsibilities

Access Roles

Work Classes

Data Classes

System Administrator Account The application uses the following ID as the default system administrator account.

Operator ID: CLFSysAdmin

Password: install

Note: Operator IDs are not case sensitive, but passwords are.

Documenting Your Application Before you begin the deployment process, it is important to understand what classes, rules, and flows already exist. All Pega 7 have a self-documenting feature that enables you to develop and document your application simultaneously.

Using the Application Document Wizard along with this guide helps you understand what has been delivered and what has changed as you deploy PFG into your test and production environment. You can access the wizard by selecting Designer Studio > Application > Tools > Document. See the PDN article Using the Application Document Wizard for information about how to use this feature.

Application Rules and Rulesets Hierarchy The CLG contains a number of Application rules. Application rules define an ordered set of Rulesets and versions that together identify the parts of an application layer.

PegaCLF 07.15 – This application contains the core features of CLG application

2 What is Already Set Up


TITLE of INTERNAL DOCUMENT – Arial Bold 12 pt

You can view a list of the application rules and their rulesets that form the application from the Designer studio by selecting the Designer Studio > Application > Structure landing page option.

The ruleset stack tab displays the CLG application and all of the applications on which the application is built on. It also shows the high level ruleset stack for each of the application rules defined in the application.

Organizational Structure The application comes with a predefined organization, division, and organizational unit.

Select the Designer Studio > Org & Security > Organization > Organizational Chart.

Create the required organization structure here for the implementation.

Actors and Responsibilities This section describes the sample operators and access groups in CLG that are installed with the application. Passwords are set to rules. Additional to the list there are equivalent accessible operators available (WAI).

Actor Operator ID / Password

Access Group Work Group Responsibilities

Case Worker CLGCaseWorker / rules PegaCLF:CaseWorker CLFWorkerGroup Every license holder’s information is maintained in the system. Case Worker can be performed all kinds of





actions on behalf of license holder.

Court Administrator

CLFCourtAdmin / rules PegaCLF:CourtAdmin CLFCourtAdminWG Court Administrator is involved in enforcement process.

Head Quarter Administrator

CLFHQAdminA / rules PegaCLF:HQAdmin CLFHQAdminWG Head Quarter Administrator is involved in enforcement process.

Head Quarter Reviewer

CLFHQReviewer / rules PegaCLF:HQReviewer CLFHQAdminWG Head Quarter Reviewer is involved in enforcement process.

Hearing Administrator

CLFHearingAdmin / rules PegaCLF:HearingAdmin CLFHearingWG Hearing Administrator is involved in enforcement process.

Hearing Officer

CLFHearingOfficer / rules

PegaCLF:HearingOfficer CLFHearingReviewWG

Hearing Officer is involved in enforcement process.

Inspector CLFInspector / rules PegaCLF:Inspector CLFInspectionWG Issuance of some license may needed Inspection. Inspector is the first person who inspects the application. If Inspector rejects any of the license application, it cannot be issued at all.

Manager CLFManager / rules PegaCLF:Manager CLFManagerGroup CLF Manager is a super user. He can perform every process of the application. License issuance has three stages such as Apply, Review and Inspection. Every license may not need Review stage. Manager is the one who reviews all the applications which needs review. He verifies the applicant details, license details which he applied for, supporting documents, supplemental information and the payment details. No other user can perform Review stage of the application.

Sergeant CLFSergeant / rules PegaCLF:Sergeant CLFSergeantWG Sergeant is involved in





enforcement process. Supervisor CLFSupervisor/ rules PegaCLF:Supervisor CLFInspectionWG Issuance of some license

may needed Inspection. Supervisor acts after the inspector. He verifies whether the inspection went right or not. License cannot be issued unless Inspector and Supervisor approved it.

Suspension Administrator

CLFSuspensionAdmin / rules

PegaCLF:SuspensionAdmin

SuspensionAdminWG Suspension Administrator is involved in enforcement process.

End User MPENELOPE / 123456 PegaCLF:User CLFUserGroup Constituents/End users get all the possible service from self-service portal

Access Roles The application provides several access roles. Below table describes them.

Access Roles Description

PegaCLF:AddConstituent Required for adding new constituents PegaCLF:AdminReview Required for reviewing the summons. Sergeant has this role. PegaCLF:Administrator Required for administrator privileges. PegaCLF:ApplyLicense Required for applying a new license for constituents / business entities. PegaCLF:CLFOfficer Required for entering warnings and summons PegaCLF:CancelSummon Required to Cancel a Summon PegaCLF:Compliance Required for saving the compliance reports PegaCLF:ComplianceReport Required to work on compliance report work item PegaCLF:EnterReport Required for entering compliance report PegaCLF:HQReview Required for Head Quarter Review of summon PegaCLF:HearingAdmin Required for Hearing Admin of summon PegaCLF:HearingOfficer Required for suspension of license family or license itself and also violation of any

license PegaCLF:InitiateAdjudication Required for Initiation of Adjudication PegaCLF:LicenseSearch Required for searching a license PegaCLF:Manager Required for case manager role PegaCLF:MassMailingCompliance Required for notifying the non-compliance license holders PegaCLF:MiscellaneousPayment Required for access to Miscellaneous Payments PegaCLF:RenewLicense Required for Renewing a License



Access Roles Description

PegaCLF:ReportSummary Required to access Report Summary PegaCLF:ReportSummaryInt Required to save or retrieve compliance reports from database. PegaCLF:Reprint Required for reprinting a license PegaCLF:SetPreferences Required for setting preference for compliance report PegaCLF:Summon Required to enter Summon PegaCLF:SuspendLicense Required to suspend a license (suspension work item) PegaCLF:Suspension Required for performing database operations on suspension records which includes

license and family suspensions PegaCLF:UpdateLicense Required for updating of license PegaCLF:UpdateSuspension Required to update suspension PegaCLF:UpdateWarning Required to update warning PegaCLF:Upgrade Required to upgrading a license PegaCLF:Void Required to void a license PegaCLF:Warning Required for entering a warning PegaGov:CreateOperator Required for creating new operators

Work Classes Work classes are available to support the behavior and appearance of the application. They derive the flow and the user interface for the application. The Work Classes used in the Application are:

PegaPS-FW-LCFFW-Work

PegaPS-FW-LCFFW-Work-ApplyLicense

PegaPS-FW-LCFFW-Work-Course

PegaPS-FW-LCFFW-Work-Course-ApplyCredit

PegaPS-FW-LCFFW-Work-Course-Attendance

PegaPS-FW-LCFFW-Work-Exam

PegaPS-FW-LCFFW-Work-Exam-Apply

PegaPS-FW-LCFFW-Work-Exam-ScoreExam

PegaPS-FW-LCFFW-Work-Exam-ViewRoster

PegaPS-FW-LCFFW-Work-License

PegaPS-FW-LCFFW-Work-License-ComplianceReport

PegaPS-FW-LCFFW-Work-License-NotifyNonCompliance

PegaPS-FW-LCFFW-Work-License-Renew

PegaPS-FW-LCFFW-Work-License-ReportPrefs



PegaPS-FW-LCFFW-Work-License-ReportSummary

PegaPS-FW-LCFFW-Work-License-Reprint

PegaPS-FW-LCFFW-Work-License-Update

PegaPS-FW-LCFFW-Work-License-Upgrade

PegaPS-FW-LCFFW-Work-License-Void

PegaPS-FW-LCFFW-Work-LicenseSearch

PegaPS-FW-LCFFW-Work-Manage

PegaPS-FW-LCFFW-Work-Manage-Education

PegaPS-FW-LCFFW-Work-Manage-Training

PegaPS-FW-LCFFW-Work-Manage-Vehicle

PegaPS-FW-LCFFW-Work-Schedule

PegaPS-FW-LCFFW-Work-Schedule-Exam

PegaPS-FW-LCFFW-Work-Violation

PegaPS-FW-LCFFW-Work-Violation-CancelSummon

PegaPS-FW-LCFFW-Work-Violation-IssueSummon

PegaPS-FW-LCFFW-Work-Violation-IssueWarning

PegaPS-FW-LCFFW-Work-Violation-MiscellaneousPayment

PegaPS-FW-LCFFW-Work-Violation-SuspendLicense

PegaPS-FW-LCFFW-Work-Violation-UpdateSuspension

PegaPS-FW-LCFFW-Work-Violation-UpdateWarning



Data Classes

Data classes define the data structures that support information that the application uses to process work.


This chapter describes the high level steps to create an implementation layer on top of the Certification and Licensing for Government application and modify or create the required rules and structures to support the layer.

Build the Implementation Layer 1. Login to the application as CLFSysAdmin operator (default pw: install).

2. From the Application Menu, select the New Application option.

3. Start the creation of new application by selecting either “Enterprise application” or “Express application” and clicking on Create new application.

4. In the Application Settings enter appropriate details

a. Application name – Enter your desired application name, in this example it is CLGImp b. Built on application – Certification & Licensing

3 Extending CLG



c. Application structure – Select Implementation only (the other options can be chosen based on the your architectural decisions)

d. Organization - Enter desired organization name

5. Click Configure advanced settings and review the screen. It should look similar to the screen below. After your review, click on Save and then on Next> to move to the Business objectives display.

6. Populate the Business objectives to meet your business requirements. Click Next> to display the Case types screen.

7. Select the desired Case types and click on Next>.



8. Select the desired Data types and click on Create.

9. Creation of the new application may take several minutes. If the application is successfully created the below screen will appear.



Perform Configuration Steps After the implementation layer has been created, perform configurations as described in the following steps. For these steps ensure you are logged in as a developer in DesignerStudio.

Modify the class context data transform rule Search for the InitializeClassContext data transform rule of PegaPS-FW-LCFFW-Data-ClassContext in the CLG layer. Use Save as to save it as InitializeClassContext in the CLG Implementation layer (for this example CLGImp).

Update the rule in the implementation layer so that all the work class properties names have implementation Class Names as values. To find the appropriate Class Names to be used in renaming, open the newly created Application rule by selecting Open Application from the Application menu (“CLGImp”). The Implementation class column can be seen on the Cases & data tab.



Use these values to update Class Names in the InitializeClassContext data transform.

Setup and update access groups Set up and update access groups using the menu option DesignerStudio - Org & Security - Groups & Roles.

Update the CLGImp:Administrators access group

Check the portals in the CLG layer and add the missing ones. In this example, Manager, CaseWorker, Supervisor and Inspector portals are added. Also, add all of the required roles from the PegaCLF:Administrators access group. (Note: Only few roles are added in this screenshot, all the required roles should be added). Select Developer as the default portal.



Update the CLGImp:Manager access group

Check the portals in the CLG layer and add the missing ones. Also, add all of the required roles from the PegaCLF:Manager access group. (Note: Only few roles are added in this screenshot, all the required roles should be added).

Update the CLGImp:Users access group

Check the portals in the CLG layer and add the missing ones. Also, add all of the required roles from the PegaCLF:Users. (Note: Only few required roles are added in this screenshot, all the roles should be added). Select EndUser7 as the default portal.



Create a new access group CLGImp:Inspector

Do this by opening PegaCLF:Inspector, selecting Save as from the Save menu and naming the access group CLFImp: Inspector. Update the application to your implementation layer.

Repeat the same process for all the other access groups of CLG. Check the CLG Layer access groups for the entire list.



Setting up accessibility access groups

1. Make sure the PegaWAI:07-10 ruleset is present in the application. It comes as part of the Pega 7 Platform package and it needs to be imported into the application.

2. Add the PegaWAI:07-10 ruleset in the Production rulesets of the application. From the Application menu select Open Application and click on Advanced. Now add the PegaWAI:07-10 to the Production rulesets as shown below.

3. Adding access group CLGImp:WAICaseWorker. Do this by opening PegaCLF:WAICaseWorker, selecting Save as from the Save menu and naming the access group CLGImp:WAICaseWorker. Update the application to your implementation layer. Make sure that in the Advanced tab, the “Enable accessibility add-on” is enabled and the PegaWAI:07-10 ruleset is added to the production ruleset as shown below. Repeat the same process for the other access groups of type WAI.



Setup operators Create operators listed in the table below using Create > Organization > Operator ID. You may enter the operator id of your choice. For each operator use the Profile tab to update contact data, add the access group and work group details as listed in the table and set the radio button to select this as the default access group. From the Work tab, update Organizational unit to PegaOrg / Div / Unit. From the Security tab, determine and set a password (for example “password”) and then click Save.

Operator ID Description Access Group Work group clgimplcaseworker CLG Impl Caseworker CLGImpl:CaseWorker CLFWorkerGroup clgimplexamreviewer CLG Impl Exam Reviewer CLGImpl:ExamReviewer CLFExamReviewerWG clgimplhearingadmin CLG Impl Hearing Admin CLGImpl:HearingAdmin CLFHearingWG clgimplhearingofficer CLG Impl Hearing Officer CLGImpl:HearingOfficer CLFHearingReviewWG clgimplhqadmin CLG Impl HQ Admin CLGImpl:HQAdmin CLFHQAdminWG clgimplhqreviewer CLG Impl HQ Reviewer CLGImpl:HQReviewer CLFHQAdminWG clgimplinspector CLG Impl Inspector CLGImpl:Inspector CLFInspectionWG clgimplmanager CLG Impl Manager CLGImpl:Manager CLFManagerGroup clgimplcourtadmin CLG Impl Court Admin CLGImpl:CourtAdmin CLFCourtAdminWG clgimplpatrolofficer CLG Impl Patrol Officer CLGImpl:PatrolOfficer CLFPatrolOfficerWG clgimplsergeant CLG Impl Sergeant CLGImpl:Sergeant CLFSergeantWG clgimplsupervisor CLG Impl Supervisor CLGImpl:Supervisor CLFInspectionWG clgimplsupenadmin CLG Impl Suspension Admin CLGImpl:SuspensionAdmin SuspensionAdminWG

In addition to the above operator ids, end user operators can also be created in the application. For this use the Create operator link (user registration process) on the login screen.

Update the default email account Configuring the email account enables the system to additionally send email to sales representatives when new work objects are created for them (such as new Leads). If this is not configured, email will not be sent out. No other functionality is affected. The necessary information to configure Email should be provided by your system administrator. From the DesignerStudio menu, select Integration > Email > Email Accounts. Update the Default email account of type Notify with the correct host and sender/receiver details.


NOTE: CLG provides various data tables for the configuration purpose. Several places of this document refer the Class Names of those data tables. Those Class Names are applicable when there are no subclasses created for the data classes (data tables). If implementation has its own data classes (or extended), then the required steps should be performed in the respective class.

Affiliations Class Name: PegaPS-FW-LCFW-Int-AffiliationConfig

Description: Apply for Exam process uses affiliation type field. List of affiliations can be updated at the below data table.

Column Name Description

ID ID

Label Affiliation type like federal, Municipal etc.

Category Class Name: PegaPS-FW-LCFFW-Data-Category

Description: In CLG, various documents can be grouped as a category. Categories can be associated to the processes. Ex: Apply for license process expects the required documents by the applicants if there are any documents required for the selected product. Document categories are associated to some products. Hence whenever applicants apply for such product/license, then upload documents screen comes up with the associated categories. To update the category list use this data table.


Category ID A unique identification number for the Category

Category name Name of the category which is tied to the work attachments. It should not have blank spaces.

Display name Name of the category which can be displayed in the User Interface

Courts Class Name: PegaPS-FW-LCFFW-Data- Courts

Description: This data table holds all possible courts pertaining to the jurisdiction of the organization.

4 Data Tables




Court ID Unique identifier

Label Description

Court Name Court Name

Court Address 1 Court Address1

Court Address 2 Court Address2

Court City Court City

Court State Court State

Court Zip Court ZIP code

Credit Types Class Name: PegaPS-FW-LCFFW-Data- CreditTypes

Description: This data table holds possible continuing education credit types that an agency could offer relevant to obtaining and being in compliance to renew a license.


Type Credit type

Agency Provider of credit type

Active Status of credit

Disclosures Class Name: PegaPS-FW-LCFFW-Data- Disclosure

Description: Disclosure is a relevant content to be part of the consent agreement for entities to abide by the agencies legal procedures. This data table holds all the disclosures.

Column Name

Description

ID A unique identification number for the disclosure

Description Description/note

Legend Notation to represent a disclosure. Example: There is a disclosure attached to a product, “License allows transportation of resource beyond the state limits.” To refer this particular disclosure in multiple places “F” is used as a short form for it. Here the legend is “F”.



Disposition Class Name: PegaPS-FW-LCFFW-Data-Disposition

Description: As part of the entering the catch activity report, license holders have to enter catch information. Disposition is one of the fields in catch information. In order to update dispositions use this data table.


ID Unique identifier Definition Disposition Type Label Description

Disposition values Class Name: PegaPS-FW-LCFFW-Data- DispositionValues

Description: Disposition values are possible adjudication results of an enforcement or violation case.


Disposition Value Unique disposition value

Label Description

Guilty Whether is it guilty or not.

Documents Class Name: PegaPS-FW-LCFFW-Data-Document

Description: This data table holds list of possible documents that could be obtained within a category of document.


Document ID A unique identification number for the Category Category ID Category ID, the ID of the Category table Document Name Name of the Document. Ex: Passport, Partnership Agreement, Tax Certificate and etc. Description Description of the document

Event Exam Map Class Name: PegaPS-FW-LCFW-Int- EventExamMap



Description: In order to get a specific qualification, constituents have to clear set of exams. Some of exams might be mandatorily given. A mapping of what events or qualifications one could complete by going through a cluster of exams.


Event ID Event ID

Exam ID Exam ID

Required Is it mandatory or not?

Exam Configurations Class Name: PegaPS-FW-LCFW-Int- ExamConfig

Description: This data table holds a list of possible exams that the agency will offer and its relevant fees, descriptions, minimum passing score etc. Score exam process uses the pass score value from this, and decides whether the applicant has pass the exam or not.


Exam ID ID

Exam Name Name of the exam

Fee Exam fee

Pass Score Minimum score to pass the exam

Exams Class Name: PegaPS-FW-LCFFW-Int-ExamConfig

Description: Apply for exams process shows all the exams scheduled at the selected date. In order to schedule an exam on a specific date, the exam must available in the data table, then only the exam administrators can schedule exams. List of exams can be updated at the below data table.


Exam ID ID of the exam

Exam Name Name of the exam

Fee Exam fee

Pass Score Minimum score to pass the exam



Expertise Configuration Class Name: PegaPS-FW-LCFW-Int- EventExamMap

Description: Licenses may need pre-requisites like the applicant education details, training details and professional experience details. CLG license application process takes the required details from the applicants based on the licenses selected. Update the below data table to set such pre-requisite conditions.


Product ID Product ID

Expertise Type Required expertise type. Possible values are Education, Training and Experience.

Feet and Inches Class Name: PegaPS-FW-LCFFW-Data-HeightConversion

Description: In order to update feet and inches use this data table

Column Name Description Inches Number of Inches Label Description Feet and Inches Representing number of inches in Feet’s and Inches. Ex: Say,

54 Inches are equivalent to 4 Feet’s 6 Inches (configure it as 4’ 06’’).

Gear Class Name: PegaPS-FW-LCFFW-Data-Gear

Description: Effort information of catch activity report has a Gear of compliance report field. Gear is a dropdown field as shown below. In order to update gear use this data table


ID Unique identifier

Gear Name Gear Name

Label Description

Offenses Class Name: PegaPS-FW-LCFFW-Data-Offenses

Description: This data table holds a list of all the offenses including its title and sections that aid the enforcement intake processes.




ID Unique identifier Label Notes Title Offense Title Section Section number of Law Offense Description Offense Description Suspension Type Type of suspension, possible values are Internal Policy and Mandatory Suspension Length Length of suspension Suspension Unit Units can be Days, Weeks or Months.

Ports Class Name: PegaPS-FW-LCFFW-Data-Ports

Description: Enter catch activity report shows the ports list. This list changes based on the State selected. To update the ports use this table.

Column Name Description ID Unique identifier of port Port Name Name of the port Country Name The country where the port is located in. State Code State of code of the port Label Description

Product Class Name: PegaPS-FW-LCFFW-Data-Product

Description: This data table holds all possible products or licenses or certificates, which the solution will provide and cater to the constituents and agencies.

Column Name Description Product ID A unique identification number for the product

Label Product name

Flavour Type Say, Commercial Fishing license type is available for Single, Crew and Nonresident. CLG treats them as flavors of the product. Product table should have 3 different entries by selecting different flavor type for each. Flavor is anything that differentiates the variations of the product. If the product is having no variations then select Flavor Type as 'None'.

Flavour Order It is required only when a product has flavors. UI lists the products based on this order.

Cost Per Each Cost per each product. If the applicant is eligible and requests for multiple number of the same product (including flavor), then system automatically calculates the total cost.

Product Category Category of the product.



Column Name Description Second step of the application process (apply for license) shows the product categories.

Need Additional Info?

True, If there are any other details to be captured for this specific product. In general, it is used to capture the supplemental information.

Active? True, if the product is active and can be issued.

Expiry Type Expiry period might be different for each product. Product expiry might be in terms of days, weeks, months, years. NumberOfDays - Expiry type in days. Say, if a product expiry date is configured as 40 days, then the application automatically calculates 40 days from the issue date and sets the expiry date. It is applicable to all other Expiry Type options as well. NumberOfWeeks - Expiry type in weeks. NumberOfMonths - Expiry type in months.

NumberOfYears- Expiry type in years.

CalendarYear - Expiry type in calendar years. (Ends on Dec 31st). Say, if a product starts in June 2015, and ends in Dec 31st, 2017 then the Expiry Type of the product should be Calendar Year, and Expiry Unit should be 2.

Expiry Unit Say, if a Product expires in 4 weeks, then Expiry Type is 'NumberOfWeeks' and Expiry Unit is '4'

Max Qty Per Applicant

Maximum number of products (of the same type) per applicant.

Short Form Used in generating the license number

Inspection Required?

Yes – Issuance of the license for this product required Inspection.

No – License can be issued without inspection. Dependent on Inspection

Issuance of a license/product can be dependent on another product. License can be issued if and only if the dependent license is Active. Say, license for ProductA is issued only when the applicant holds active ProductB license. Then the ‘Dependent on Inspection’ column of ProductA should be filled with the ProductB.

Issue Immediately? This column is valid only for the licenses which has Inspection.

Yes – If the applicant has similar license in the last year/current year, then the License can be issued before the completion of Inspection. It does not skip the Inspection process. If it fails in Inspection then the license gets cancelled.

No – License cannot be issued until the Inspection is completed. Action On Inspection

If inspection fails for a license, what action has to be performed on its dependents?

Start Date for the License (product)

Start date of a product is in MM/DD format.

Example: Say, ProductA is configured as 03/15; applicant applied for ProductA on 15th Feb, 2014, then the Start Date of the license is 15th March, 2014.

Future Window Start Date

Future Window Start Date is in MM/DD format.



Column Name Description From which date the customers can apply for a product which can be used in future.

Example: Say, ProductA starts on 15th May, and the customers can apply it from 2nd Jan. Then the Future Window Start Date for ProductA is 01/02.

Future Window End Date

Future Window End Date is in MM/DD format. It tells when the application window closes for future Qty.

Example: Say, ProductA starts on 15th May, and the customers can apply it from 2nd Jan to 1st Mar. Then the Future Window End Date for ProductA is 03/01. If applicant applies on 15th Mar, he can’t apply ProductA future Qty.

Reporting Frequency Type

If license requires any compliance reports then this has to set with the relevant value from the Yearly, Monthly, Weekly and Daily. Leave this field if license does not need any compliance reports. Currently CLG supports only Yearly and Monthly.

Product Family Products can be categorized in to different families. Write the family name here. This will be used in Enforcement process.

Renew Limit For Active

Licenses can be renewed before they expire. This column holds the value in months. This tells from which date we can renew the license. This column holds the value in Months.

Example: Say, LicenseX expires on 15th Aug, and it can be renewed from 15th June. Then the Renew Limit For Active is 2.

Renew Limit For Expired

Licenses can be renewed post expiry as well. This column holds the value in Months.

Example: Say, LicenseX expires on 15th Aug 2014, and it can be renewed from 15th June 2014 to 15th Jun 2015. Then the Renew Limit For Expired is 10. LicenseX can be renewed until 10 months of its expiry.

Image Path Path of the image which represents the product. It is used in self-service portal.

Class Name PegaPS-FW-LCFFW-Data-Product


Product ID A unique identification number for the product

Label Product name

Flavour Type Say, Commercial Fishing license type is available for Single, Crew and Nonresident. CLG treats them as flavors of the product. Product table should have 3 different entries by selecting different flavor type for each. Flavor is anything that differentiates the variations of the product. If the product is having no variations then select Flavor Type as 'None'.

Flavour Order It is required only when a product has flavors. UI lists the products based on this order.

Cost Per Each Cost per each product. If the applicant is eligible and requests for multiple number of the same product (including flavor), then system automatically calculates the total cost.

Product Category Category of the product.

Second step of the application process (apply for license) shows the product categories. Need Additional Info?

True, If there are any other details to be captured for this specific product. In general, it is used to capture the supplemental information.



Column Name Description Active? True, if the product is active and can be issued.

Expiry Type Expiry period might be different for each product. Product expiry might be in terms of days, weeks, months, years. NumberOfDays - Expiry type in days. Say, if a product expiry date is configured as 40 days, then the application automatically calculates 40 days from the issue date and sets the expiry date. It is applicable to all other Expiry Type options as well. NumberOfWeeks - Expiry type in weeks. NumberOfMonths - Expiry type in months.

NumberOfYears- Expiry type in years.

CalendarYear - Expiry type in calendar years. (Ends on Dec 31st). Say, if a product starts in June 2015, and ends in Dec 31st, 2017 then the Expiry Type of the product should be Calendar Year, and Expiry Unit should be 2.

Expiry Unit Say, if a Product expires in 4 weeks, then Expiry Type is 'NumberOfWeeks' and Expiry Unit is '4'

Max Qty Per Applicant

Maximum number of products (of the same type) per applicant.

Short Form Used in generating the license number

Inspection Required?

Yes – Issuance of the license for this product required Inspection.

No – License can be issued without inspection. Dependent on Inspection

Issuance of a license/product can be dependent on another product. License can be issued if and only if the dependent license is Active. Say, license for ProductA is issued only when the applicant holds active ProductB license. Then the ‘Dependent on Inspection’ column of ProductA should be filled with the ProductB.

Issue Immediately? This column is valid only for the licenses which has Inspection.

Yes – If the applicant has similar license in the last year/current year, then the License can be issued before the completion of Inspection. It does not skip the Inspection process. If it fails in Inspection then the license gets cancelled.

No – License cannot be issued until the Inspection is completed. Action On Inspection

If inspection fails for a license, what action has to be performed on its dependents?

Start Date for the License (product)

Start date of a product is in MM/DD format.

Example: Say, ProductA is configured as 03/15; applicant applied for ProductA on 15th Feb, 2014, then the Start Date of the license is 15th March, 2014.

Future Window Start Date

Future Window Start Date is in MM/DD format.

From which date the customers can apply for a product which can be used in future.

Example: Say, ProductA starts on 15th May, and the customers can apply it from 2nd Jan. Then the



Column Name Description Future Window Start Date for ProductA is 01/02.

Future Window End Date

Future Window End Date is in MM/DD format. It tells when the application window closes for future Qty.

Example: Say, ProductA starts on 15th May, and the customers can apply it from 2nd Jan to 1st Mar. Then the Future Window End Date for ProductA is 03/01. If applicant applies on 15th Mar, he can’t apply ProductA future Qty.

Reporting Frequency Type

If license requires any compliance reports then this has to set with the relevant value from the Yearly, Monthly, Weekly and Daily. Leave this field if license does not need any compliance reports. Currently CLG supports only Yearly and Monthly.

Product Family Products can be categorized in to different families. Write the family name here. This will be used in Enforcement process.

Renew Limit For Active

Licenses can be renewed before they expire. This column holds the value in months. This tells from which date we can renew the license. This column holds the value in Months.

Example: Say, LicenseX expires on 15th Aug, and it can be renewed from 15th June. Then the Renew Limit For Active is 2.

Renew Limit For Expired

Licenses can be renewed post expiry as well. This column holds the value in Months.

Example: Say, LicenseX expires on 15th Aug 2014, and it can be renewed from 15th June 2014 to 15th Jun 2015. Then the Renew Limit For Expired is 10. LicenseX can be renewed until 10 months of its expiry.

Image Path Path of the image which represents the product. It is used in self-service portal.

Product Category Mapping Class Name: PegaPS-FW-LCFFW-Data-ProductCategoryMap

Description: This data table holds all the possible associations of the document categories and the products.


Product ID Product ID, the ID of the Product table

Category ID Category ID, the ID of the Category table

Applicant Type System supports three applicant types, they are Constituent, Business Entity and Any



Product Credit Score Class Name: PegaPS-FW-LCFW-Int-ProductCreditScoreMap

Description: Licenses may have some of the credit scores as pre-requisites. Update the below data table to set such pre-requisite conditions.


Credit Hours Credit hours of a course

Credit type Credit type like forest, green house etc

Product ID Credit for product

Product Dependencies Class Name: PegaPS-FW-LCFFW-Data- ProductDependencies

Description: There are pre-requisite licenses to get some of the licenses. Such license dependencies can be configured in CLG. In application process, the system verifies whether all the pre-requisites/dependent licenses are applied or not. If the dependent licenses are not applied, then it shows the error. To update the product dependencies use this table.

Column Name

Description

Product ID Product ID , the ID of the Product table Dependent On

Product ID, the ID of the Product table. For example, in order to purchase Wholesale Seafood Supplemental product, the applicant has to apply for Wholesale Seafood product as well. To address this, product table should have these two entries and then in this table one entry is required to add the dependency. In the above example, Product ID column should be set with the ID of Wholesale Sea food Supplemental, and Dependent On column should set with the ID of Wholesale Seafood.

Category For future purpose. This is useful to address the requirements like; a product is dependent on a product from a set. Ex: To take Product A, applicant has to take at least one from the {Product B, Product C, and Product D}.

Label Description of association

Product Disclosures Class Name: PegaPS-FW-LCFFW-Data- DisclosureMap

Description: This data table holds all the possible associations of the disclosures and the products.


License ID Unique identifier

Product ID Unique identifier for product



Product Upgrade Class Name: PegaPS-FW-LCFFW-Data-ProductUpgrade

Description: The records of this data table provide the logical upgrade path for the certain products as defined by the agency.


Product ID Parent product ID Upgrade ID Upgrade product ID Upgrade Cost Cost of upgrade Label Description

Qualification Product Class Name: PegaPS-FW-LCFW-Int- QualificationProductConfig

Description: Configuration that defines the exam qualification’s needed to obtain certain products or licenses.


Product Product Id Qualification Qualification Id

Species Class Name: PegaPS-FW-LCFFW-Int-SpeciesGradeMarket

Description: Entering catch activity report takes species information. To update the species use this table


Species Code Unique identifier

Species Name Name of the Species

Grade Code Grade Code

Market Code Market Code

Unit of Measure code LB (for Pounds), BG, CN, PS, MP, BU

Label Description

Supplement Preferences Class Name: PegaPS-FW-LCFFW-Data- SupplementPreferences



Description: Supplements are the entities used by the applicants in utilizing the license services. CLG has data model for the supplements such as facilities, vehicles and vessels. Licenses may need some of the supplements as the pre-requisites. CLG license application process expects to provide the required supplements information based on the selection of the license. To update the supplement preferences use this table.

Column Name Description ID Product ID Supplement Type Type of supplement. CLF supports Vehicles, Vessels and Facilities. Owned Supplements Required

Whether the product required owned supplement or not. Say, ProductX requires owned vehicles, and rented/owned facilities. Then the configuration should be like below,

ProductX – Vehicles – True – Owned Vehicles

ProductX – Facilities – False – Facilities may not be owned Label Description


This chapter describes various processes of CLG, and how to extend those processes.

Apply for License License application process has three steps.

1. Capture license information

2. Review License

3. Inspection & Supervision

Apply for license process captures the applicant information (applicant can be of a constituent or a business entity), product information, supplements (if required any), expertise (if required any), documents (if required any) and payment information. This process does not show all the available products in the system rather it runs some eligibility rules behind the scenes and shows only the relevant products to the applicant. With the capture process, applicant can add new supplements or he/she can select the existing supplements. Every product does not need Supplements or Documents.

CLG supports two modes of payment such as Single Payment and Multiple Payment. It is system specific configuration but not license specific. One implementation/application can support only one mode. To know how to configure it, refer Global Settings section.

On successful payment, it creates license work items for each product. If applicant applies for Product A (2 Qty), Product B (3 Qty), then the system will generate 5 license work items, 2 for Product A and 3 for Product B. Each license is having a unique number. There after Review and Inspection processes will be continued on individual license work items.

For issuance of license (only for the licenses which need inspection), both Inspector and Supervisor have to approve it. Supervisor validates inspector’s inspection, hence the license will not be rejected though the supervisor rejects it. License will be rejected only when inspector rejects it.

How to add a new product (License) 1. Data Tables chapter explains Product data table in detail.

2. Decide how many variants the Product may have. CLG treats each variant as a flavor. If the Product has different variants, check whether all those flavors are available in the system. Add all the missing flavors to the system. To add a new flavor, create a Field Value rule with FlavorType as the field name, and it’s Applies To class should be PegaPS-FW-LCFFW-Data-Product.

3. Open the Product data table, add entries to it. Configure all flavors of the products in this table. Add separate entries for each flavor. Every flavor should have a different Product ID. If the product has no variants then select None as the flavor type.

5 Processes and Extensions



How to update eligibility criteria of a product 1. Update the EligibleProducts decision table with the new Products. It takes in to account the

applicant type, Age of applicant, whether the applicant belongs to Military and State of the applicant. Columns can be added or deleted from the criteria. Add the required entries for new products here.

2. For all the new columns to be added in the decision table, update the inputs in the parameters tab.

3. Update the SetParametersForEligibility data transform of ApplyLicense work type. This data transform is responsible in setting the parameters to the decision table.

4. SetEligibleProductIDs activity of ApplyLicense work type uses this eligibility rule and prepares the comma separated values of Product IDs, which is useful in getting the products information. For all complex eligibility checks, this activity can be extended.

How to configure product dependencies 1. Refer Data Tables chapter for details on Product dependencies data table.

2. Update the Product Dependencies data table. Say, if a Product is dependent on two other products, and then add two entries in this data table, with the respective Product IDs.

3. ValidateDependentProducts activity of the ApplyLicense work type checks the dependencies.

How to configure product disclosure

Disclosures and Product and Disclosure Association data tables are explained in detail in Data Tables chapter.

1. For showing product related information to the user, add a record /notes in the Disclosures data table.



2. Associate all the notes in Product Disclosure data table.

How to configure supplement preferences of a product Supplement Preferences data table is explained in detail in Data Tables chapter. Currently CLG supports three supplement types, and those are Vehicles, Vessels and Facilities.

1. Add the required supplements entries in Supplement Preferences data table. Say, ProductA requires either Vessel (Owned) or Vehicle (Owned/Rented) information. Then two records needs to be added in to the supplement preferences table.

2. Update the product table by changing respective product record’s Additional Info Required column from False to True.

3. IsProductNeedSupplements when rule of product data class determines whether that product requires any supplements or not. That can be updated if additional conditions required.

How to extend supplements In order to create one more supplement which behaves similar to existing supplement types (vehicles, vessels, and facilities) follow the steps below

1. Create a data class by inheriting PegaGov-Data-Supplement.

2. Create required properties.

3. Create a section with all the properties to capture new supplement details.

4. Create a validation rule.

5. Create an activity to save supplement information.

6. Create a data page to fetch the existing supplements (of new type) of the selected entity.

Steps to be done under PegaGov-Data-SupplementInfo class or its subclass if any,

7. Create one page list, and one page property of the newly created supplement type.

8. Create a flow action to show the existing supplements.

9. Create a data transform to fetch the existing supplements of the specific entity. This should be used as a pre data transform of the above flow action.

10. Create a data transform to add the selected supplements to the list. This should be used as post data transform of the above flow action. All the selected supplements should be stored in the page list which is created in the first step in this class.

11. Create a flow action to add new supplement, refer the section which is created data class of the supplement.

12. Create a validate rule and call the validate rule from the data class of the supplement. This validate rule should be configured on the add supplement flow action.

13. Create one activity to manage the newly added supplement. This should be used as post flow action of the add supplement flow action.



14. Create a section rule which should have two buttons, and a repeating grid. One button should be configured to open a modal window and select the existing supplements. And the other button is to open a modal window to capture new supplement details. Repeating grid shows the list of the selected supplements.

15. Update SupplementsInformation with the supplement section which is created just before.

How to add new Document Category Category and Document data tables are explained in detail in Data Tables.

1. Decide how many documents that are required to be added to the system. Categorize them based on the requirement. For example Passport, Driver License and Photo Identification are categorized as Identification Proofs, whereas the Partnership agreement, Registration and Tax certificates can be categorized as Organization Proofs. Once the categories are finalized add them in the Category data table. Category Name should be unique and it should not contain any spaces in the name.

2. Create an Attachment Category rule (Security) for newly added categories. The rule name must be the category name and the Applied to class should be the implementation class group. File option must be checked in Availability tab.

3. Update the Documents data table by adding all the required documents there. If any of the required documents exists for other category, then a new entry for the document needs to be added by giving the required category.

How to configure the documents requirements of a product 1. Product Category Mapping data table is explained in detail in Data Tables chapter.

2. Update the Product Category Map data table with the required document categories for newly added Product. If the required category is not present, add a new category.

How to change the disclosure agreement 1. Disclosure agreement of Apply for License process is getting from the LicenseType data table.



2. There are two important records in this table, one is for constituents (License for Citizen), and the other is for business entity (License for business entity).

3. In order to change the disclosure agreement then either create a paragraph rule in License data class or update the configured paragraph (Disclosure name column has the paragraph rule name).

How to extend Payments 1. CLG supports two payment modes. One is to pay the full amount from one account, and the

other is to pay the total amount together from the multiple accounts. To know more information on how to set the payment mode, refer the Global settings section in this document.

2. There are three important flows for the payments

a. CapturePayments, this flow shows the respective screens to capture the payment details based on the payment mode.

b. SavePaymentOptions, this flow is used to save the accounts information of the applicant.

c. ProcessPayments, this flow is used to process the payment such as posting the transaction to the payment gateway(s).

3. As mentioned above, if payment screens to be extended / updated then use the flow actions in the CapturePayments flow.

4. SinglePayment and MultiplePayments activities are extension points to perform web service calls to payment gateways. These two activities are responsible to set the transaction(s) status.

How to update review logic of license application IsReviewRequired when rule determines whether the license should go through the review step or not. Currently CLG send every license which has some documents goes through the review step. This can be updated to suit the implementation requirements.

How to update routing strategies of license 1. Whenever an applicant applies for a license, the application is sent for review, if the license

type requires a review, update the RouteToReview decision table for routing the work items to implementation specific work baskets.

2. When a Reviewer Pends a work item, it is routed to the Pending work basket. Update the RouteToPend (PegaPS-FW-LCFFW-Work-License) decision table for routing the work item to implementation specific work baskets.

3. If license is configured to go through the Inspection process, then such licenses will be routed to Inspection work queue. Update the RouteToInpspection (PegaPS-FW-LCFFW-Work-License) decision table for routing work items to implementation specific work baskets.

If license is configured to go through the Inspection process, on successful inspection such licenses will be routed to supervisor. Update the RouteToSupervisor (PegaPS-FW-LCFFW-Work-License) decision table for routing work items to implementation specific supervisors.



How to extend entity home pages 1. PegaGov-Data-CitizenInformation and PegaGov-Data-BusinessEntity are the data classes

which represent entities. These two classes directly inherited from PegaGov-Data-Applicant.

2. ApplicantHome is a section rule which is available in all three classes. Logically we can divide contents of these sections in to two parts. One is header, and the other is information.

3. ApplicantDetails is the section treated as header, and it has entity details, and the menu options to initiate the processes.

4. To change anything related to Tabs, update ApplicantDetails rule.

5. To add a new column, or update an existing column of licenses, change the below the section rules, [Update LicenseNumber link with the appropriate class].

Section Name Applies To

AppInActiveLicense PegaGov-Data-CitizenInformaiton

AppPendingLicense PegaGov-Data-CitizenInformaiton

AppWithdrawnLicense PegaGov-Data-CitizenInformaiton

AppLicenseCaseStatus PegaGov-Data-CitizenInformaiton

AppActiveLicenses PegaGov-Data-CitizenInformaiton

AppInActiveLicense PegaGov-Data-BusinessEntity

AppPendingLicense PegaGov-Data-BusinessEntity

AppWithdrawnLicense PegaGov-Data-BusinessEntity

AppLicenseCaseStatus PegaGov-Data-BusinessEntity

AppActiveLicenses PegaGov-Data-BusinessEntity

How to update the email contents Below are the email correspondences used in the license application process, the content of these rules can be updated by saving them in to implementation specific rulesets (applies to class should be respective implementation class).

Name Applies To Purpose

ReAssignCorr PegaPS-FW-LCFFW-Work-ApplyLicense

Used when an operator reassigns to another operator.

RequestCorrespondense PegaPS-FW-LCFFW-Work-ApplyLicense

Used to send the acknowledgement letter for applicant.

ReviewRejectCorrespondense PegaPS-FW-LCFFW-Work-ApplyLicense

When Reviewer rejects the license request of an applicant.

ReviewApprovalCorrespondense PegaPS-FW-LCFFW-Work-ApplyLicense

When Reviewer approves the license request of an applicant.



How to update the paragraphs Name Applies To Purpose RequestAckForPDF PegaPS-FW-LCFFW-Work-

ApplyLicense Acknowledgement of the application.

RejectLicensePDF PegaPS-FW-LCFFW-Work-License

This is used when reviewer reject the license, PDF is generated containing the info about reject reason and comments.

Reprint License License holders can reprint any of the licenses/certificates which they are holding. This option is available from self-service portal and case manager portals. If the applicant reaches to case worker to get print of his license, then it will be charged. No charges applicable if he prints it from his self-service portal.

How to update the payment configuration IsPymentNeeded when rule decides whether the payment is required or not. Save as this rule in to implementation rulesets to update the payment logic of Reprint work type.

Void License Manager can void any of the licenses. For certain reasons of voiding a license, amount will be refunded. The percentage of refund amount is configurable. When a license gets voided, license holder will get an email.

How to update the email contents Below is the email correspondence, the content of this rule can be updated by saving them in to implementation specific rulesets (applies to class should be respective implementation class).


VoidLicense PegaPS-FW-LCFFW-Work-License-Void Notification after voiding the licenses.

How to update the paragraphs Name Applies To Purpose ShowRefundAmount PegaPS-FW-LCFFW-Work-

License-Void It is referred in Void license correspondence rule. It contains the information on void licenses

Upgrade License Licenses can be upgraded from one to another. Only the licenses which are in compliance are eligible for the upgrade. Possible upgrades are configurable. Refer Data Tables chapter for more information on this.



How to update the paragraphs Name Applies To Purpose

UpgradeLicenseInfo PegaPS-FW-LCFFW-Work-License-Upgrade

It is referred in Section and Correspondence. After Upgrade license process this pdf is generated containing the info about license.

ShowAvbailedLicenses PegaPS-FW-LCFFW-Work-License-Upgrade

While Upgrading the License, After giving the license details information icon is displayed with availed licenses information.

Update License Applicant can update the information for a particular license. Currently CLG supports only attaching new documents to the existing license. This is helpful in cases where licenses are dependent on documents. During the tenure of license, if applicant gets updated document, then he can attach it to the license.

Renew License License can be renewed which are about to expire. Licenses can be renewed sometime before the expiry, also until sometime after the expiry. These periods are configurable for each license. Refer data tables section for more information on the configurations. Renewal process is just like apply process, all the information is prepopulated in Renew process. Applicant can change the supplements, and upload the new documents if needed. On successful renewal the license number is carried over to the newly created license. Renewed license will be active only once the parent license gets expired.

How to update the paragraphs Name Applies To Purpose

RenewDisclosure PegaPS-FW-LCFFW-Work-License-Renew

While renewing the license it is populated as Disclosure agreement.

How to update the expertise check Name Applies To Purpose

IsExpertiseRequired PegaPS-FW-LCFFW-Work-License-Renew

To check if any of the selected licenses require expertise details for the selected licenses

Compliance Report Some license types expect regular updates from the license holders. CLG supports two kinds of reports such as Catch Activity and Negative Reports. For example, fishing license holder has to submit the details of fishing every month. License holder has to enter the information like when did he went for fishing, what kind of fishes he catch, how many fishes he catch and etc. He has to submit Catch Activity reports for the time he went for fishing. He has to submit Negative Reports for the time license holder does not go for fishing. If a license requires reports then the license holder has to submit reports regularly without fail.



How to configure a product for reporting In the Product data table (explained in Data Tables) Reporting frequency type column has to be updated with required period.

How to update the email contents Below is the email correspondence, the content of this rule can be updated by saving them in to implementation specific rulesets (applies to class should be respective implementation class).


RejectedCompliance PegaPS-FW-LCFFW-Work-License-ReportSummary

When a report entry is rejected, license holder will be intimated.

Notify Non Compliance (Mass Mailing) This process gives a provision to Manager to identify how many licenses are non-compliant in the selected time frame. With this process, Manager can send email to every applicant who has non-compliant licenses (which are active). It sends consolidated email to each applicant. If an applicant has multiple non-compliant licenses of different types, then he gets one email listed with all the relevant licenses. Addition to that the application attaches non-compliance notice to each identified license.

How to update the email contents Below is a list of email correspondence rules, the content of this rule can be updated by saving them into implementation specific rulesets (applies to class should be respective implementation class).


NonCompliance PegaPS-FW-LCFFW-Work-License Notification of non-complaint licenses.

How to update the paragraphs Name Applies To Purpose NonCompliance PegaPS-FW-LCFFW-Work-License To inform the license is out of compliance

Enter/Issue Warning Patrol Officer issues warnings for license holders referring a license at times so that he can enforce law and have a record in the system for future use.

How to configure offense title, section and description in warning details screen Offenses by Section or Ordinance data table (explained in Data Tables chapter) holds section and offense description columns and changes in these columns will be reflected on the warning details screen.



Update/Void Warning Enforcement Officer has a provision to update an already entered Warnings (not to change the personal profile name) and at times able to Void/Cancel the Warning and status it as Cancelled so that any amendments to the Warnings are recorded accurately.

Patrol Officer can enter summons for a business entity or citizen profile referring a license at times so that he can enforce law and have a record in the system for future use. One officer can enter the summons and send it to another officer and he can update and finally submit the summons.

Summons can be in stages of

Entry

Adjudication - Administrative and/or Courts actions

Suspension

Reinstate

Reviews and court adjudication can happen simultaneously. Every suspension entered y Officer might not turn in to suspension.

Cancel Summon Enforcement Officer can void/cancel the summons which are not suspended and status it as Cancelled so that all downstream process are cancelled for this summons.

Suspend License (Manual)

Suspension Admin should be able to launch a Manual Suspension process from Citizen/Business Entity home page and provide suspension details so that system can find all Licenses, dependent licenses, license family flags, Profile RTO flag to be suspended and mark as suspended immediately or wait for hearing based on the type of suspension.



CLG supports three types of Manual Suspensions such as DHHS, Tax and Compliance.

How to update the paragraphs Name Applies To Purpose BusinessDetailsFromSummon PegaPS-FW-

LCFFW-Work-Violation

This is used to populate the Citizen Name and address details in the Suspension letter PDF and Correspondence of CourtAdjudication

BusinessEntity PegaPS-FW-LCFFW-Work-Violation

This is referred in many other paragraphs(Suspension) and Correspondence for populating the Business Entity details like Name and Address

BusinessEntityDetails PegaPS-FW-LCFFW-Work-Violation

This is refereed in Suspend License (Court, DHHS, Tax) for populating the Business Entity name and Address info

ComplianceSuspension PegaPS-FW-LCFFW-Work-Violation

It is used in Suspend License for generating Compliance Suspension PDF

Constituent PegaPS-FW-LCFFW-Work-Violation

This is referred in Many other paragraphs (Suspension) and Correspondence for populating the Constitute info like Name and Address

ConstituentDetails PegaPS-FW-LCFFW-Work-Violation

This is refereed in Suspend License (Court, DHHS, Tax) for populating the Constitute Details like name and Address info

PostSuspensionResult PegaPS-FW-LCFFW-Work-Violation

It is used in PostSuspensionHearingReviewSubProcess

PreSuspensionHearingDate PegaPS-FW-LCFFW-Work-Violation

It is used in PerSuspensionHearingFlow to send Email about Hearing

SignatureForAllLetters PegaPS-FW-LCFFW-Work-Violation

It is used in Many Correspondence and PDFs for Appending the Signature

SuspensionCourt PegaPS-FW-LCFFW-Work-Violation

when the suspension type is selected as Court while suspending a license it generates the pdf using this Paragraph rule

SuspensionDHHS PegaPS-FW-LCFFW-Work-Violation

When the suspension type is selected as DHHS while suspending a license it generates the pdf using this Paragraph rule

How to update email contents Below are the email correspondence, the content of these rules can be updated by saving them in to implementation specific rulesets (applies to class should be respective implementation class).




PostSuspensionHearingDate PegaPS-FW-LCFFW-Work-Violation Used in suspension process PostSuspensionResult PegaPS-FW-LCFFW-Work-Violation Used in suspension process PreSuspensionHearingDate PegaPS-FW-LCFFW-Work-Violation Used in suspension process SuspensionAdmin PegaPS-FW-LCFFW-Work-Violation Used in suspension process SuspensionCourt PegaPS-FW-LCFFW-Work-Violation Used in suspension process SuspensionDHHS PegaPS-FW-LCFFW-Work-Violation Used in suspension process SuspensionHearingOverturned PegaPS-FW-LCFFW-Work-Violation Used in suspension process SuspensionHearingUpheld PegaPS-FW-LCFFW-Work-Violation Used in suspension process SuspensionMandatoryAndIP PegaPS-FW-LCFFW-Work-Violation Used in suspension process SuspensionScheduledHearingDate PegaPS-FW-LCFFW-Work-Violation Used in suspension process

How to update routing strategies for Hearing Compliance suspension is routed to HearingOpportunityEntry work basket; this can be changed to other work queue by updating the Decision Table rule RouteToHearingOpportunityWB.

How to update routing strategies for Hearing review

Then In review step HearingReviewWB can be changed by updating the Decision Table RouteToHearingReviewWB.

Update Suspension

Enforcement Officer is able to view all the summons information, including personal info, summons details, documents uploaded, and all previous reviewers’ recommendations and be able to update the summons details including all properties and upload new case reports.

How to change content of PDF The content can be changed by adding a paragraph rule in the RevokedLicenses section rule (of PegaPS-FW-LCFFW-Work-Violation class), this presently have a grid which consists of revoke licenses.

Miscellaneous Payment Citizen/business entity can make a miscellaneous payment against any outstanding fees they owe so that it gets recorded towards any outstanding fees he might have for the agencies.



An outstanding fee is a cause of Suspension fees, Summons - basically it could be one to many for a profile.

How to update email content Below is the email correspondence, the content of this rule can be updated by saving them in to implementation specific rulesets (applies to class should be respective implementation class).


MiscellaneousPayment PegaPS-FW-LCFFW-Work-Violation-MiscellaneousPayment Used in enforcement process.

Apply Course Credit This functionality allows the constituent to apply the credits to his/her profile. This can be done from the citizen profile page.

The user can enter the course id and the course date to get the course credits.

The process validates the entered course details.

If the entered course details are valid then course credits are added to the profile.

Add Course Attendance This functionality allows the course conducting authority to upload the list of attendees who have attended a course. The caseworker can filter the courses with dates and select a course to upload the attendance list. The user can upload one or more documents.

New Course Request This process gives a provision to institutions to conduct a new course. All the requests must have the details like course provider, course title, date, location agenda and the contact person. New course requests would go through review process. Reviewers can either approve or reject the request. While approving the request, reviewers can apply the applicable credits for the course. This allows the attendees to apply and gain credits.

How to update email contents Below are the email correspondences, the content of those rules can be updated by saving them in to implementation specific rulesets (applies to class should be respective implementation class).


NewCourseAcknowledgement PegaPS-FW-LCFFW-Work-Course

Used when new course request is made by an applicant




NewCourseApproved PegaPS-FW-LCFFW-Work-Course

Used when new course request of applicant is approved

NewCourseRejected PegaPS-FW-LCFFW-Work-Course

Used when new course request of applicant is rejected

Score Exam CLG provides a process for exam administrators to score the conducted exam. Exam administrators need to enter the marks obtained by the attendee, and then based on the minimum pass score, the result of the exam decided as either Pass or Fail.

How to update email contents Below are the email correspondences, the content of those rules can be updated by saving them in to implementation specific rulesets (applies to class should be respective implementation class).


ExamPassMail PegaPS-FW-LCFFW-Work-Exam-ScoreExam

Sent to applicant when he/she passes exam

ExamFailMail PegaPS-FW-LCFFW-Work-Exam-ScoreExam

Sent to applicant when he/she fails exam

Apply for Exam CLG provides a process with which the end users can apply for an exam .Apply for exams process shows the eligible qualification types and eligible exams for the selected qualification. Applicants should select the affiliation type and the location where they are interested to attend the exams. Based on the affiliation type applicants would get fee waiver (either partial or full). Fee waived applications would go through the review process. If there is a payment required then the applicant is taken to payment screen.

Based on the affiliation type, the application is sent for review. The applications that need to be reviewed are sent to ReviewExamFeeWaiver work basket. A CLFExamReviewer approves or rejects an exam application. The process also displays the pending exams and completed exams list.

How to update fee waiver percentage WaiverPercent decision table decides the waived percent based on the affiliation type. Save as the WaiverPercent decision rule of PegaPS-FW-LCFFW-Work-Exam-Apply class to the implementation ruleset, and update accordingly.



How to update eligibility criteria for qualifications Save as the EligibleQualifications decision rule of PegaPS-FW-LCFFW-Work-Exam-Apply class to the implementation ruleset, and update accordingly.

How to update routing strategy of exam applications If an applicant is eligible for fee waiver the work item is routed to ReviewExamFeeWaiver work basket. Update the RouteWhenFeeWaiver decision table for routing the work item to implementation specific work baskets.

How to update the email contents Below are the email correspondences, the content of those rules can be updated by saving them in to implementation specific rulesets (applies to class should be respective implementation class).

Name Applies To Purpose ExamAppliedSuccessfuly PegaPS-FW-LCFFW-Work-Exam-Apply Sent to applicant when he/she applies for exam PendingExam PegaPS-FW-LCFFW-Work-Exam-Apply Sent to applicant when application is sent for review AcceptExam PegaPS-FW-LCFFW-Work-Exam-Apply Sent to applicant when application for exam is accepted RejectExam PegaPS-FW-LCFFW-Work-Exam-Apply Sent to applicant when application for exam is rejected

Create Exam Schedule CLG provide a process with which exam administrators can schedule exams. Only scheduled exams can be applied by the applicants. To create a new exam schedule, exam admins need to provide the information like exam type, location, Number of seats, date, start time and end time.

Manage Exam Schedule CLG provides a mechanism for exam admins to track the scheduled exams (Active exams), completed exams and pending exams. Active exams can be cancelled with this process.

View Roster Exam reviewers could see the list of applicants of a particular exam in the current roster.


Portals CLG has custom portals for the supported actors. These portals can be associated to the implementation access groups.

Below is the list of operators, access groups and associated portals

Operator Access Group Portal

CLFCaseWorker PegaCLF:Caseworker CaseWorker

CLFHearingAdmin PegaCLF:HearingAdmin EnforcementOfficer

CLFHearingOfficer PegaCLF:HearingOfficer EnforcementOfficer

CLFHQAdminA PegaCLF:HQAdmin EnforcementOfficer

CLFHQReviewer PegaCLF:HQReviewer EnforcementOfficer

CLFInspector PegaCLF:Inspector Inspector

CLFManager PegaCLF:Manager Manager

CLFPatrolOfficer PegaCLF:PatrolOfficer EnforcementOfficer

CLFSergeant PegaCLF:Sergeant EnforcementOfficer

CLFSupervisor PegaCLF:Supervisor Supervisor

CLFSuspensionAdmin PegaCLF:SuspensionAdmin EnforcementOfficer

CLFCourtAdmin PegaCLF:CourtAdmin EnforcementOfficer

MPENELOPE (any end user) PegaCLF:User EndUser7

Dashboard customization Personalization of the dashboard feature is enabled for most of the CLG access groups. By Default, CLG provides the customized dashboards for case worker and managers. Case worker and manager dashboards are presented with the License and Enforcement specific charts. Based on the need, implementations can update the dashboard for these portals.

6 Portals and Dashboards



To know the details on How to update the default widgets of a portal, Refer PFG Implementation guide.

There are four widgets available in CLG, and those can be used to be shown in the dashboards. Those are Active licenses by category, Licenses revenue by category, Violation type and suspension history. In addition to these, CLG can use the widgets from PFG as well. For information on PFG supporting widgets refer the PFG Implementation guide.

End user portal CLG provides an extensive end user portal, from where constituents could initiate several actions. For the constituent who involves in the businesses, they can switch between their personal profile and the business profiles. They can perform various actions on behalf of businesses.



Implementations can take the advantage by configuring EndUser7 portal to the implementation specific access group(s).

End user portal has three parts header, footer and main content. Header has the organization name, logo, profile name, Home button, Refresh button, Log off button and My profiles menu to switch the profiles. Footer has copyright information. Main content has four parts and they are Profile information, Action area, Entity information and Recent work.

Profile information widget shows full name, date of birth, SSN, mobile, address, last login time for constituent and legal name, trade name, ownership type, EIN, contact person, address, and last login time for business entity.

Action area is categorized in to five parts.

1. License

2. Exams & Education

3. Compliance

4. Government services.

5. Personal details for constituent, Actions for business.

Entity information area shows the information in tabs. It shows the tabs like licenses, violations, associated businesses, complaints filed and communication details for constituent, and it shows licenses, violations, associates information, branches and communication details for the business entities.



For information on how to extend the end user dashboard refer PFG Implementation guide.


CLG has the following settings at application level. Save As the LoadGlobalSettings data transform to the implementation ruleset, and it should be associated to PegaPS-FW-LCFFW-Data-ApplicationContext. Update this data transform with the required settings.

Below are the details for the available options.

Payment Mode Property Name: PaymentMode

CLG uses payment modes from PFG. There are two variations of payments.

Single Payment – Total Payment can be done from only one account.

Multiple Payments – Total Payment can be done from multiple accounts. Say, to purchase a license the user has to pay 2000$, then he/she can pay 200$ from one account, 300$ from the second account and the remaining from the other account.

PDF Generation mode Property Name: LicensePDFMode

Whenever applicant applies for a license, all approved requests will get certificates (approval letters). CLG generates approval letters at various levels.

For Licenses and Products – When the property is set with this value, then it generates an approval letter for licenses and approval letters for individual products. Quantity of product is not taken in to consideration.

Only for License – CLG generates approval letter only for license.

Product Short Form Property Name: ProductShortForm

Product Number (License number) is unique in nature. Product number starts with product short form. There is a configuration available at Product data table to set the ShortForm of a product. If there is no short form set to any of the product types, then CLG uses the default ShortForm of product, which sets as part of Global Settings.

A Appendix A, Global Settings

Certification and Licensing for Government Implementation Guide A-1


License Print Cost Property Name: LicensePrintCost

This property is used determine the cost of getting the re-print copy of the license from the case worker. It is used in Reprint License process.

Certification and Licensing for Government Implementation Guide A-2