You are on page 1of 66

Product Designer

7.12

IMPLEMENTATION GUIDE

Copyright 2015
Pegasystems Inc., Cambridge, MA
All rights reserved.
This document describes products and services of Pegasystems Inc. It may contain trade secrets and
proprietary information. The document and product are protected by copyright and distributed under licenses
restricting their use, copying, distribution, or transmittal in any form without prior written authorization of
Pegasystems Inc.
This document is current as of the date of publication only. Changes in the document may be made from
time to time at the discretion of Pegasystems. This document remains the property of Pegasystems and
must be returned to it upon request. This document does not imply any commitment to offer or deliver the
products or services provided.
This document may include references to Pegasystems product features that have not been licensed by
your company. If you have questions about whether a particular capability is included in your installation,
please consult your Pegasystems service consultant.
PegaRULES, Process Commander, SmartBPM and the Pegasystems logo are trademarks or registered
trademarks of Pegasystems Inc. All other product names, logos and symbols may be registered trademarks
of their respective owners.
Although Pegasystems Inc. strives for accuracy in its publications, any publication may contain inaccuracies
or typographical errors. This document or Help System could contain technical inaccuracies or
typographical errors. Changes are periodically added to the information herein. Pegasystems Inc. may make
improvements and/or changes in the information described herein at any time.
This document is the property of:
Pegasystems Inc.
1 Rogers Street
Cambridge, MA 02142-1209
Phone: (617) 374-9600
Fax: (617) 374-9620
www.pega.com

Document: Product Designer Implementation Guide


Software Version: 7.12
Updated: June 2015

CONTENTS
About this Document ......................................................................................... i
Intended Audience .......................................................................................... i
Guide Organization ......................................................................................... i
Application Overview ......................................................................................... i
Application Structure, Access Groups, Roles and Operators........................ 2
Application Structure...................................................................................... 2
Operators, Access Groups and Portals

Organizational Structure

Work Object Prefixes

Case Types

Data Pages

Work Classes

Data Classes

Data Tables

Create Products ................................................................................................. 9


Creating Product ............................................................................................ 9
Managing Parties

11

Managing form fields

12

Managing form sections

14

Generating the UI with data models

16

Managing document requirements

23

Managing services

25

Managing product instances

26

Managing processes

27

Landing Page Configurations ......................................................................... 31


Product Designer Configurations ................................................................. 31
Manage Products ........................................................................................ 32
Export products

32

Delete Products

33

Test Flow .......................................................................................................... 34


Test flow ...................................................................................................... 34

Browsing Entities ............................................................................................ 38


Case Manager Left Navigation .................................................................... 38
Dashboard

38

My Worklist

38

Product Categories

39

Products

39

Product Instances

40

Requirements

40

Cases

40

Reports

41

Routing............................................................................................................. 43
Routing Overview ........................................................................................ 43
Work Object

43

Routing Configurations

43

Product Onboarding Case type

45

Product Status during Routing

53

Activation ......................................................................................................... 55
Activation Overview ..................................................................................... 55
Auto-Activation: Activation Agent ................................................................. 56
Application Extensibility ................................................................................. 60
Catalog instance classes ............................................................................. 60

About this Document

Intended Audience
This guide is intended to be used as a reference by:

Business Managers responsible for evaluating the Application and possess a


general, non-technical understanding of its features and capabilities.

Project Managers / Business Analysts responsible for implementing an


Application that can be applied to specific business requirements, and ensure
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 Application
Overview

Provides an overview of the application

Chapter 2 Application
Structure, Access Groups,
Roles and Operators

Describes the application structure and the assets defined in it

Chapter 3 Create Product

Describes the creation of product and its related functionalities

Chapter 4 Landing Page


Configurations

Describes Product designer landing pages

Chapter 5 Test Flow

Describes rules related to Product Designer test flow

Chapter 6 Browsing
Entities

Describes the product designer case manager portal browsing


entities

Chapter 7 Routing

Describes Routing functionality

Product Designer Implementation Guide

Application Overview

Product Designer for Financial Services (PDFS) is an application which accelerates the process
of onboarding new products at Financial Institutions with less effort. This application provides an
intuitive UI that enables product designers to develop the products without having the need of
technical knowledge to build the sections, flow actions, activities etc.
Following are the capabilities that PDFS offers to Product designers to build the new products

Capture data model

Configure form sections

Configure the document requirements

Configure the possible work parties involved.

Create a life cycle process to the product.

Create Product instances with different variations of a product

Send the product for approval

Following are the other capabilities that are provided by PDFS

Easier Browsing of all the Product entities

Configuration of metadata through a landing page

Exporting the selected products to deploy in any other server

Deletion of unwanted products

Product Designer Implementation Guide

Application Structure, Access Groups,


Roles and Operators
Application Structure
The application is built upon a number of application rules. Application rules define an ordered
set of rulesets and versions that together identify the parts of an application layer. In addition,
application rules relate an application's objectives, use cases, requirements, and actors to
cases that are created as part of Pega 7 Direct Capture of Objectives (DCO) capabilities.
You can view a list of the application rules and their rulesets that form the application from the
Designer Studio by selecting DesignerStudio > Application > Structure > RuleSet Stack.
The RuleSet Stack tab displays the high-level ruleset stack for each application rule defined in
the application. Expand an application to list its rulesets.

Product Designer Implementation Guide

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

The Product Designer application name and version is PDFS: 01.01.01. It includes the following
rulesets:

PegaPDFS - Product Designer application processing related rules and logic.

PegaPDFSDemo Product Designer demo application rules and logic.

PegaPDFSProduct: Ruleset which contains the products

PegaFSProduct: Ruleset which contains the catalog definition classes

PegaPDFSSharedAssets Includes rules common across products, such as Customer


context, Line of Business (LoB) or Product Category level.

PegaPDFSIF Rules and logic to be shared with FSIF.

PegaPDFSInt Product Designer integration rules.

The application is built on and inherits rules from PegaFSIF, PegaRequirements and PegaRules
applications. To see the ruleset stack for supporting application layers, click + next to the
application name to expand and display the list of rulesets. The Product Designer is built on
the Financial Services Industry Foundation (FSIF) version 7.14.

Operators, Access Groups and Portals


The Product Designer is installed with a set of operators, access groups and portals. The
password is set to install. These allow you to access the product designer portal to create or
view the products and related rules as well as route through a variety of user roles including
administrator, managers and users.
Select Designer Studio > Org & Security> Organization > Operators to display a list of
operators.

Product Designer Implementation Guide

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Select Designer Studio > Org & Security > Security to display a list of access groups and
access roles.
This table lists the operators, access groups, and their associated portal rule.
Operator ID

Access Group

Portal Rule

ProductDesigner

PDFS:Users

ProductDesignerPortal/Developer

ProductManager

PDFS:Managers

ProductDesignerPortal

ProductDeveloper

PDFS:Administrators

Developer/ ProductDesignerPortal

The product designer (user) can create new products in the desired LoB and product category,
with corresponding data models, cases, instances and requirements and route them to the
developer for further improvements or to the manager for review through the Product Designer
portal.
The manager can find the products routed to their worklist. They can review them and approve
or reject them through Product Designer portal. They can perform all the operations which a
product designer can do.
The Developer has Administrator access and can access both the Developer Portal and
Designer portal.

Organizational Structure
The application has a predefined organization, division, and organizational unit.
Select Designer Studio > Org & Security > Organization > Organizational to display the
organizational structure.

Product Designer Implementation Guide

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Work Object Prefixes


The application creates a cover object and associated work objects. Each has a unique ID that
is computed by combining a system-assigned number and a prefix defined in a data transform
rule pyDefault.
This table lists the prefixes for the work objects and their associated work class.
Prefix
ProductO-

Description
Work object for product onboarding
Work object for onboarding test flow

Applies-to class

Case Types
The product designer is designed using Pegas Case Lifecycle Management (CLM) capabilities.
This is governed by the Cases Explorer, which is used to configure case type dependencies and
related work processing.
The list of cases defined in the product designer can be viewed by clicking the Cases icon on
the left navigation panel of the Designer Studio.

Data Pages
The product designer has a number of data pages that are used to access and manage data.
These are intended to be reusable and extendable assets. To view the data pages that are
defined for an application, select Designer Studio > Data Model > Clipboard Pages > Data
Pages. The Product Designer provides the following data pages:

Product Designer Implementation Guide

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Work Classes
Product Designer classes inherit from PegaPDFS-Work, which has direct inheritance from
PegaFS-Work. PegaPDFS-Work is the work pool for PDFS work classes. The inheritance view
for PegaPDFS-Work class is given below:

Product Designer Implementation Guide

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

PegaPDFS-Work-Product consists of the rules for creation and management of products. It


stores the templates for the product process.
Product Catalog Work classes (PegaPDFS-Work-CI) inherit from PegaPDFS-Work class and
mirror the data class hierarchy as PegaPDFS-Work-CI-<LoB>-<Product Category>-<Product>.
A new class is created for each new case type or process defined on a product PegaPDFSWork-CI-<LoB>-<Product Category>-<Product>-ProductSetup. The case type for that process
will be defined on this new class (as pyDefault). These case types are referred to as Product
Processes.

Data Classes
Catalog Definition classes: These are product designer catalog definition classes for LoBs,
Product categories and products.
Classes
PegaPDFS-Data-CatDef- LOB
PegaPDFS-Data-CatDef- ProdCat
PegaPDFS-Data-CatDef- Product
PegaPDFS-Data-CatDefProductInstance
PegaPDFS-Data-CatDefProductConfiguration
PegaPDFS-Data-CatDefTemplateCaseTypes

Description
Catalog definition class for all lines of business
Catalog definition class for all product categories
Catalog definition class for all products
Catalog definition class for all product instances

Catalog item classes: The catalog item classes (PegaPDFS-Data-CI) have direct inheritance
from the PegaPDFS-Data-CatDef catalog definition class. The structure of CI classes is
PegaPDFS-Data-CI-<LoB>-<Product Category>-<Product>: These are the data classes for
the products created.
PegaPDFS-Data-CI-Entity includes data classes created for new object type properties added in
product creation.

Product Designer Implementation Guide

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

PegaPDFS-Data-PDPortal: This class has direct inheritance from Data-Portal. It provides


hierarchy for rules created to build the product designer portal.

Data Tables
The product Designer contains number of data tables which store data values referenced in the
application.
The table and the sample instances can be viewed and edited by selecting Designer Studio >
Data Model > Data Tables > Data Tables. It provides the following record in the data table in
the PegaPDFS ruleset.

Product Designer Implementation Guide

Create Products

Creating Product
The new product can be onboarded by selecting Create > Onboard Product.

The Onboard Product screen will look like the figure below. Every product belongs to a line of
business and product categories and has a product type (account or service), customer type
(Individual or Organization) and market segment.

With this, certain actions are performed in the background. The product is saved in the
FSP_PRODUCT table with the data defined by the user. The product metadata created
contains the following:

Product ruleset

Product ruleset version

Product work class

Product data class

Product Designer Implementation Guide

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Product ruleset- The product ruleset is defined in the ProductRuleset dynamic system setting
which is in the PegaFSProduct ruleset. The DSS can be updated from Product Designer >
Configurations landing page, which is explained in the Landing page section of this document.
Product Rule-set version Every time a product is created, a new version in the product
ruleset is created for that product. This version consists of rules related to this product only. The
activity used to create this new version is @baseclass.PDFSGetBestProductRuleset. When
the patch fragment for the version is exhausted, an error message is displayed to the user to
create a new version for the application.
Product Work class Product work class inherits from PegaPDFS-Work-Product class and it
has the hierarchy as PegaPDFS-Work-CI-<LoB>-<Product Category>-<Product>.
Product Data class- The product data class inherits from PegaPDFS-Data-CI, which in turn
inherits from PegaPDFS-Data-CatDef and it has the hierarchy as PegaPDFS-Data-CI-<LoB><Product Category>-<Product>.

The product data class and work class are created using the activity PegaPDFS-WorkProduct.CreateProductAssets. All these actions are performed using the activity PegaPDFSWork-Product.SaveProductMetadata.

Product Designer Implementation Guide

10

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Managing Parties
The parties can be added to the product through Actions > Manage party role in the Party
roles section.

The party roles are fetched from the FSF_SAMPLE_ACCTRELCODES table using the
D_ListAllAcctRelCodes data page. At least one role is made mandatory and there may be

Product Designer Implementation Guide

11

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

roles for which the parties can be more than one (for example, there may be more than one coborrower).
The mapping of roles with the product is saved in the FSP_PRODROLEXREF table along with
other details. The PegaPDFS-Work.FSParties work party rule is updated if the role is not
already included and also if the parties may repeat (multiple).
If the product has Organization customer type specified, the party type also needs to be
selected whether it is Individual or Organization. The party type decides the class for the rules
created corresponding to the roles. If it is Individual, the class is PegaFS-Data-Party-Ind. If it is
Organization, the class is PegaFS-Data-Party-Org.

Data Model Management


The data model section in the product work area has two parts: Form fields and Form sections.

Managing form fields


Click Add to add a new form field on the Form field tab in the Data model section.

The form fields are stored in FSP_FORMFIELDS table in the data base with FormFieldID as the
key. The form fields that are mapped to a product are fetched using the D_FormFieldSummary
data page to display in the Form fields tab.
The addition of new form fields requires the following actions to be done:
Form field context: A form field can have either Product or Customer context displayed as the
dropdown. The values are defined in the property only. The Context decides the class of the
property for this for field. For example, if the context is product, the class should be product data
class, or if the context is customer, the class should be data party class.
Also, if the context is customer, the user can select a role. The roles available for selection are
the roles already mapped to this product in the D_ProductRoleSummary data page.
The PegaPDFS-Data-ProductProperty.GroupClassMapping map value rule is used to get
the class name. It is a 2-D map value with Context and Party type as inputs which returns the
Product Designer Implementation Guide

12

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

class name. The party type is decided based on the role selected for the form field. The
PegaPDFS-Data-ProductProperty.UpdateClassName activity is used to read the class name
from the given map-value rule.
Map to property: This auto-populate search field displays the list of properties for the given
class using the D_FSPPropertiesForClass data page. The selection of property runs the
PegaPDFS-Data-ProductProperty.SetEmbedFieldDetails activity which in turn applies the
Embed-Fields.pzResetTypeFromAutoComplete data transform and calls the EmbedFields.FSPHandlePropertyChange activity to fetch and populate the property data.
The form field addition uses the PropertyList of class PegaPDFS-Data-ProductProperty
clipboard page list. The class has an embedded page, FormField, of type Embed-Fields, which
is populated with the selected property data. This page is used for the creation of property and
user interface.
Create New Property: Click the Create New Property link to open an overlay to capture new
property details. The class of the new property depends on the context selected as explained
below and the customer context is read-only. However, if the context is Product, the user is
given option to select LoB, product category or product level, and corresponding class is set
based on the selection using the Embed-Fields.SetClassHierarchy data transform.
The property type dropdown uses the D_PDFSListOfPropertyTypes data page. If you select
the Object or Object list property type, the embedded properties of that complex property are
mapped using the pySubFields property of the Embed-Fields class. The user can select the
sub-fields to map to the form fields, so that only those sub-fields will be included in the UI. The
SUBFIELDS column in the FSP_FORMFIELDS table is updated with the list of selected subfields in a comma separated string.
For radio or drop down property types, the choices are captured using the Embed-Fields.
FSPConfigureRadioDropdownOptions flow action. The pyDropdownList property is used for
choices captured and the propertys prompt values are updated for the same, while creating the
new property.
Click Save to create a new property, the PegaPDFS-Data-ProductProperty.CreateProperty
activity is run to create a new property using the Embed-Fields.FSPGenerateProperty activity.
The ruleset of the new property is decided using the PDFSGetBestRulesetName data transform
It is defined below:

If the context of the form field is Customer, the ruleset of the new property is the
Shared assets ruleset, which is defined in the dynamic system settings under
SharedAssetsRulesetName.

If the Context is Product, but the applies to class for the property is not the product
data class, but some other class in the hierarchy, the ruleset of the new property is the
Shared assets ruleset, which is defined in the dynamic system settings under
SharedAssetsRulesetName.

Product Designer Implementation Guide

13

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Otherwise, the ruleset is the same as the product ruleset and the property will be
created in the product ruleset only.

For object type properties, the user can select an existing data class or a new data class. The
data class is created using the Embed-Fields.FSPCreateDataClass activity. The ruleset for the
newly created data class is always the shared assets ruleset.
Default Values: The default value for a form field of Product context is captured in the table,
which is displayed on the UI. These default values are updated in the FSP_FORMFIELDS table.
When the property is marked as Variable, the PreprocessingForProductInstance activity calls
PegaPDFS-Data-PDPortal.CreatepyDeafultDynamically to create a pyDefault data transform
with default values.
Variable: For the form fields with Product context, a check box is displayed with a Variable?
label. This is mapped to the property PegaPDFS-DataProductProperty.MarkForInstantiation. If this property is set to true for any form field, this
field will be displayed when you create a new product instance. The instances can have different
default values for this property.
The PegaFS-Data-PDPortal.ValidateFormField validate rule is used to validate the form field
data before persisting it in the database. Also, the PegaFS-Data-PDPortal.PersistFormField
activity is called when saving the list of form fields.
Deleting form fields: Form field deletion requires the deletion of form field mapping to form the
section. This explained more in the next section. The PegaPDFS-DataProductProperty.DeleteFormField activity deletes the record from the FSP_FORMFIELD and
FSP_FORMFIELDSECTIONXREF tables in the database.

Managing form sections


You can add a new Form section by clicking Actions > Add form section on the Form
Sections tab.

Product Designer Implementation Guide

14

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

The form sections created as above are stored in the FSP_PROPERTYGROUP database table.
The form section has a name, context (product or customer) and roles if the context is customer.
Unlike form fields, a form section can be mapped with multiple roles using data page
D_ProductRoleSummaryForParty. The data transform PegaPDFS-DataPropertyGroup.SaveCustomerRoles is called in the background to map customer roles with
the form sections.
Mapping form fields to form section

For mapping the form field with form section, the list of form fields is fetched using
D_FormFieldSummary data page and displayed in an auto-populate control. The mapping is
done by the PegaPDFS-Data-PDPortal.AddToSelectedFormFields data transform, which
updates the form section data with the selected form fields.
The form section is persisted in the database using the PegaPDFS-DataPDPortal.SaveFormSection activity. This activity updates the following database tables:

FSP_PROPERTYGROUP for the new form section using the D_PropertyGroupSummary


data page.

FSP_FORMFIELDSECTIONXREF for mapping of the form section with form fields using the
D_FormFieldSummaryByGroupId data page.

The deletion of form section will also update both of these database tables using the
PegaPDFS-Data-PropertyGroup.DeleteFormSection activity.

Product Designer Implementation Guide

15

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Generating the UI with data models


The UI is generated on click of Actions > Generate UI menu item on Form sections tab.

This action creates the following assets in the background:

Rule-HTML-Section rules for all form sections

Rule-Obj-FlowAction rules for all form sections

Rule-Obj-Flow for product setup flow

The main activity called for this action is PegaPDFS-Data-PDPortal.CreateSectionsFlowActions.

This activity iterates through the D_PropertyGroupSummary data page for form sections
mapped to the product and D_FormFieldsSummaryByGroupId for form fields mapped to each
form section.

Product Designer Implementation Guide

16

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Creating Rule-HTML-Section rules


Every form section of the product has a section rule generated for it. The creation of a Section
rule requires a section name, class name, ruleset, ruleset version, and so on, which are
described below:

Section name The section name is the same as the Form section name saved in
FSP_PROPERTYGROUP table.

Section class name The class of the section is based on the context of the form section.
The Map value rule PegaPDFS-Data-PropertyGroup.GroupClassMapping is used to fetch
the class name with GroupContext and SelectedPartyType as inputs. If the context is
Product, the class for the section created is Product data class. If the context is Customer
and party type is Individual, the class is PegaFS-Data-Party-Ind and if the party type is
Organization, the class is PegaFS-Data-Party-Org. The PegaPDFS-DataPropertyGroup.UpdateClassName activity gets the class name from this map value rule.

Section ruleset name The ruleset for the section is given by the
@baseclass.PDFSGetBestRulesetName data transform as explained in previous section.

Section ruleset version If the ruleset is a shared assets ruleset, the version is obtained
using the pxChooseBestRuleSetVersion API. If the ruleset is a product ruleset, the version
is the same as the product ruleset version.

Clipboard page for section


The FlowActionSection clipboard page of the Rule-HTML-Section class is used for the section
creation. The Work-.FSPFieldsModalPreProcessing activity performs the pre-processing actions
using the Rule-HTML-Section.FSPFieldsModalLoadSection activity which includes getting the
section template using pzCopyDCOTemplateSection activity.
Updating pyEmbeddedFields of FlowActionSection
The form fields list in copied into the pyEmbeddedFields page list property of the
FlowActionSection page. The activity Embed-Fields.FSPHandlePropertyChange is called for
each item in this list to populate the property data such as type, HTML control, subfields, and so
on.
The @baseclass.FSPFieldsModalPostProcessing and Rule-HTML-Section.
FSPFieldsModalRulesGeneration activities create the rules for the form section.
The Rule-HTML-Section.FSPCreatePrototypeSection activity creates the section rule using the
FlowActionSection page and pyEmbeddedFields page list property. It creates an embedded
section for page, page list and page group properties. The page or page group properties have
an embedded section with a dynamic layout and page list property has an embedded section
with a repeat grid.
The labels of the fields are updated with the FormFieldName property of the form fields.

Product Designer Implementation Guide

17

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Form field with different context The form section can include form fields of different context if the
form field context is not the same as the form section context. In that case, the class of the form field
and form section will be different. To handle this, the FSPCreatePrototypeSectionInner activity is
updated to give the property name of the field with the entire page context. For example, the section of
product context includes the form field for Customer Name using PegaFS-Data-Party.FullName. The
pyPropertyName will include pyWorkPage.pyWorkParty(Cus).FullName.
Managing repeatable parties
If the party role selected for the form section is repeatable, an outer section with dynamic repeat tabs is
created with the RepeatableParties list as the source. The PegaPDFS-WorkProduct.CreateTabbedSectionDynamically activity handles it in background. The tabs have a section
include for the inner section. The following templates are used for the tabbed sections:

TabbedTemplateForInd

TabbedTemplateForOrg

Product Designer Implementation Guide

18

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Tabbed section name The name of the tabbed section is created by prefixing the inner
section name with Tabbed.

Tabbed section class The tabbed section is created in the product work class.

Tabbed section ruleset and version The ruleset and version are the same as the product
ruleset and version.

Creating Rule-Obj-FlowAction rules


Every form section has a corresponding flow action generated for it. After section rule creation, the
Rule-HTML-Section.FSPFieldsModalRulesGeneration activity calls the Rule-HTMLFlowAction.FSPCreatePrototypeFlowAction activity to create the flow action and include the section in
it.

Product Designer Implementation Guide

19

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

The flow actions are created with the following configurations:

Flow action name The flow action name is the same as the form section name.

Flow action class The flow actions are created in the product work class. The product work
class is updated in the property on the pyWorkPage.ProductDetails.ProductWorkClass
page.

Flow action rule set and version The flow action ruleset and version is the same as the
product ruleset and version which is obtained from RuleSet and RuleSetVersion properties
in pyWorkPage.ProductDetails.

Section reference There are two scenarios for sections referenced in the flow action:

Tabbed section reference If the section reference is for a tabbed section, the
sections applies-to class is the same as the flow action Product work class.

Main section reference If there is no repeatable party, the tabbed section does not
exist and the section to be referenced is the main section which has an applies-to
class of either Product data class or party data class. In this case, the following
properties also need to be set for the flow action:

Embed-Harness-Section.pyPageContext This is set to Clipboard, as the


clipboard page is used for reference.

Embed-Harness-Section.pyPromptClass The prompt class depends on the


context of the form section. If the section reference is from the product data
class, the prompt class would be product data class, else if section reference
is from party data class, the prompt class would be party data class.

Embed-Harness-SectionBody.pyUsingPage This holds the clipboard page


name for the section reference. It is pyWorkPage.pyWorkParty() for party
data class and pyWorkPage.ProductDetails for product data class. The

Product Designer Implementation Guide

20

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

subscript for pyWorkParty page group is set with Role defined on form
section.

Pre-processing activity If the form section includes some repeatable parties, the
tabbed section is created. For this, the repeatable parties need to be identified
dynamically at run time. To handle this, a pre-processing activity is included in the flow
action, which is also created during rule generation using the PegaPDFS-DataPropertyGroup.GenerateDynamicActivity activity.

Pre-processing activity name It has PRP prefixed to the form section name, for
example, PRPAccountInformation if the form section name is AccountInformation.

Activity class The activity is created in the product work class.

Ruleset and version The ruleset and version for this activity is the same as those of
product.

Creating Rule-Obj-Flow rule


The UI generation also includes the account set-up flow generation which consumes the flow actions
and sections created as explained above. The flow generated is a screen flow with tree navigation. The
activity responsible for this screen flow generation is PegaPDFS-Data-PDPortal.CreateScreenFlows.

Product Designer Implementation Guide

21

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

The flow has the following configurations:

Flow name The name of the flow is AccountSetup.

Flow class The account setup flow is created in the Product work class.

Flow ruleset and version The account setup flow is created in the product ruleset with only
the product ruleset version.

There is one AccountSetup flow generated for a product. The flow includes all the flow actions
created for the product as assignments, which goes as a screen flow at run time. The
AccountSetup flow generation consumes a flow template which is present at PegaPDFS-WorkProduct.AccountSetup.

Product Designer Implementation Guide

22

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

The API Rule-Obj-Flow.ValidateModelProcess is used to validate the created screen flow.


Regenerating UI
The rules included in UI generation such as sections, flow actions, activities and flow are regenerated
when you select Action > Generate UI multiple times. The logic for the regeneration of rules is
implemented as below:

The rule in a particular class is opened using the Obj-Browse method to check if the rule
already exists.

The ruleset for the existing rule is checked to see whether it is locked using Rule-RuleSetVersion. pzIsLockedRSV API rule.

If the existing rule is in a locked ruleset, the new rule is created in the highest unlocked
version.

If the existing rule is in an unlocked version, it is deleted and the new rule is created in the
same version.

If the rule does not exist, it is created in the open version of the ruleset.

Managing document requirements


The Requirements section in the Product work area displays the list of requirement documents mapped
to the product. It uses the D_RequirementsSummaryByAppliesToClass data page which gets the
requirement rules of the Rule-Requirement class to apply to Product class, product category class or
LoB class. In this section, requirement rules within a product work applies-to class are displayed using
the D_GetRequirementSetListForClass and D_GetRequirementSetDetails data pages.
To add a new requirement, click Add+ in Requirements section. This displays all the requirement rules
with details such as name, description, class, ruleset and version. The user can select one or more
requirements from this window and map to the product.

Product Designer Implementation Guide

23

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

The Rule-RequirementSet.CreateDynamicRequirementSet activity is run in the background to map the


requirements with the product, which creates a new requirement-set with an applies-to class of product
work class.

The list of requirement documents displayed on the Add Requirements screen uses RuleRequirementSet.RequirementsListAuto property, which displays requirement rules with all applies-to
classes.

Product Designer Implementation Guide

24

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Managing services
The services are products with a Service product type and are stored in the FSP_PRODUCT table. The
onboarding process of services is similar to the Account product type. One or more services can be
mapped to any Account product type. The product work area has a Services section which displays a
list of services that are configured for that account product type using the D_ProductServiceSummary
data page.

The services can be configured on any product by selecting Actions > Manage services in the
Services section. The list of services is displayed in the drop down which can be configured to the
product. This list has all the services for the LoB of the product and uses the D_ServiceList data page.
The PegaPDFS-Data-PDPortal.UpdateServiceForProduct activity is run in the background to map the
selected services to the product. The mapping of products and services is stored in the
FSP_PRODSERVICEXREF database table.

Product Designer Implementation Guide

25

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Managing product instances


The Product instances section lists the product instances created for the product.
Product instances are stored in the FSP_PRODUCTINSTANCES table which is mapped to the
PegaPDFS-Data-CatDef-ProductInstance class. The pxObjClass product instance class is the same as
the product data class.
This section uses the D_ProductInstaceSummary3 data page to display the product instances for the
product. This data page is sourced by the BrowseProductInstances report definition.
Click on the Add button to create a new product instance. This performs the following actions:

UI generation for new product instance creation: This action is performed by the PegaPDFSData-ProductProperty.CreateInstanceRules activity called by the PegaPDFS-DataPDPortal.PreprocessForProdInstance activity, which creates the NewInstanceContent
section for every product in its product data class. The flow action and section for capturing
new product instance details are static. The NewInstanceContent section is dynamically
generated with fields of only those product properties which have been marked variable
during data model generation. These form field default values may be different for product
instances, as the user will be able to change the default values in the NewInstanceContent
section while creating product instances.

Update the pyDefault data transform for the product if the data model is changed: This
action uses the PegaPDFS-Data-PDPortal. CreatepyDeafultDynamically activity, which

Product Designer Implementation Guide

26

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

is also called in PegaPDFS-Data-PDPortal.PreprocessForProdInstance. It updates the


pyDefault data transform for the product if the data model is changed, so that the
NewInstanceContent section will display the latest default values of the product
properties at run time.

Set some default values in the new instance including a new unique ID

Gets the list of variables for the product onto the clipboard

Capturing details for new product instance: A modal dialog with the
AddProductInstanceWorkArea section are displayed. This allows the user to enter the
following data for the new product instance:

Name

Active From Date and Active To Date

List of variable properties of the product allowing override values to be entered for this
product instance

The PegaPDFS-Data-CatDef-Product.SaveProductInstanceDetails activity saves the


new product instance data in the database

Defaults are created for pricing for the product instance

Managing processes
The Cases section in product work area displays all processes created for the product. It uses the
D_CaseTypeOpen data page for getting case types for the product. The cases use templates for
process creation, where the template has predefined stages in it. One of the processes is the product
setup process for the Retail product, which uses the Retail Template Case Type template. The
pyDefault for this case type is in the PegaPDFS-Work-Product-ProductSetup.pyDefault class.

Product Designer Implementation Guide

27

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

The creation of a process is initiated by selecting Actions > Create case in the Cases section of the
product work area. It opens a PegaPDFS-Data-PDPortal.CopyTemplateCaseTypeToSelectedProduct
flow.

The following steps are included in the flow:


Process Details: This step captures the data for the new process to be created, for example: name,
class name, and so on. The PegaPDFS-Data-PDPortal.ValidateCreateProcessInputs activity is used to
validate the details of the process.

Product Designer Implementation Guide

28

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Copy template case type: The PegaPDFS-Data-PDPortal.CopyTemplateCaseType activity is called to


create the case type for the product set-up case for this product. The following actions are taken in this
activity:

Create process class: The new class is created for the process in the product work
class. It is derived from Product work class. The PegaPDFS-Data-PDPortal.
TransformNewProcessClass data transform is used to set properties for the new
process class. The ruleset for this class is the same as the product.

Create case type: A new case-type is created using the template case type as
explained above. The Rule-Obj-CaseType.TransformNewCaseType data transform is
used to update case type properties.

Product Designer Implementation Guide

29

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Create pyStartCase: The new pyStartCase is created for the product using the
PegaPDFS-Work-Product-ProductSetup.pyStartCase template flow. This is also
created in the new process class and in product ruleset. The Rule-Obj-Flow.
TransformNewpyStartCase data transform is used to set properties of this flow.

Update Current application: The current application rule is updated for


pyWorkMetaData with these case item details.

Add coverable case type: The PegaPDFS-Data-PDPortal. TransformNewpyStartCase


activity is used to add this case type as a coverable case type to the parent case type.

Product Designer Implementation Guide

30

Landing Page Configurations

Product Designer Configurations


The Product Designer > Configurations menu item is added to the Pega-Landing.
FSFSampleDataManagementMainMenu navigation rule. This landing page is configured with
the PegaPDFS-Landing harness. ProductManagementConfiguration harness. This landing page
displays the application layer and rulesets for product and customer related rules. The
application rules are displayed using D_pzAvailableApplicationStack data page.
When you select an application, the PegaPDFS-Landing.SetRuleSetDetails activity is run to get
the rulesets for the selected application.

The rulesets displayed for product and customer type rules are fetched using the
D_pzAvailableRuleSetsForRecord data page. The available versions for the corresponding ruleset are displayed using the D_BrowseRuleSetVersion data page.
The rulesets selected in the drop-down menus for product and customer are updated in DSS
DATA-ADMIN-SYSTEM-SETTINGS PEGAFSPRODUCT!PRODUCTRULESET and DATAADMIN-SYSTEM-SETTINGS PEGAFSPRODUCT!CUSTOMERRULESET respectively using
the PegaPDFS-Landing.UpdateRulesets activity.

Product Designer Implementation Guide

31

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Manage Products
The Product Designer > Manage products menu item is added to the Pega-Landing.
FSFSampleDataManagementMainMenu navigation rule for Manage Products landing page.
This landing page is configured with the PegaPDFS-Landing.ExportProducts. The list of all the
products with thumbnail view is displayed using the D_ProductsSummary data page.
The following actions can be taken on the selected products:

Export products
For exporting the products and creating a jar file, the Rule-Admin-Product rule is created with
standard Pega 7 rules. Some of the standard rules have been specialized or customized as per
the requirements. The following steps are taken while exporting:

Initialize RAP rule: The product rule (Rule-Admin-Product) is initialized with some initial
values using the PegaPDFS-Landing.InitializeProductRule data transform.

Capture zip file name: The file name is captured in a modal dialog using the RuleAdmin-Product.FSPPromptForProductFileName flow action using the Rule-AdminProduct.FSPPromptWindowForFileName flow action.

Create RAP rule: The Rule-Admin-Product.ExportProducts activity creates the RAP


rule for the selected products.

Product Designer Implementation Guide

32

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

The following steps are included in this:

Create a new R-A-P rule.

Iterate through all products, and for selected products, identify the ruleset and add it to
R-A-P.

Populate all the required data instances.

Save the rule.

Run batch request: The Rule-Admin-Product.RunBatchReq activity is called to run the


batch requestor to execute the CreateZipFile activity and display the progress of the
process.

Delete Products
Click the Delete button on Manage Products landing page to delete products. The PegaPDFSLanding.DeleteProducts activity is called to delete the selected products.

Product Designer Implementation Guide

33

Test Flow

Test flow
The Test Flow is created to test product rules which have been auto-generated using the
product designer. A product designer, while creating a new product and its associated rules,
may want to test and see how the product setup flow is coming up, how the sections and form
fields are getting displayed at run-time, and so on. To enable this, a test flow is created which
simulates the product setup case for the product. The product set- case cannot be run on standalone as it requires customer parties and products selected as its prerequisites which are part of
the Onboarding process. The test flow simulates the Onboarding process by enabling customer
selection and product selection steps in a simplified manner.
The test flow and associated rules are created using the following configurations:
Class: The class used for the test flow is PegaPDFS-Work-OnboardAccount-TestFlow.
Ruleset: The test flow rules are created in the PegaPDFSDemo ruleset.
The following rules are created as part of the test flow:
Test flow case type: The Onboard account case type is created for testing flow in the above
mentioned class.

Each stage has its corresponding flow, flow actions and sections. The flows are:

PegaPDFS-Work-OnboardAccount-TestFlow.CollectCustomerData: This flow is used


to collect customer details. It is similar to OBFS customer search functionality and the
selected customer is added as a work party to test the product setup flow.

PegaPDFS-Work-OnboardAccount-TestFlow.CollectProductDetails: This flow displays


the list of all LoBs, product categories, products and product Instances, to simulate the
product selection functionality in OBFS. It uses the D_LOBSummary,

Product Designer Implementation Guide

34

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

D_ProdCategorySummary, D_ProdSummary, D_ProductInstaceSummary3 data


pages.

PegaPDFS-Work-OnboardAccount-TestFlow.SelectPrimaryCustomer: This flow is


used to assign the role to the selected parties. The roles are displayed in a drop-down
menu using the D_ProductsRoleSummary data page. For the selected customers, the
work parties are created using the PegaPDFS-Work-OnboardAccountTestFlow.CreateWorkParties activity.

PegaPDFS-Work-OnboardAccount-TestFlow.CreateProductSetupCase: The flow calls


a utility to create a child case to simulate the product setup process. The activity used
in this is PegaPDFS-Work-OnboardAccount-TestFlow. CreateProductSetupCase.

Product Designer Implementation Guide

35

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Whenever a new product is created, the product setup case for that product is added as a
Coverable work type in this case type definition.

pyStartCase flow: The pyStartCase flow is also created as shown below:

Product Designer Implementation Guide

36

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Product Designer Implementation Guide

37

Browsing Entities

Case Manager Left Navigation


The left navigation pane in Product Designer portal helps in browsing through different entities.
The case designer portal left navigation is customized to include the product designer related
entities. The Navigation rule customized for this is PegaPDFS-DataPDPortal.PDCaseManagerLinks.

Dashboard
When you click the Dashboard, the PegaPDFS-Data-PDPortal.PDPDashboard harness is
loaded, which includes the PegaPDFS-Data-PDPortal.LoBDashboardWorkArea section.
List of LoBs: This displays a list of LoBs using the D_LOBBrowse using Report Definition
BrowseLOBs data page.
List of Ongoing Products: This list of ongoing products is displayed using the
D_ProdOpenSummary and Report Definition BrowseOpenProducts data page.
List of Recent Approvals: This also displays a list of products that have been approved recently
using the D_RecentApprovedProducts and Report Definition BrowseRecentProducts data page.

My Worklist
My Worklist renders the Pega 7 Data-Portal.pyMyWorklist harness which displays the list of
work items in the users work list. It uses the D_Worklist data page.

Product Designer Implementation Guide

38

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Product Categories
The product categories display the list of product categories for all lines of business. It is
rendered in the PegaPDFS-Data-PDPortal.BrowseProductCategoriesWorkArea harness. It uses
D_ProdCatSummarySortAndFilter data page and BrowseProdCategoriesByLOB report
definition.

The PegaPDFS-Data-PDPortal.ProdCategoryBrowseControls section enables the filtering of


product categories by text or LoBs. It also enables sorting by name and date of creation.

Products
The Products link renders the PegaPDFS-Data-PDPortal.BrowseProductsWorkArea harness to
display all the products belonging to all LoBs and product categories. The data page used to
browse products is D_ProductsSummary and the report definition is
BrowseProductsSortByDate.

Product Designer Implementation Guide

39

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

It also includes filtering of products for LoBs and Product categories and sorting by name and
date of creation using the PegaPDFS-Data-PDPortal.BrowseProductsWorkArea section.

Product Instances
The Product Instances link renders the PegaPDFS-DataPDPortal.BrowseProductInstancesWorkArea harness which includes the PegaPDFS-DataPDPortal. BrowseProductInstancesWorkArea section. It uses the ProductInstancesPage
clipboard page of the PegaPDFS-Data-CatDef-ProductInstance class to render the list of
product instances.
The filtering and sorting actions on the product instances are performed using the PegaPDFSData-PDPortal.BrowseProductInstances section.

Requirements
The Requirements link opens the Requirements dashboard, where users can create new
requirements. The harness rendered in this is Data-Portal. RequirementsPortalDashboard.

Cases
The Cases link displays the list of all the cases created so far for all the products of all LoBs and
Product categories.
It renders the PegaPDFS-Data-PDPortal.CasesWorkArea harness. The PegaPDFS-DataPortal. PopulateCaseTypesSummaryDataPage data transform is used to populate the

Product Designer Implementation Guide

40

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

D_ProdDesignerCases data page. It iterates through D_CaseTypeSummary for all LoBs,


product categories and products and gets the list of all case types.

It also displays the list of all template case types that exist in the product designer using the
D_BrowsePDTemplateCaseTypes data page and the dataTableListReport report definition.

Reports
The Reports link displays all reports from the private and public categories. It is the standard
functionality with the Data-Portal.pyCMReportBrowser7 harness.
The following categories of reports are created under public categories:

PDFS Daily Reports

PDFS Monthly Reports

PDFS Weekly Reports

For the product designer, the below Report Definitions are created in the PegaPDFS-DataCatDef-Product class:

DailyApprovedProducts

DailyProductsByLOB

DailyProductsByLOBAndProductCategory

DailyProductsByProductCategory

Product Designer Implementation Guide

41

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

DailyProductsProgress

MonthlyApprovedProducts

MonthlyProductsByLOB

MonthlyProductsByLOBAndProductCategory

MonthlyProductsByProductCategory

MonthlyProductsProgress

ServicesByLOB

WeeklyApprovedProducts

WeeklyProductsByLOB

WeeklyProductsByLOBAndProductCategory

WeeklyProductsByProductCategory

WeeklyProductsProgress

Product Designer Implementation Guide

42

Routing

Routing Overview
The product designer offers the ability of routing the products that are being created from one
party to another. As mentioned in previous sections, based on the access groups like product
designer, product developer and product manager, the user has the capability of routing
products for review, modification, approval, rejection or release. The below approach is taken to
implement this functionality:

Work Object
As in Pega 7, only work objects can be routed from one work list to another or one work basket
to another. In product designer, the product creation is backed by a work object which is stored
in pc_work table. This work object is routed from one operator to another based on roles given
to review, approve, or reject and finally release to for production. This is explained in the next
section.

Routing Configurations
PDFS:DesignerRole: Role when added in access group gives option to create and review the
product
PDFS:DeveloperRole: Role when added in access group gives option to create and review the
product
PDFS:ManagerRole: Role when added in access groups gives option to review (approve or
reject) and release the product.
DevelopersWB: Workobjects will be moved to this workbasket when the approver is product
developer and this is configured in the PDFSDeveloper work group.
DesignersWB: Workobjects will be moved to this workbasket when the approver is product
designer and this is configured in the PDFSDesigner work group.
ManagersWB: Workobjects will be moved to this workbasket when the approver is product
manager and this is configured in the PDFSManagers work group.
PDFSDeveloper: Developers workgroup, when added in the OperatorID rule gives flexibility to
modify and review the product even though it has been created by others.
PDFSDesigner: Designers workgroup, when added in the OperatorID rule gives flexibility to
review the product even though it has been assigned to others in the same group.
PDFSManager: Managers workgroup, when added in the OperatorID rule gives flexibility to
review, approve, or reject the product even though it has been assigned to others in the same
group.

Product Designer Implementation Guide

43

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Product Designer Implementation Guide

44

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Product Onboarding Case type


To enable the routing of the product, the entire flow of product creation until product release is
included in the Product Onboarding case type.

This case type has three stages:

Onboard Product: The onboard product flow includes capturing product metadata to create
a new product and display the product work area. At this stage, the status of the product is
Draft. These two have been explained in previous sections.

Product Designer Implementation Guide

45

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Send for approval: The flow that controls the routing of the work object (product life cycle) is
PegaPDFS-Work-Product-Onboarding.FSRouting.
The operator who creates the product is also called the originator and initially, the work object
will be in their worklist and product status will be in DRAFT mode. This operator has a role
defined as PDFS:DesignerRole/ PDFS:DeveloperRole. At this stage, only the originator can
send the product (work object) for approval to the selected approver by selecting Actions >
Review at the right side of the product work area. All other operators product work areas will be
in read only mode though they have the same role as the originator. Once review is done, the
approver can send it back to the originator or any other approver in the list.
If originator is selected, the work object will be sent to the worklist and only the originator can
work on the product and send it for further approval.
If approver is someone other than the Originator, the work object is sent to the selected
approvers workbasket and any operator having the same role as the approver can work on this
product and send it for further process.
The flow runs in the loop between the originator (product designer), developer and manager
until the manager approves the product.

Product Designer Implementation Guide

46

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Routing functionality is configured in the Actions menu of the product work area, with Review
and Release as sub menus.
The Review menu has a flow action configured to select the approver and capture their
comments to send for review of the product.
The Release menu has a ReleaseProduct flow action configured to capture the final comments
and release the product. This menu is only available for managers when the product is sent for
release.

Product Designer Implementation Guide

47

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

The PegaPDFS-Data-PDPortal.PickRole activity is run to set the operator role the on work
page based on the operators access group. This helps in restricting the approvers list.

The PegaPDFS-Work-Product.SelectApprover section, configured as a modal dialogue is


displayed to capture the details of the approver and the action to be taken.

Product Designer Implementation Guide

48

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

The PegaPDFS-Work.FSPRouting post processing activity updates the work object and routes
it to the selected Reviewer by picking the matching workbasket from the map rule, PegaPDFSWork.MapApproverNameWithID . It also updates the Product data in the database in the
FSP_PRODUCT table with the Assigned Operator and Product status after routing it to the
reviewer.

Product Designer Implementation Guide

49

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

The PegaPDFS-Work.MapApproverNameWithID map value rule maps the selected approver


name to the configured workbasket (in workgroup).

The PegaPDFS-Work-.SetProductStatus data transform will set the status of the product
when the work object is moved between the workbaskets.

Product Designer Implementation Guide

50

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Activity PegaPDFS-Work-.MakeSectionReadOnly will set the SetReadOnlyFlag considering


logged in operator is in assigned workgroup or worklist.

The MakeReadOnly rule is used to make the product work area read-only so that only assigned operators can
work on the product work object.

Product Designer Implementation Guide

51

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Release: When the Product Designer sends the product for release, it is sent to the worklist of
the Product Manager. In this case, the menu item Release is enabled for the manager. This
opens a modal dialog using the local action PegaPDFS-Work-Product.ReleaseProduct. The
PegaPDFS-Work.RouteForRelease activity updates the final product status and brings the
assignment to completion.

The last stage in Product Onboarding is Release product which includes the given flow:

Product Designer Implementation Guide

52

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

The utility Update Status in the above flow calls the PegaPDFSWork.SetFinalStatusOfProduct11 activity. This activity sets the final status as Approved when
the Product manager releases the product.

Product Status during Routing


The status of the product is always updated when the work object of Product Onboarding is
routed from one work basket to another. The table lists the product statuses during the course
of the product creation until its approval.
Product Status
Draft
Pending-Review

Assigned Operator
Product Designer/Product Developer
Product Developer/Product
Designer/Product Manager

Open-InProgress

Product Designer/Product Developer

Product Designer Implementation Guide

Description
When the product is created
When Product designer/ Product
Designer/Product Manager sends the
product for review
When the product is routed back to the
Product Designer/Product Developer by the
53

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Product Status

Assigned Operator

Rejected

Product Manager

Pending-Release

Product Manager

Approved

Product Manager

Product Designer Implementation Guide

Description
developer/Manager/designer after the
review
When the Product manager rejects the
product
When Product Designer/Product Developer
sends the product for Release
When the Product manager approves the
product

54

Activation

Activation Overview
Product instances and product bundles may be active or inactive.
In the Onboarding portal, product instances and product bundles are available for selection only
if they are active.
When a product instance or product bundle is created in the Product Designer it can optionally
be assigned an Active From Date and an Active To Date.
A product instance is active when its associated product has been approved and the current
date is between the product instances Active From Date and Active To Date (inclusive).
Otherwise it is inactive.
A product bundle is active when the current date is between the bundles Active From Date and
Active To Date and all of the contained instances are themselves active. Otherwise the bundle
is inactive.
Furthermore a product instance or product bundle cannot be edited while it is active. The
Update buttons on the gadgets (Variables, Pricing, Eligibility and Benefits) are disabled.
However it is possible to temporarily deactivate an active instance or bundle if an edit is
required. This option is available from the Actions menu on the product instance or product
bundle page. If the product instance or bundle is active the actions menu provides a Deactivate
option. While it is temporarily deactivated it is possible to edit the product instance or bundle:
The Update buttons on the gadgets (Variables, Pricing, Eligibility and Benefits) are enabled.
Once edits are complete the actions menu provides a Reactivate option to place the product
instance or bundle back into the active state. Note that this option is not available for product
instances or bundles that are inactive, but only for ones that would be active but have been
temporarily deactivated.
A product instances status is updated whenever one of the following events takes place:

Its associated product is approved

It is added to an approved product

The current date moves into or out of its activation window (auto-activation see below)

It is deactivated or reactivated using the actions menu

A product bundles status is updated whenever one of the following events takes place

The current date moves into or out of its activation window (auto-activation see below)

It is deactivated or reactivated using the Actions menu

Product Designer Implementation Guide

55

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

An inactive product instance is added to it

A contained product instance has its status updated

Auto-Activation: Activation Agent


It is an agents job to monitor product instances and bundles as the current date changes and
compare the current date to the Active From Date and Active To Date. This is in the PegaPDFS
ruleset:

The Activation agent is set to a recurring pattern with the following parameters:

Product Designer Implementation Guide

56

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

The agent uses the access group PDFS:Agents:

The agent uses the PegaPDFS-Data-PDPortal.ActivateDeactivateObjects activity:

Product Designer Implementation Guide

57

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

The activity is dependent on a number of data pages and report definitions.


It is also dependent on a PegaPDFS-DataInactiveProductsInBundles.IdsOfProductBundlesContainingInactiveInstances subreport. The
PegaPDFS-Data-InactiveProductsInBundles class is mapped to a view in the database:
FSP_INACTIVEPRODUCTSINBUNDLES.
The SQL for creating this view is:
create view PEGADATA.FSP_INACTIVEPRODUCTSINBUNDLES
(PRODUCTBUNDLEID,PRODUCTINSTANCEID,PRODINSTANCESTATUS)
as
select * from (
select
XREF.PRODUCTBUNDLEID,XREF.PRODUCTINSTANCEID,PI.PRODINSTANCESTATUS
from PEGADATA.FSP_PRODBUNDLEXREF XREF
inner join PEGADATA.FSP_PRODUCTINSTANCE PI
on XREF.PRODUCTINSTANCEID = PI.PRODUCTINSTANCEID
where PI.PRODINSTANCESTATUS != 'Open-Activated'
Product Designer Implementation Guide

58

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Product Designer Implementation Guide

59

Application Extensibility

Catalog instance classes


PegaPDFS-Data-CI for each new product, a class is created here to hold properties, sections
and so on.
PegaPDFS-Work-CI for each new product, a class is created here to hold case types
(NewAcct).
In the implementation, building on top of PDFS, specialized classes can be used to store
products. In this case, there will be direct inheritance from PegaPDFS-Data-CI and PegaPDFSWork-CI.
The location (class name) of a new product is determined dynamically based on the Line of
Business and Product Category. The FSP_LOB and FSP_PRODCAT tables are referenced for
the class path:
Example: 1st row: Lending is located in PegaPDFS-Data-CI-Loan-Lending

When a new product is created, the location is derived from the Product Categories table
(FSP_PRODCAT), column: PRODCATCLASSID.
Note: The PRODUCTNAME column is actually Product Category Name.

When a new product is created, SetProductClassName retrieves PRODCATCLASSID based on


the selection made (UI for Create Product) and the product class name.

Product Designer Implementation Guide

60

TITLE of INTERNAL DOCUMENT Arial Bold 12 pt

Note: Product Data Class is constructed from PRODCATCLASSID and Product Work Class is constructed from
Current Work Pool.
Steps:
1.1.1.1
1.1.1.2

Product Designer Implementation Guide

61

You might also like