Connection: Connect to the MicroStrategy environment.

In MicroStrategy/mstrio: Interface for 'MicroStrategy' REST API

Connect to the MicroStrategy environment.

Description

Allows to establish, renew, check status and close the connection with MicroStrategy Intelligence Server.

Public fields

base_url

URL of the MicroStrategy REST API server.

username

Your username.

password

Your password.

project_name

Name of the connected MicroStrategy Project. One of project name or project id is necessary.

project_id

ID of the connected MicroStrategy Project. One of project name or project id is necessary.

login_mode

Specifies authentication mode to use. Standard = 1 (default) or LDAP = 16.

ssl_verify

If True (default), verifies the server's SSL certificates with each request.

web_version

The current web version

iserver_version

The current I-Server version

auth_token

The authentication token returned by the I-Server

cookies

Cookies

identity_token

Identity token for delegated session. Used for connection initialized by GUI.

verbose

If True (default), displays additional messages.

Methods

Public methods

• Connection$new()

• Connection$connect()

• Connection$delegate()

• Connection$get_identity_token()

• Connection$close()

• Connection$renew()

• Connection$status()

• Connection$clone()

---

Method new()

Establishes new connection with MicroStrategy Intelligence Server.

Usage

Connection$new(
  base_url,
  username = NULL,
  password = NULL,
  project_name = NULL,
  project_id = NULL,
  login_mode = 1,
  ssl_verify = TRUE,
  proxies = NULL,
  identity_token = NULL,
  verbose = TRUE
)

Arguments

base_url

URL of the MicroStrategy REST API server.

username

Your username.

password

Your password.

project_name

Name of the connected MicroStrategy Project. One of project name or project id is necessary.

project_id

ID of the connected MicroStrategy Project. One of project name or project id is necessary.

login_mode

Specifies authentication mode to use. Standard = 1 (default) or LDAP = 16.

ssl_verify

If True (default), verifies the server's SSL certificates with each request.

proxies

If NULL (default) proxy is not defined. To set proxy use formula: (<username>:<password>@)<ip_address>:<port> ()-optional

identity_token

Identity token for delegated session. Used for connection initialized by GUI.

verbose

If True, displays additional messages. FALSE by default.

Returns

A new "Connection" object.

---

Method connect()

Establishes new connection with MicroStrategy Intelligence Server, or renews active connection.

Usage

Connection$connect()

---

Method delegate()

Delegates identity token to get authentication token and connect to MicroStrategy Intelligence Server

Usage

Connection$delegate()

---

Method get_identity_token()

Gets identity token using existing authentication token

Usage

Connection$get_identity_token()

---

Method close()

Closes a connection with MicroStrategy REST API.

Usage

Connection$close()

---

Method renew()

Renews connection with MicroStrategy REST API.

Usage

Connection$renew()

---

Method status()

Displays status of the connection with MicroStrategy REST API.

Usage

Connection$status()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Connection$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
# Create a connection object.
connection = Connection$new(base_url, username, password, project_name)

# Connect or renew connection.
connection$connect()

# Check connection status.
connection$status()

# Renew connection to reset timeout counter.
connection$renew()

# Close connection.
connection$close()

## End(Not run)

MicroStrategy/mstrio documentation built on March 29, 2024, 9:44 p.m.