LinkedIn
Copied!

Table of Contents

Creating a new journey type

Create your own journey case to extend the list of existing journeys and to meet your business needs. For more information, see the list of available Journey types and subtypes). These steps are required to make a new journey type available.

Creating a new class

The first step is creating a new class under the root class for journeys (CLM). For example, if you are planning 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
Find by name first Yes
Parent class UPFS-MyApp-Work-CLM

This class will be referred in many different operations by the system and therefore should be registered under the D_AppExtension data-page used by the application for DCR.

  1. Under the class PegaFS-Data-AppExtension, create a new property of type Text with name WorkClass_<journey-type>. For example, WorkClass_DocumentCollection.
  2. 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 have just created.

As the last step of the registration, the class should be added to the map value MapForCustomerJourney.

  1. If this is the first time 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 be already there.
  2. Open the rule at 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 class, you must create the three field values rules that register the class as a journey type with the following attributes:

Field Value Example
Field Name CustJourneyType Fixed
Label Short name of the type DocumentCollection
Applies-to Class Baseclass @baseclass
Description Desciption of the subtype Document Collection
Field Value Example
Field Name CustJourneyType Fixed
Label Short name of the type DocumentCollection
Applies-to Class Journey class UPFS-MyApp-Work-CLM-DocumentCollection
Description Desciption of the subtype Document Collection
Field Value Example
Field Name pyCaption Fixed
Label Short name of the type DocumentCollection
Applies-to Class Baseclass @baseclass
Description Desciption 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 journey you can create a first journey subtype to support a periodic collection of documents. Create an additional field value rule to register new journey subtype. For additional field values, see the following table:

Field Value Example
Field Name CustJourneySubype Fixed
Label Short name of the type DocumentCollection
Applies-to Class Journey class UPFS-MyApp-Work-CLM-DocumentCollection
Description Desciption of the subtype Periodic Document Collection

Triggering a journey from customer search

Users can trigger journeys on existing customer through the Actions button available in the screen for customer search results. After clicking the button, the system renders a menu with all the journey types and subtypes applicable for that specific customer. The applicability of journeys is driven by a set of when rules that, executed against the customer data, determines which of the journey should appear or not.

In order to make a journey type and subtype available at that menu, create a new when rule. For example,you decided that your journey should be only available to active customers. In that case, create when rule as it is described in the following table:

Field Value Example
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 for any reason, your journey is not going to be triggered from the UI, but created programmatically by some kind of background process (for example, a recurrent job, an external service call), create the when rule in a way that it always returns false.

In the same way that you have determined when your journey type is available, you must specify the conditions that make your journey subtype available. If, for example, you want to make the created journey subtype available only for organizations, create another when rule with the following characteristics:

Field Value Example
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

Another point of the application where journeys can be created is the customer profile screen, also known as Customer 360 or Master Profile screen. In that screen, the Actions button at the top-right corner of the screen, lists all journey types and subtypes applicable for that customer.

That menu is rendered using the navigation rule PegaFS-Work.CustomerSearchActions. If a new journey must be available at that screen, complete the following steps:

  1. Make of 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.

  2. Create a new entry in the navigation rule for the journey subtype which must be available. For example, Periodic Document Collection.

  3. Configure the visibility condition of the new entry with a new when rule that determine when the journey subtype will be applicable. The when rule should apply to the class of your customer search case type. You can use the rule CanCreateNewPrincipalSubJourney as reference.

  4. Configure the following actions associated to Click event associate to the new entry:

    Type 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

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.