Cisco Cisco Computer Telephony Integration Option 8.5 Developer's Guide

Page of 500
   
4-30
CTI OS Developer’s Guide for Cisco ICM/IPCC Enterprise & Hosted Editions
Cisco CTI OS Release 7.2(1)
Chapter 4      Building Your Application
Logging In and Logging Out an Agent
The following example, which assumes the Agent object has been created, demonstrates this task in Java:
public void SetAgentMode(Arguments rArgs) {
 /* 1. Create Arguments object*/
 Arguments rArgs = new Arguments();
 /
* 2. Set log in values.*/
 rArgs.SetValue(CtiOs_IKeywordIDs.CTIOS_AGENTID, “275”);
 rArgs.SetValue(CtiOs_IKeywordIDs.CTIOS_PERIPHERALID, “5002”);
 rArgs.SetValue(CtiOs_IKeywordIDs.CTIOS_AGENTINSTRUMENT, “5002”)
 rArgs.SetValue(CtiOs_IKeywordIDs.CTIOS_AGENTPASSWORD, “********”);
 rArgs.SetValue(CtiOs_IKeywordIDs.CTIOS_AUTOLOGIN, “1”);
 /* 3. Log in the agent.*/
 int returnValue = agent.Login(rArgs);
}
Note
It is the client application’s responsibility to keep track of whether the log in attempt is the first 
attempt, or during failover, and branch accordingly in the SetAgentMode() event to avoid calling the 
Login() method during failover.
The Login() method generates the following events:
  •
QueryAgentStateConf()
  •
AgentStateEvent(), if the agent is unknown or is logged out.
Note
The client application receiving the these events must check both the ENABLE_LOGOUT and 
ENABLE_LOGOUT_WITH_REASON bitmasks. For more information, see 
When not successful, the Login() method generates the eControlFailureConf() event.
How to Handle Duplicate Log In Attempts
Overview
A duplicate log in attempt is when an agent who is already logged in tries to log in a second time using 
the same ID. Desktop applications must account for such a possible situation and have a plan for dealing 
with it.
You can handle duplicate log in attempts in three ways:
  •
Allow the Duplicate Log In with No Warning
  •
Allow the Duplicate Log In with a Warning
  •
Do not allow a duplicate log in.
You control how duplicate log in attempts are handled in two ways:
  •
By configuring how duplicate log in attempts are to be handled on a global basis by creating custom 
values in the CTI OS Server Registry. By using custom values in the CTI OS Server registry to 
control how duplicate log in attempts are handled, and downloading these settings to your desktop 
application as described on page 4-34, you can enable flexibility without having to modify your 
desktop application code.