public interface WFMSessionService800Soap
Modifier and Type | Method and Description |
---|---|
void |
cancelRequest(java.lang.String requestID)
Allows you to cancel asynchronous request.
|
void |
closeRequest(java.lang.String requestID)
Session service provides only a common method to close already opened asynchronous request.
|
void |
closeSession()
Closes the previously opened session.
|
void |
closeSnapshot(java.lang.String snapshotID)
Session service provides only a common method to close already opened snapshot.
|
int |
getRequestProgress(java.lang.String requestID)
Returns progress of asynchronous request expressed in percentage (0 - 100%)
|
boolean |
getRequestResult(java.lang.String requestID)
Session service provides only a common method to check for result of completion of asynchronous request.
|
RequestStatus |
getRequestStatus(java.lang.String requestID)
Returns status of asynchronous request.
|
SessionInfo |
openSession(java.lang.String appName,
int userID)
The method opens session on server (WFM Main Server, WFM DA, WFM Builder or WFM Reporting) for calling client.
|
SessionInfo |
openSessionLogin(java.lang.String appName,
java.lang.String userName,
java.lang.String userPassword)
The difference between 'OpenSession' and 'OpenSessionLogin' is that client is not required to know DBID of its CME application to open the session.
|
SessionInfo2 |
openSessionLogin2(java.lang.String appName,
java.lang.String userName,
java.lang.String userPassword)
The difference between 'OpenSession' and 'OpenSessionLogin' is that client is not required to know DBID of its CME application to open the session.
|
SessionInfoEx |
openSessionLoginEx(java.lang.String appName,
java.lang.String userName,
java.lang.String userPassword)
The difference between 'OpenSession' and 'OpenSessionLogin' is that client is not required to know DBID of its CME application to open the session.
|
void |
pingSession()
Sends "keep alive" signal for the specified session as the session is going to be closed by the server, when there is no client activity with the session for a pre-set amount of time.
|
SessionInfo openSession(java.lang.String appName, int userID)
appName
- The unique name of client's CME application object.userID
- DBID of Person object in CME. It could be either suoervisor's or agent's ID. Note, that WFM security subsystem applies only to supervisors. If userID = 0, then user will not be associated with this session and data security will not be applied.
Hint: userID can be passed as a negative value indicating that its absolute value designates an agent and not a supervisor, which eliminates need to check supervisor/agent dependency and speeds up the login.SessionInfo
, which contains session id for just created session and list of services, which can be accessed on this server using this session. This list also can be used to find specific part of URL, which should be used accessing the each service.SessionInfo openSessionLogin(java.lang.String appName, java.lang.String userName, java.lang.String userPassword)
appName
- The unique name of client's CME application object.userName
- there should be a Person object in CME with this username. If user is synchronized with WFM DB security subsystem, security rights will be applied. Otherwise, session will be established without applying security rightsuserPassword
- it should match the password of Person in CME, which is identified by 'userName' parameter.SessionInfo
.SessionInfoEx openSessionLoginEx(java.lang.String appName, java.lang.String userName, java.lang.String userPassword)
appName
- The unique name of client's CME application object.userName
- there should be a Person object in CME with this username. If user is synchronized with WFM DB security subsystem, security rights will be applied. Otherwise, session will be established without applying security rightsuserPassword
- it should match the password of Person in CME, which is identified by 'userName' parameter.SessionInfoEx
.SessionInfo2 openSessionLogin2(java.lang.String appName, java.lang.String userName, java.lang.String userPassword)
appName
- The unique name of client's CME application object.userName
- there should be a Person object in CME with this username. If user is synchronized with WFM DB security subsystem, security rights will be applied. Otherwise, session will be established without applying security rightsuserPassword
- it should match the password of Person in CME, which is identified by 'userName' parameter.SessionInfoEx
.void closeSession()
void pingSession()
void closeSnapshot(java.lang.String snapshotID)
snapshotID
- Snapshot IDvoid closeRequest(java.lang.String requestID)
requestID
- Request IDboolean getRequestResult(java.lang.String requestID)
requestID
- Request IDint getRequestProgress(java.lang.String requestID)
requestID
- Request IDRequestStatus getRequestStatus(java.lang.String requestID)
requestID
- Request IDRequestStatus
void cancelRequest(java.lang.String requestID)
requestID
- Request IDCopyright © 2005-2016 Genesys Telecommunications Labs, Inc. All Rights Reserved.