Description of the open interfaces

Refer to PowerServer open interfaces in Workarounds & APIs Guide for the syntax of PowerServer open interfaces. Note that you can write code for calling the interface in the PowerBuilder application, but the code does not take effect in the PowerBuilder application; it only takes effect in the Appeon-deployed application.

getAllClients

getAllClients gets the IP addresses of all client machines which corresponds to the active sessions that are opened for the specified application in the specified PowerServer.

getAllSessions

getAllSessions returns the detail information of active sessions with XML format, which are opened for the specific application in the specific PowerServer.

getSessionByID

getSessionByID returns the detail information of the specified session with XML format.

getSessionCount

With getSessionCount method, you can get the following three types of information.

  • The total number of active sessions opened for the specified application in the specified PowerServer.

  • The total number of active sessions in a specified PowerServer.

  • The total number of sessions opened for the specified application in a PowerServer cluster.

    To get the number of sessions in a PowerServer cluster, you need to first configure the cluster in AEM.

By using the GetSessionCount method, you can easily get the total number of active sessions in a specified PowerServer using PowerBuilder code and apply the information in other open interfaces such as KillSession to manage the sessions. For example, you can first call GetSessionCount and then call KillSession in the PowerBuilder application to make the deployed application kill all sessions in PowerServer when there are up to 100 active sessions in the server.

killAllSessions

killAllSessions kills all active sessions in a PowerServer or an PowerServer cluster and rolls back all associated transactions. To kill all sessions in a PowerServer cluster, you need to first configure the cluster in AEM.

killSessions

killSessions kills the specified session(s) in a PowerServer or a PowerServer cluster and rolls back the associated transactions. To kill sessions in a PowerServer cluster, you need to first configure the cluster in AEM.

rollbackAllTransactions

rollbackAllTransactions rolls back all transactions in a PowerServer or a PowerServer cluster. To roll back all transactions in an PowerServer cluster, you need to first configure the cluster in AEM.