createSession (app profile manager)

Creates a session based on a session template and returns the unique identifier of the session.

Syntax

Microsoft.Apm.createSession(SessionInput);

Parameters

The structure of the JSON SessionInput parameter is as follows:

{
        /**
         * Returns the name of the template used in the session
         */
        templateName: string;
        /**
         * additional information for session creation
         */
        sessionContext: Map<string, string>;
        /**
         * will focus after session is created
         */
        isFocused?: boolean;
    }

Return value

Session identifier as String.

Examples

These examples use the createSession method to create a new session passing an entity record identifier and a session template as parameters.

Create a basic session

Creates a new session passing the incident as entity name, incident Id as entityId, and unique name of the session template as templateName.

x=new Map();
x.set("parametersStr", '[["entityName", "incident"], ["entityId", "fac04293-1ab0-eb11-8236-000d3a5c49ed"]]');
Microsoft.Apm.createSession({templateName: "case_entity_session_default_template", sessionContext: x});

Create a session that is not in focus

x=new Map(); 
x.set("parametersStr", '[["entityName", "incident"], ["entityId", "0e0e6c4f-cbb6-eb11-8236-000d3a5ab8b9"]]'); 
Microsoft.Apm.createSession({templateName: "case_entity_session_default_template", sessionContext: x, isFocused: false});