createTab (JavaScript API Reference) for Dynamics 365 Channel Integration Framework 2.0

Creates a tab in a focused Session and returns the unique identifier of the created tab.

Syntax

Microsoft.CIFramework.createTab(input, correlationId).then(successCallback, errorCallback);

Parameters

Name	Type	Required	Description
Input	String	Yes	JSON input
successCallback	Function	No	A function to call when a record is created. Unique identifier(TabId) of the created tab is returned in the response.
errorCallback	Function	No	A function to call when the operation fails. An object with the following properties will be passed: errorCode: Number. The error code. message: String. An error message describing the issue.

The structure of the Input parameter JSON is shown below.

{ 
   "templateName":"<unique name of session template>",
   "templateTag":"<template tag>",
   "templateParameters":{ 
      "globalparam":"number value OR boolean value OR json string value OR parameterized string value",
      "app template 1":{ 
         "param 1":"number value OR boolean value OR json string value OR parameterized string value",
         "param 2":"..."
      },
      "app template 2":"…."
   }
}

Return value

Promise with the value of tab ID as String

Example

var tabInput = {
    //Unique Name of the Application Tab Template
    // type = string
    templateName: "msdyn_test_entity",
    appContext: new Map().set("etn", "incident").set("recordId", "768a786f-59e0-ea11-a813-000d3a8b1f3b"),
    isFocused: true
};
Microsoft.CIFramework.createTab(tabInput).then((tabId)=>{
    console.log("created tab with id " + tabId);
}, (error)=>{
    console.log(error);
});