ChannelSessionManagement.ChannelSessionManagement
- Last UpdatedApr 28, 2023
- 1 minute read
The ChannelSessionManagement.ChannelSessionManagement channel is designed to provide access through Rest calls to a Remote API that manages session management functionalities such as login, user management, and performance storing. The channel uses a database to persist data.
It is not possible to register any variable inside the channel.
Code example
This is a code example for ChannelSessionManagement.ChannelSessionManagement.
<channel name="session" class="ChannelSessionManagement.ChannelSessionManagement" connectionString="Driver={Microsoft Access Driver (*.mdb)};Uid=Admin;Pwd=;Dbq=d:\projects\invensys\enel_vr\db\VR.mdb"/>
Parameters
These are parameters for the channel connection.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
Mandatory |
The name of the channel. |
|
class |
Mandatory |
Must be ChannelSessionManagement.ChannelSessionManagement. |
|
connectionString |
Mandatory |
ODBC format connection string for the data persistence. |
Simulation parameter
There is no <simulation/> related configuration for this channel type.
Also, no variable can be declared inside the channel.
<session>
</session>
Rest based functions
All of these functions accept DSTRING parameters and return STABLE data.
For each function, there is a corresponding set of Debug variables that can be used to explore the received requests:
-
functionName_parameters: DSTRING parameters passed in the latest function call.
-
functionName_result: STABLE result for the latest function call.
-
functionName_datetime: timestamp for the latest function call.
|
Type of function |
Functions |
|---|---|
|
User related functions |
listUsers, selectUsers, createUser, modifyUser, deleteUser, login |
|
Scenarios related functions |
listScenarios, selectScenarioFromCode, selectScenario, createScenario, modifyScenario |
|
Session related functions |
CreateSession |
|
Performance related functions |
listPerformances, listPerformancesDate, listOverallTotalizers, listUserTotalizers |
|
Other |
keepAlive |