Progress.BPM.UserSession class

This class allows you to connect to a Business Process Server and access the server's functionality. An ABL application creates ABL BPM objects that represent objects that reside on the Business Process server, and it is through these ABL objects that a developer interacts with the server. Many of these objects can be created through UserSession methods (Progress.BPM.Process, which you can create only by calling StartProcess( ) on a UserSession object, is an example), and some can be created through methods on classes that you get from UserSession. The lifetime of an ABL object in an OpenEdge program is limited by the lifetime of the UserSession object with which it is associated.

Serializable:

No

Constructor

The following constructor establishes a connection (through a URL) to a Business Process Server:

PUBLIC UserSession( INPUT connection-parms AS CHARACTER )

connection-parms

A character string containing a URL with the connection parameters that identify the Business Process Server.

The URL must be in the following format:

-URL SBMServerDC://{ip-address | host-name}[:port-number]

Note: For https connections, use SBMServerDCS instead of SBMServerDC in the URL.

ip-address: The IP address of the Business Process Server.
host-name: The host name of the Business Process Server.
port-number: The number of the port that the Business Process Server listens on. If no optional port-number is specified, the OpenEdge default value of 18793 is used.

Super Class

Progress.Lang.Object class

Interfaces

This class does not implement interfaces.

Public Properties

Connected property

SessionId property (UserSession)

–

Public Methods

Connect( ) method	Disconnect( ) method (Progress.BPM.UserSession)
GetAssignedTasks( ) method	GetAvailableTasks( ) method
GetClientPrincipal( ) method (Progress.Lang.OERequestInfo)	GetDataSlotTemplates( ) method
GetProcess( ) method	GetProcesses( ) method
GetProcessTemplateNames( ) method	GetTask( ) method
StartProcess( ) method	–

Public Events

This class does not have any public events.

Notes

When the Disconnect( ) method is called on a UserSession object, all of the objects created directly or indirectly from that UserSession object become invalid. A flag on the Disconnect ( ) method identifies whether the user session is deleted on the Business Process Server.
All BPM classes are a snapshot of the execution of a process on the Business Process Server. It is important to consider this when working with BPM classes.
Note that executing DELETE OBJECT on a UserSession object causes the Disconnect( ) method to run, which will delete any local objects. It will have no effect on the active session in the Business Process Server.