Connect( ) method

Establishes a session for a user on an SBM server, or provides a user access to a session that has already been established. This session will be on the server that was defined by the connection string passed to the constructor for the associated Progress.BPM.UserSession object.

Use this set of Connect( ) method overloads to connect a user to an SBM Server. This method establishes a connection to a Savvion SBM Server for a user. For a new connection, pass in the user name and password. If the connection succeeds, the returned unique SessionId property value is set on the UserSession object. To re-connect to an existing session, pass in your unique SessionId value.

Return type:

LOGICAL

Access:

PUBLIC

Applies to:

Progress.BPM.UserSession class

 

Syntax 

Connect ( INPUT username AS CHARACTER,           INPUT password AS CHARACTER ) Connect ( INPUT session-id AS CHARACTER )

username

The name of the user for whom the connection will be established. The user must have a valid account on the SBM Server in order to connect.

password

The user’s password.

session-id

Identifies the session associated with a connection made to an SBM Server on behalf of a specific user. This is the value of the SessionId property on an already connected UserSession object.

If the method succeeds, it returns TRUE and sets the SessionId property. If the method fails, it raises a BPM error.

A UserSession object that already has a valid connection (and has not subsequently disconnected) raises a BPM error when Connect( ) is called, and the connection will remain unchanged. A UserSession object becomes disconnected when it calls Disconnect( ) or when it encounters a communication error attempting to access its associated SBM Server.

See also:

Disconnect( ) method