PrecisionLender Application Events

Overview

When pricing an opportunity in PrecisionLender, application events are sent to Andi® to notify her of changes to the opportunity. These application events can be used to determine whether a skill should run or how it should execute. You can target these Application Events within the Opportunity context in Andi® and retrieve accompanying data from the Opportunity Model.  

In This Article

• Event Structure
• Referencing an Application Event
• Helpful Tip
• Application Events

Event Structure

Application Events are represented as a JSON object. Every Application Event will consist of the following structure:

eventCounter: number; // each event will have its own, unique payload.
 id: string;
 tenantId: string;
 organizationId: string;
 applicationId: string;
 context: string;
 currentContext?: string;
 associatedViewContext?: {id: string, [prop: string]: any};
 currentlyViewedContext?: { id: string; [prop: string]: any; }[];
 fullContext?: string;
 conversationId: string;
 eventMetaData?: any;
       //currently {
         userEmail: string; 
         userFullName: string; 
         userId: string; 
         username: string
        }
 userId: string;
 inboundChannel: ISkillChannel;
 eventType: EventTypes; //e.g. Application Event
 eventStartTs?: number;
 eventArrivalTs?: number;
 eventDepartureTs?: number;
 locale:string;
 applicationEventName: string; // e.g. "OpportunityCreated", "OpportunityStageChanged",
 applicationEventData: any; // e.g. the opportunityModel properties for an event

Referencing an Application Event

Events may not appear via intellisense when you write your code.

Using a Power

To reference an application event, cast a variable using the getApplicationEvent power and then define an event variable to pass that variable with the event name

let yourVariableName = skillContext.powers.andi.event.getApplicationEvent();
let yourEventVariableName = yourVariableName && yourVariableName.applicationEventName && yourVariableName.applicationEventName.startsWith("theEventName")

Example:

let anEvent = skillContext.powers.andi.event.getApplicationEvent();
let scenarioRecalculated = anEvent && anEvent.applicationEventName && anEvent.applicationEventName.startsWith("scenarioRecalculated");

Without Using a Power

To reference an application event, cast a variable using IApplicationEvent from the skillContext. Then use that variable to define your variable with the event name. This will also allow you the ability to use intellisense to view the full IApplicationEvent shape.

let applicationEvent = skillContext.event as andiSkills.IApplicationEvent;
let yourVariableName = applicationEvent.applicationEventName && applicationEvent.applicationEventName === "theEventName"

Example:

 let event = skillContext.event as andiSkills.IApplicationEvent;
 let scenarioRecalculated = event.applicationEventName && event.applicationEventName === "scenarioRecalculated";

Helpful Tip

If you're unsure of what event or event properties you may need to reference from the list below, follow the steps below to see the events using Developer Tools for the following web browsers:

• In Chrome

• Open or create an opportunity in PrecisionLender

• Open the Developer Console in your browser

• Select Network

• Search and Filter on 'events'

• Under the Headers section, expand 'Request Payload'

• Perform the desired end user action in the opportunity in PrecisionLender.

• All resulting events will show as their own 'event' in the request payload. Select an event to view its properties.

• In Internet Explorer

• Open or create an opportunity in PrecisionLender

• Open the Developer Console in your browser

• Select Network

• Perform the desired end user action in the opportunity in PrecisionLender.

• All resulting events will show with a Name/Path of 'event' in the content pane.

• Select an 'event' in the response to view its properties in the 'Request body' tab of the Body section.

Application Events