Avaya DXX-1015-01 manual Listing Active ADUs, ADU Termination, Agent Data Unit

Page 12

Chapter 2 The Agent Data Unit

Any application that wants to interact with an ADU has to request it by its unique identifier, the ADUID. Upon request, the ADU Server passes the ADUID out to other processes, thus enabling applications to request access to individual ADUs.

The ADU Server also honors requests to watch for ADUs that contain certain values. If any ADU matches the monitoring criteria, the ADU Server issues event messages (which contain the ADUID) to “interested” clients. (Refer to “ADU Event Monitoring,” on page 27.)

Typically, clients want to receive event notifications about ADUs, examine ADU contents, and modify ADU values. These activities are supported through method invocations. For example, a client could invoke one of the Get methods (GetOneValue(), GetSomeValues(), and so on) to ask the ADU Server to return values in an ADU. Chapter 7 of this manual describes the methods supporting these activities.

ADU Termination

When an agent logs out of Avaya IC, the agent’s ADU should be closed.

Before an ADU can be closed, the ADU Server must first verify that all processes are done with it. For each ADU, the ADU Server maintains an internal list of processes that have read, transferred, or modified the ADU. Any process that invokes a method using the ADUID of the ADU is added to the list. When a client invokes the method ADU.Terminate(), the client's name is removed from the list. When the list is empty, the ADU can be terminated.

Note: In some configurations, it is possible for the agent to log out of the teleset without logging out of Avaya IC. The ADU is not closed in this case.

Safeguards are built into the ADU Server to terminate “suspicious” ADUs, in other words, those that appear to have been lost. Any ADU that has been idle for an extended period (thirty minutes, by default) is automatically terminated. (The idle time can be changed with the Idle Time configuration parameter, as described in “Configuration Parameters,” on page 37.)

If the ADU Server goes down, all ADUs are closed. For Agent Status monitors to be accurate, all users must log off and log back on again to create new ADUs.

Listing Active ADUs

You can view a list of active ADUs and the clients interested in them with the listadu utility.

To use this utility:

1Copy listadu.exe from the Avaya IC5.x/bin directory to the directory in which the vesp.imp and vespidl.pk files are located, which is /etc by default.

2From the system prompt, type

listadu -iinterface -uusername -ppassword

-i interface to use (often ADU or VDU, or an alias or uuid of such a server)

12 Agent Data Unit Server Programmer’s Guide

Image 12
Contents Avaya Interaction Center Acknowledgment Contents Contents Agent Data Unit Server Programmer’s GuideBefore YOU Begin Typographical ConventionsContacting Technical Support Font Type MeaningProduct Documentation Readme FileElectronic Documentation Educational Services Educational ServicesIssue 1.0 June 2002 Printed DocumentationAgent Data Unit Server Programmer’s Guide Start-up Procedures Chapter ADU ServerOverview Cooperation of ADU Servers ADU ServerChapter Agent Data Unit Definition of an ADUADU Lifecycle ADU CreationListing Active ADUs ADU TerminationAgent Data Unit Bytes Example Description Contents AduidADU Data Table AduidADU Contents ADU Contents Core ADU FieldsField Name Description Set By Agent ADU Fields Description Set BySheet 1 Sheet 2 Sheet 3 Voice Data Containers Sheet 4Value Explanation Queue ADU Fields Following ADU fields are used by queues on Avaya ICContainers ContainersContainer Names and Special Tokens Containername .!loginid Limitations of Container SyntaxContainer Configurations Parameter Type Default DescriptionADU.Update VDU.Update ADU.Create VDU.CreateEDU Values written if tscon is set to true Agent Data Unit Chapter Event Monitoring ADU Event MonitoringDescription Message Starting and Stopping Event Monitoring Event MonitoringSetting Event Monitoring Criteria Setting Event Monitoring CriteriaMonitoring Criteria Syntax Example ADU.Assign loginid=Joe & ts.1.s=wrapup Symbol Definition Description Relational OperatorsBoolean Operators Monitoring Criteria WildcardsWildcard Definition Example Monitoring Criteria Examples Criteria Example DescriptionEvent Monitoring Agent Data Unit Server Programmer’s Guide Chapter Alarms Priority Description Cause/Recommended ActionAlarms Chapter ADU Server Configuration Configuration ParametersSystem Considerations ADU Server Alias NameADU Server Configuration Configuration Parameters Sheet 4 Set them on the Config tab of the ADU Server Editor dialog Name DescriptionADU Server Configuration Chapter IDL Specification IDL Specification Chapter ADU Server Methods Method ObjectivesException Information Routing Requests Method OverviewADU Server Methods Method Overview Methods ADU.AssignADU.Create ADU.Deassign ADU.DeleteOneValueADU.Deassign ADU.DeleteSubTree ADU.DeleteValuesADU.EventsIn ADU.FindADU.EventsIn ADU.FindByKey Locate an ADU having a key containingADU.FindOrCreate ADU.ForceTerminateADU.ForwardEvent ADU.FindOrCreateADU.GetActive ADU.GetOneValueADU.GetSomeValues ADU.GetSubTreeADU.GetSomeValues ADU.GetValues ADU.GetValueHistoryADU.GetValuesHistory ADU.GetValuesHistoryFirst value that was set was truth ADU.IncrValue ADU.MonitorADU.IncrValue ADU.RemoteWatcher ADU.SetAndTerminateADU.SetDefaultHistoryFilter ADU.SetAndTransferADU.SetAndTransfer ADU.SetHistoryFilter Hsnostart Hsnochange Hsnotransfer Hsnouser HsnodeleteADU.SetOneValue ADU.SetOneValueADU.SetValues ADU.SetValuesExtendedADU.Suspend ADU.TerminateADU.Suspend ADU.TerminateMine ADU.TouchADU.Transfer ADU.TransferADU Server Methods Agent Data Unit Server Programmer’s Guide Symbols IndexIndex AduidIssue 1.0 June 2002 Index Index Index Agent Data Unit Server Programmer’s Guide