Connect

Connects to the database. The result record contains the connection 'Uid' which is used for subsequent commands.

Permissions

Command Kind	Needed User Kind
Connect	All

Parameters

Name	Type	Description	Required	Default	Values
Database	string	Name of the database ([Database]).	yes
Password	string	The password of the user.	yes
User	string	Name of the user ([User]).	yes
Check	boolean	If 'True' the connection data is verified without logging in. The Uid becomes empty. The default value is 'False'.	no	false
SetCookie	boolean	If 'True', the uid is returned in a cookie. The default value is 'False'.	no	false

Result

Name	Type	Description
User	string	Name of the connected user.
Uid	string	Unique ID, to identify the connection which is used for subsequent commands.
Domain	string	Domain of the connected user.
Database	string	Name of the connected database.
Worksheet	string	Start worksheet of the connected user.
ClientUserAgentHash	string	Hash of the client user agent.
ClientIpHash	string	Hash of the client IP address.
ServerHost	string	Ip address of the server.
ServerPort	integer	Port of the server.
CsrfServerHeader	string	CSRF header name, which is sent by the server. It is used when the uid is returned in a cookie. For this, the 'SetCookie' parameter must be 'True'.
CsrfClientHeader	string	CSRF header name, which must be returned by the client. It is used when the uid is returned in a cookie. For this, the 'SetCookie' parameter must be 'True'.
Sys	boolean	'True' if user is 'Sys'.
SysTech	boolean	'True' if user is 'SysTech'.
Admin	boolean	If 'True' the connected user has admin permissions.
Designer	boolean	If 'True' the connected user has designer permissions.
Import	boolean	If 'True' the connected user has the permission to import data ('Import Dimension', 'Import Table'...), independent of database permissions.
Fixed	boolean	If 'True' the connected user cannot be changed ('Sys' or 'SysTech').
MinYear	integer	First year of fixed date dimensions of the database.
MaxYear	integer	Last year of fixed date dimensions of the database.
DefaultMaxRecords	integer	Default maximum number of records to be returned. It is used when 'MaxRecords' is not set in the query.
License	string	Name for which the server license was issued.

Code

CONNECT
DATABASE=[string, Needed]
PASSWORD=[string, Needed]
USER=[string, Needed]
CHECK=[boolean, default=false]
SETCOOKIE=[boolean, default=false]