IDSSXMLServerSession

Default value for the sessionFlags parameter of the CloseSession method

Default value for the authMode parameter of the CreateSession method

Default value for the clientID parameter of the CreateSession method

Default value for the locale parameter of the CreateSession method

Default value for the login parameter of the CreateSession method

Default value for the newPasswd parameter of the CreateSession method

Default value for the passwd parameter of the CreateSession method

Default value for the projectName parameter of the CreateSession method

Default value for the sessionFlags parameter of the CreateSession method

Default value for the flags parameter of the GetProjects method

Default value for the regularWorkingSetSize parameter of the putRegularWorkingSetSize method

Default value for the searchWorkingSetSize parameter of the putSearchWorkingSetSize method

Changes the user's password.

The difference between this change password and the change password functionality offered by CreateSession is that this is used when a session has already been established. This offers the ability for a user to change his/her password after the user logs in.

Used to check the version of both the Web API and the Server, and see whether they are guaranteed compatible with each other. Note that this function reutrning false doesn't mean that they are not compatible, though if it returns yes, then they are guaranteed to be compatible. Also note that the XMLAPI version will be returned even if the method throws an exception.

Closes a session, freeing up resources in the Intelligence Server.

CreateConfigSession creates a Configuration Session Id to the specified Intelligence Server from the input Master Session Id. This login does not require other security parameters because the user was already authenticated when the Master Session Id was created. You must specify the machine info@return

CreateMasterSession creates a Master Session Id to the Intelligence Server that is backed by the Jwt infrastructure so that single-sign-on (SSO) can work in in an asymmetric cluster. The returned value is a Configuration Session Id that can be used to make non-project related calls. The Configuration Session Id can be used to create Project Session Ids by calling CreateProjectSession@return

Adds a project to the current IServer

Adds a project to the current IServer

Adds a project to the current IServer

CreateProjectSession creates a Project Session Id to the Intelligence Server from the input Master Session Id. This login does not require other security parameters because the user was already authenticated when the Master Session Id was created. The project Id must be passed in.
Notice how there is no mention of which machine in the cluster will be connected. CreateProjectSession will figure out the best IServer@return

Creates a session in the Intelligence Server. Almost all operations (except GetProjects and CheckVersion) of the Web API require a session ID. By creating a session, a user is authenticated in the Server to perform the operations that are allowed for its account.

If projectName is empty, the session is created at the Intelligence Server without connecting to any project. During this session, the user can only perform project independent operations. The user can only check inbox messages and their content. The user cannot perform any project-related operations, like submit reports or documents, or browse objects.

With CreateSession, a user can change the password. To change the password, the sessionFlags has to be DssXmlSessionChangePwdOnCreate. If the sessionFlags is set to anything else and a new password is provided, the password will not be changed.

The clientID parameter is used for client identification. Client machine names, IP addresses or the names of the user who uses the machine are examples of clientID. When using the default, a hard coded "Web Server" is used. This ID can be used by MicroStrategy Server for monitoring purposes.

When authMode mode is DssXmlAuthStandard, uid/passwd parameters are required. Uid cannot be empty while passwd can be an empty string.

The setting for authMode of DssXmlAuthNTCredential is disabled for the Java-based Web API. This is because the Web Server platform is not necessarily Windows NT, and as such this cannot be a valid option from the Java WebAPI.

When AuthMode is set to "DssXmlAuthAnonymous", MicroStrategy Server will log the user in as an anonymous account. The user has whatever the privilege an anonymous account is set in the Data Source.

Anonymous authentication mode does not require a user name and a password when CreateSession is called.

The sessionFlags is used to indicate the different options for the session. See the sessionFlags description for details.

This method is used for Intelligence Server session creation. If users want to create a project session based on configuration session, the authMode should be set as DssXmlAuthSessionID.@return

This method extends CreateSession(String, String, String, String, int, String, int, int) by replacing the single locale parameter with a regional options XML, which is structured as follows, where the individual locale IDs must be a valid Windows Locale ID:

 <regional_options>
 	 <metadata>
     <locale>1033</locale>
 	 </metadata>
 	 <messages>
 	   <locale>1033</locale>
 	 </messages>
 	 <numbers>
 	   <locale>1033</locale>
 	 </numbers>
 	 <date>
 	   <locale>1033</locale>
 	 </date>
 </regional_options>
 

This method is used for Intelligence Server session creation, and if successful returns a session ID. If an usherEmail is passed as a parameter, it will first authenticate the Intelligence Server user, then create an associated user on the Usher Server with the following sample response:

<usher_response>
<header>HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Cache-Control: no-cache, no-store, must-revalidate
Expires: 0
Pragma: no-cache
Content-Type: application/json
Content-Length: 90
Date: Wed, 04 Mar 2015 22:31:52 GMT
</header>
<body>["email":"abc@microstrategy.com","user_id":10,"code":"A7NbvsLkedYSYeUB2STKevJYbVgnfR"]</body>
</usher_response>

This method extends CreateSession(String, String, String, String, int, String, int, int) by replacing the single locale parameter with a regional options XML, which is structured as follows, where the individual locale IDs must be a valid Windows Locale ID:

 <regional_options>
 	 <metadata>
     <locale>1033</locale>
 	 </metadata>
 	 <messages>
 	   <locale>1033</locale>
 	 </messages>
 	 <numbers>
 	   <locale>1033</locale>
 	 </numbers>
 	 <date>
 	   <locale>1033</locale>
 	 </date>
 </regional_options>
 

* This method is used for Intelligence Server session creation. If users want to create a project session based on configuration session, the authMode should be set as DssXmlAuthSessionID.@return

This method is used to retrieve the licensing information for the user with the given session ID. This information will simply be whether the user has restricted permissions because of licensing violations.

Returns the locales supported by a given project for a given user.

Returns the locales supported by a given project.

Used to get the list of projects on the MSTR Server, which this session is connected to.

Used to get the list of projects loaded in the cluster.

Used to get the list of projects loaded in the cluster.

Used to get the list of projects loaded in the cluster.

Returns the locales supported by the Intelligence Server.

This is a sessionless call that retrieves various repository settings.

This method returns user privilege information.

This method takes a sessionID as input and returns an IDSSXMLUserPrivilege object. To get a sessionID, use CreateSession to login to Server configuration. If a user logs into configuration (creates session with empty project name), the privileges returned by this function are those defined on user object. These privileges are project independent. If a user logs into a particular project, the privileges returned are privileges the user has for this project plus those project independent privileges.

User privileges that can be returned are listed in the enumeration class EnumDSSXMLPrivilegeTypes. To check if a user has a particular privilege, call the CheckPrivilege method of IDSSXMLUserPrivilege object. This method takes a privilege value from EnumDSSXMLPrivilegeTypes as input and returns true if the user has the privilege, or False if the user does not.

Given a session ID, this method returns the user name, ID and other information on the Intelligence Server.

This method returns user privilege information.

This method takes a sessionID as input and returns an IDSSXMLUserPrivilege object. To get a sessionID, use CreateSession to login to Server configuration. If a user logs into configuration (creates session with empty project name), the privileges returned by this function are those defined on user object. These privileges are project independent. If a user logs into a particular project, the privileges returned are privileges the user has for this project plus those project independent privileges.

User privileges that can be returned are listed in the enumeration class EnumDSSXMLPrivilegeTypes. To check if a user has a particular privilege, call the CheckPrivilege method of IDSSXMLUserPrivilege object. This method takes a privilege value from EnumDSSXMLPrivilegeTypes as input and returns true if the user has the privilege, or False if the user does not.

Similar to GetUserPrivilege(String), except that this method returns the privilege information in the form of an XML String instead of an IDSSXMLUserPrivilege object. Please note that these two methods are 2 different calls to the Intelligence Server.

Returns the collection of projects loaded in the Intelligence Server that the given user has access to. An application can use this method to list only the projects in the Intelligence Server that the user can login to.

Returns the collection of projects loaded in the cluster that the given user has access to.

Returns the collection of projects loaded in the cluster that the given user has access to. An application can use this method to list only the projects in the cluster that the user can login to. This session connnect to a MSTR server, which belongs to a cluster. Each server in the cluster may load different project(s). This list includes project, which user has access to and is loaded by at least one server in the cluster.

Returns the collection of projects loaded in the cluster that the given user has access to. An application can use this method to list only the projects in the cluster that the user can login to. This session connnect to a MSTR server, which belongs to a cluster. Each server in the cluster may load different project(s). This list includes project, which user has access to and is loaded by at least one server in the cluster.

Returns the collection of projects loaded in the cluster that the given user has access to.

Returns the collection of projects loaded in the cluster that the given user has access to. An application can use this method to list only the projects in the cluster that the user can login to. This session connnect to a MSTR server, which belongs to a cluster. Each server in the cluster may load different project(s). This list includes project, which user has access to and is loaded by at least one server in the cluster.

Returns the Web API Version.

This method will initialize the metadata repository of a server. This will cause the tables in the database to be setup for intelligence server usage.

Create Trust Relationship between Web Server and Intelligence Server.

Returns the current setting for application type.

Returns the IDSSXMLConfigServer object. This object can be used to perform configuration-type operations on the server.

This method will return whether the API will create a connection to an unconnected server if it has not been connected to when calling CreateSession, GetProjects, GetUserProjects, or CheckVersion.

Returns an instance of the Document Server.

Returns an instance of the Element Server

Returns an instance of the Inbox interface

Get LDAP Distinguished Name for Single Sign on authentication mode

Returns an instance of the Object Server.

Returns the IDSSXMLPerfCounterServer object. This object can be used to gather performance information from the Intelliegence Server.

Returns the port that the Web API will connect to the Intelligence Server on. 0 will denote the default port.

Returns the regular working set size for report/document execution.

Returns an instance of the Report Server.

Get the REST URL of I-Server without SessionID

Get Rest API URL by providing an instance of IDSSXMLServerSession.RestApiUrlParams@return

Returns an instance of the Schedule Server.

Returns the currently active value for search working set size.

Returns an instance of server admin.

Returns the name of the Intelligence Server that this object is connected to/will connect to.

Get session key for mobile encryption

Get Trust Token for Single Sign on authentication mode

Modifies various session creation parameters after a session has been created. Null parameters are ignored. This operation does not affect the underlying regular or search working set values on this instance.

Sets the application type that will be sent to the I-Server when creating a session. This will affect the application type of the request in the informational tools(i.e. desktop's connection monitor).

This method can be used to turn on or off the behavior of creating a new connection to the Intelligence Server if we are not connected to the Server when calling CreateSession, GetProjects, GetUserProjects, or CheckVersion. By default this setting is true, and is set only on the scope of the current IDSSXMLServerSession object.

Sets the socket port used to interact with the Intelligence Server. Setting the port to 0 means the default port number of Intelligence Server is used. Before setting this port number, the application needs to contact the Server administrator to make sure the same port number is used to start MSTR Intelligence Server. This will only take effect for sessions created after this call.

Sets the regular working set size for report/document execution This will only work if the session is created after this call.

Sets the search working set size. This will only work if the session is created after this call.

Sets the server name of the MSTR Intelligence Server that this ServerSession will connect to. This will only take effect for sessions created after this call.

Refresh SQL Engine schema for all nodes in the connected cluster. This is required when COM schema is updated in MD

Delete Trust Relationship between Web Server and Intelligence Server.

Sends a sessioned XML API call to IServer and retrieves the results as binary

Sends a sessioned XML API call to IServer and retrieves the results as a String

Set GSS Delegation Credential for Kerberos Authentication mode

Set LDAP Distinguished Name for Single Sign on authentication mode

Set session key for mobile encryption

Set Trust Token for Single Sign on authentication mode