Session Transactions

Session Transactions are used to log an analyst in and out of the ASM full application.

Limited Support/End of Life Capabilities

The Classic API has been replaced by the Alemba RestFul API. While we will continue to support the Classic API for clients that are still using it, no further development will be done.

If you need to request a hotfix or support for these features, please contact Alemba Support

The ASM web service also gives the option of providing the login details to each transaction instead of calling the LogIn and LogOut transactions. If the web service transactions are called in this way, the analyst is logged in, the transaction executed after which the analyst is logged out.

The ASM web service allows multiple concurrent sessions for one analyst. This means that an analyst can be logged in to the main application and also be calling an API transaction at the same time without automatically logging out of the original main application session. This will only take up one concurrent license.

LogIn Transaction

The LogIn transaction logs the analyst into the system specified and generates a session ID for their session. This session ID can then be passed to each transaction called through the API web service.

The LogIn transaction follows the same license checks as the main application. If an analyst is already logged on to ASM, an API session will not log them out of that session.

Input Parameters: LoginRequest

Argument

Type

Mandatory

Default

Description

sLoginUserID

String

Yes

N/A

Analyst’s Login ID

sLoginPassword

String

Yes

N/A

Analyst’s Password

sDatabase

String

Yes

N/A

Name of the ASM System for logging in.

Return Values: LoginResponse

Argument

Type

Description

sID

String

Session ID returned. Will be “” if login failed

sMessage

String

Error/Warning Message returned from the API transaction.

Ret

APIReturn

Error/Warning Number returned from the API transaction.

LogOut Transaction

The LogOut transaction logs a selected analyst out of ASM.

As soon as the analyst is logged out of the system, their Session ID becomes invalid. A warning will be returned if an invalid session ID or no session ID is passed to the transaction.

Input Parameters: LogOutRequest

Argument

Type

Mandatory

Default

Description

sID

String

Yes

N/A

Analyst’s current Session ID

Return Values: LogOutResponse

Argument

Type

Description

sMessage

String

Error/Warning Message returned from the API Transaction

Ret

APIReturn

Error/Warning Message returned from the API Transaction