IInteractionLogger

Functions

startLogging

This function can be executed from the interaction logger object to start logging interaction records. Internally this function will create a parent interaction record in SVC_INTERACTIONS table.

Once a parent interaction record is created in SVC_INTERACTIONS table, for each Fusion object (SR, Case) getting saved, an entry will be added to SVC_INTERACTION_REFS table. If a second object is saved, it will create a child interaction record in SVC_INTERACTIONS table and a new entry will be added to SVC_INTERACTIONS table with interaction id as the interaction id of child interaction got created. In other words, there will be a one-to-one mapping between interactions in SVC_INTERACTIONS table and interaction refs in SVC_INTERACTION_REFS table. This child interaction creation and interaction refs creation will continue until stopLogging is called. Also, it can be paused and resumed temporarily by calling pauseLogging and resumeLogging functions respectively.

Here's the syntax:

startLogging(interactionPayload?: Record<string, string>): Promise<string>;

Parameter Name	Required?	Description
interactionPayload	No	Additional information to be saved as part of parent interaction. For example, 'UefCustomTextTvm_c': 'Extensible Field Value 1'}

Here's an example of the Typescript:

var frameworkProvider: IUiEventsFrameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('app','v1')
var interactionLogger: IInteractionLogger = frameworkProvider.getInteractionLogger('ORA_SVC_PHONE', '300100572530155');
var parentInteractionId: string = await interactionLogger.startLogging();

Here's an example of the JavaScript:

var frameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('app','v1')
var interactionLogger = frameworkProvider.getInteractionLogger('ORA_SVC_PHONE', '300100572530155');
var parentInteractionId = await interactionLogger.startLogging();

stopLogging

This function can be executed from the interaction logger object to stop logging interaction records. Internally this function will update the parent interaction record (StatusCd=ORA_SVC_CLOSED) (which was created as part of startLogging function) in SVC_INTERACTIONS table. If WrapUpPayload is provided, it will create a wrapUp record in SVC_MCA_INTERACT_SUMMARY table.

Here's the syntax:

startLogging(interactionPayload?: Record<string, string>, wrapUpPayload?: Record<string, string>): void;

Parameter Name	Required?	Description
interactionPayload	No	Additional information to be saved as part of parent interaction. For example, 'UefCustomTextTvm_c': 'Extensible Field Value 1'
wrapUpPayload	No	If passed, it will create a WrapUp entry in the database. For example, .stopLogging(null, {'InteractionNotes':'quick 123'}

Here's an example of the Typescript:

var frameworkProvider: IUiEventsFrameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('app','v1')
var interactionLogger: IInteractionLogger = frameworkProvider.getInteractionLogger('ORA_SVC_PHONE', '300100572530155');
var parentInteractionId: string = await interactionLogger.startLogging();
interactionLogger.stopLogging(null, {'InteractionNotes':'quick 123'});

Here's an example of the JavaScript:

var frameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('app','v1')
var interactionLogger = frameworkProvider.getInteractionLogger('ORA_SVC_PHONE', '300100572530155');
var parentInteractionId = await interactionLogger.startLogging();
interactionLogger.stopLogging();

pauseLogging

This function can be executed from the interaction logger object to pause logging interaction records.

Here's the syntax:

pauseLogging(): void;

Here's an example of the Typescript:

var frameworkProvider: IUiEventsFrameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('app','v1')
var interactionLogger: IInteractionLogger = frameworkProvider.getInteractionLogger('ORA_SVC_PHONE', '300100572530155');
var parentInteractionId: string = await interactionLogger.startLogging(); 
await interactionLogger.pauseLogging();

Here's an example of the JavaScript:

var frameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('app','v1')
var interactionLogger = frameworkProvider.getInteractionLogger('ORA_SVC_PHONE', '300100572530155');
var parentInteractionId = await interactionLogger.startLogging(); 
await interactionLogger.pauseLogging();

resumeLogging

This function can be executed from the interaction logger object to resume an already paused interaction logging.

Here's the syntax:

resumeLogging(): void;

Here's an example of the Typescript:

var frameworkProvider: IUiEventsFrameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('app','v1')
var interactionLogger: IInteractionLogger = frameworkProvider.getInteractionLogger('ORA_SVC_PHONE', '300100572530155');
var parentInteractionId: string = await interactionLogger.startLogging(); 
await interactionLogger.pauseLogging();
await interactionLogger.resumeLogging();

Here's an example of the JavaScript:

vvar frameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('app','v1')
var interactionLogger = frameworkProvider.getInteractionLogger('ORA_SVC_PHONE', '300100572530155');
var parentInteractionId = await interactionLogger.startLogging(); 
await interactionLogger.pauseLogging();
await interactionLogger.resumeLogging();