ebs.getJourneyContext

(FintechOS Studio 21.1.1 and later)

Retrieves the name of the digital journey context.

This allows form driven flows that are shared between multiple digital journeys to identify the digital journey that initiated the flow.

Also see ebs.setJourneyContext and ebs.cleanJourneyContext.

Syntax

Copy 
function ebs.getJourneyContext(): IJourneyContext;

Return Value

Returns an IJourneyContext object containing the digital journey context name.

Copy 
{
    DigitalJourneyName: string
}

Examples

In this example:

  • In the After Events section of the originating form driven flow step, we set the context as belonging to the newCustomer digital journey.
    Copy
    ebs.setJourneyContext('newCustomer')

    For more details, see ebs.setJourneyContext.

  • On the final step of the shared flow, we display a message if the shared flow was initiated from the newCustomer digital journey.
    Copy
    if (ebs.getJourneyContext().DigitalJourneyName == 'newCustomer'){
        ebs.showMessage('Thank you. We will now proceed with your registration.')
    }