Creating a new journey type
Create your own journey case to extend the list of existing journeys and to meet your specific business needs.
You must perform these steps to make a new journey type available. For more information, see the list of available Journey types and subtypes.
Creating a new class
Create a new class under the root class for your journeys in Pega Client Lifecycle Management for Financial Services.
For example, if you plan to create a specific journey to manage the renewal of documentation, you can create a class with the following characteristics:
Attribute | Value |
---|---|
Class | UPFS-MyApp-Work-CLM-DocumentCollection |
Class Type | Concrete |
This Class | Belongs to class group |
Class Group | UPFS-MyApp-Work |
The system refers to the class that you create in many different operations, and so the class must be registered under the D_AppExtension data page used by the application for DCR.
- In the Application Explorer under the class PegaFS-Data-AppExtension, create a new Text property with the name WorkClass_<journey-type>. For example, WorkClass_DocumentCollection.
- Open the data transform AppExtension_Ext available at PegaFS-Data-AppExtension to set the value of the new property with the name of the class that you create.
As the last step of the registration, the class must be added to the map value MapForCustomerJourney.
- If this is the first time that you create a new journey, copy the rule MapForCustomerJourney from the CLM layer (PegaCLMFS-Work-CLM) into your implementation layer. If this is not the first journey, the rule should already be there.
- Open the rule in the implementation layer and add an entry setting the new journey type (for example, DocumentCollection) in the left column, and a reference to the new class in the right column (for example, D_AppExtension.WorkClass_DocumentCollection).
Registering a new journey type
After creating the new class, you must create the three field value rules that register the class as a journey type, with the following attributes:
Field | Expected value | Example input |
---|---|---|
Field Name | CustJourneyType | Fixed |
Label | Short name of the type | DocumentCollection |
Applies-to Class | Baseclass | @baseclass |
Description | Description of the subtype | Document Collection |
Field | Expected value | Example input |
---|---|---|
Field Name | CustJourneyType | Fixed |
Label | Short name of the type | DocumentCollection |
Applies-to Class | Journey class | UPFS-MyApp-Work-CLM-DocumentCollection |
Description | Description of the subtype | Document Collection |
Field | Expected value | Example input |
---|---|---|
Field Name | pyCaption | Fixed |
Label | Short name of the type | DocumentCollection |
Applies-to Class | Baseclass | @baseclass |
Description | Description of the subtype | Document Collection |
Registering a new journey subtype
All journeys must have at least one journey subtype to be executed.
For example, after creating a journey, you can create a first journey subtype to support a periodic collection of documents. Create an additional field value rule to register a new journey subtype. For additional field values, see the following table:
Field | Expected value | Example input |
---|---|---|
Field Name | CustJourneySubype | Fixed |
Label | Short name of the type | DocumentCollection |
Applies-to Class | Journey class | UPFS-MyApp-Work-CLM-DocumentCollection |
Description | Description of the subtype | Periodic Document Collection |
Triggering a journey from a customer search
Users can trigger journeys on the existing customer through the Actions menu for customer search results. The Actions menu lists all journey types and subtypes applicable to that specific customer. The applicability of the journeys is driven by a set of when rules, which when executed against the customer data, determine which of the journeys should appear.
To add a journey type and subtype available in the Actions menu, create a new when rule. For example, to make your journey available only to active customers, create a when rule with the following parameters:
Field | Expected value | Example input |
---|---|---|
Name | Applies_<journeytype>_When | Applies_ DocumentCollection_When |
Applies-to Class | Journey class | UPFS-MyApp-Work-CLM-DocumentCollection |
Logic | Logic when the journey will be available | .CustomerStatus=Active |
If you do not trigger your journey from the UI but create it by a background process (for example, a recurrent job, an external service call), create the when rule so that it always returns false.
In the same way that you determine when your journey type is available, you must specify the conditions that make your journey subtype available. For example, to make a journey subtype available only to your organization, create another when rule with the following parameters:
Field | Expected value | Example input |
---|---|---|
Name | Applies_<journeysubtype>_When | Applies_ DocumentCollectionPeriodic_When |
Applies-to Class | Journey class | UPFS-MyApp-Work-CLM-DocumentCollection |
Logic | Logic when the journey will be available | .PartyType=Organization |
Triggering a journey from customer profile
You can also create journeys on the customer profile screen, known as the Customer 360 or Master Profile screen. On the customer profile screen, the Actions menu in the top-right corner of the screen lists all journey types and subtypes applicable to that customer.
The Actions menu is rendered using the navigation rule PegaFS-Work.CustomerSearchActions. To add a new journey to that menu, complete the following steps:
Make a copy of the rule to your implementation layer. If this is not the first journey you create, you might already have a copy available.
Create a new entry in the navigation rule for the journey subtype that you want to add to the menu. For example, Periodic Document Collection.
Configure the visibility condition of the new entry with a new when rule that determines when the journey subtype is applicable. The when rule must apply to the class of your customer search case type. You can use the rule CanCreateNewPrincipalSubJourney as a reference.
Configure the following actions associated to the Click event that you associate with the new entry:
Type Expected value Parameters Run Script CallCLMFSBusyIndicator Not applicable Run Data transform CLMPassParameters Journey: DocumentCollection
JourneySubtype: DocumentCollectionPeriodic
SetCustomerIDFromWorkContext: true
Create Work Not applicable Target: Default
ClassName: UPFS-MyApp-Work-CLM-DocumentCollection
FlowName: pyStartCase
Previous topic Implementing case types Next topic Creating a new journey subtype