Sesión

Métodos

login(paráms)

Realiza un inicio de sesión en TM1 Web.

Parámetros: params El objeto de información de inicio de sesión que utiliza uno de los formatos de objeto siguientes:

{
    adminHost: "localhost",
    tm1Server: "Planning Sample",
    username: "admin",
    password: "apple"
}

O

{
    adminHost: "localhost",
    tm1Server: "Planning Sample",
    camPassport: "8sdf83uijsjdfsd903sd"
}

O

{
    adminHost: "localhost",
    tm1Server: "Planning Sample",
    tm1SessionId: "D3​lJLw50uvh2jtbAc​IYyVA"
}

Devuelve dojo/promise/Promise como una promesa que se resuelve cuando se completa la acción de inicio de sesión. Si falla el inicio de sesión, la promesa se rechaza, de lo contrario, se resuelve. La promesa se pasa como un objeto con el formato siguiente, si el inicio de sesión se realiza correctamente.

{
    sessionToken: "7118fad5-bbeb-4b3e-8bea-4b4a45ca2735",
    tm1SessionId: "D3​lJLw50uvh2jtbAc​IYyVA",
    adminHost: "localhost",
    tm1Server: "Planning Sample",
     username: "Admin"
}

getInfo(sessionToken)

Recupera la información que está asociada a la sesión de TM1 Web que corresponde a la señal de sesión especificada.

Parámetros: sessionToken Una señal de sesión que corresponde a la sesión de TM1 Web de la que recuperar información.

Devuelve dojo/promise/Promise como una promesa que se resuelve cuando se completa la acción. Si la recuperación falla, la promesa se rechaza, de lo contrario, se resuelve. La promesa se pasa como un objeto con el formato siguiente, si la recuperación se ha realizado correctamente.

{
    sessionToken: "7118fad5-bbeb-4b3e-8bea-4b4a45ca2735",
    tm1SessionId: "D3​lJLw50uvh2jtbAc​IYyVA",
    adminHost: "localhost",
    tm1Server: "Planning Sample",
    username: "Admin"
}

logout(señal de sesión)

Realiza un cierre de sesión e invalida la sesión de TM1 Web que corresponde a la señal de sesión especificada.

Parámetros: sessionToken Una señal de sesión que corresponde a la sesión de TM1 Web para invalidar.

Devuelve dojo/promise/Promise como una promesa que se resuelve cuando se completa la acción. Si la recuperación falla, la promesa se rechaza, de lo contrario, se resuelve. La acción se completa correctamente, incluso si la sesión no existe o ya se ha invalidado.

Para obtener más información, consulte Documentación de Dojo para dijit._WidgetBase (https://dojotoolkit.org/reference-guide/1.10/dijit/_WidgetBase.html).

Ejemplos

// login
require([
    "tm1web/api/session/session"
], function(session) {
    session.login({
	    adminHost: "localhost",
		tm1Server: "Planning Sample",
		username: "admin",
		password: "apple"
	}).then(function(sessionInfo) {
	    // Create Workbook or CubeViewer using sessionInfo.sessionToken
	}, function() {
	    // Handle login failure appropriately
	});
});

// getInfo
require([
    "tm1web/api/session/session"
], function(session) {
    session.getInfo("sessionToken").then(function(sessionInfo) {
	    // Continue using obtained sessionInfo
	});
});

// logout
require([
    "tm1web/api/session/session"
], function(session) {
    session.logout("sessionToken").then(function() {
	    // Logout has successfully completed
	});
});