Avaya DXX-1015-01 manual Chapter ADU Server Methods, Method Objectives, Exception Information

Page 45

CHAPTER 7

ADU SERVER METHODS

Method Objectives

Clients request Avaya IC servers to perform various functions by issuing server-specific method invocations. These methods behave in a similar fashion across all servers. For example, when you invoke any of the various ADU Server Set methods, existing values are overwritten. Values that did not previously exist are created. With the exception of the Delete methods, all of the ADU Server methods generate change events to indicate changes or additions. If an error occurs, exceptions are raised.

This chapter defines the methods provided with the ADU Server.

Note: Some program examples were formatted to fit the page. Actual program lines cannot be arbitrarily split.

Exception Information

The ADU Server methods may return the following exception information:

Cannot use empty token

Improper special token for this method

Improper use of a special token

No listing for home server for that ADU

No such name: <name>

No such ADU: <aduid>

No WAN ADU services in this version

Not an ADU id: <aduid>

Server only attribute

Too many characters in token

Too many dot separators

Too many names at the same time

Unknown error

ADU is read-only

45

Image 45
Contents Avaya Interaction Center Acknowledgment Contents Agent Data Unit Server Programmer’s Guide ContentsTypographical Conventions Before YOU BeginContacting 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 ADU Server Cooperation of ADU ServersDefinition of an ADU Chapter Agent Data UnitADU Lifecycle ADU CreationListing Active ADUs ADU TerminationAgent Data Unit Aduid Bytes Example Description ContentsADU 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 Following ADU fields are used by queues on Avaya IC Queue ADU FieldsContainers ContainersContainer Names and Special Tokens Limitations of Container Syntax Containername .!loginidParameter Type Default Description Container ConfigurationsADU.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 Event Monitoring Starting and Stopping Event MonitoringSetting Event Monitoring Criteria Setting Event Monitoring CriteriaMonitoring Criteria Syntax Example ADU.Assign loginid=Joe & ts.1.s=wrapup Relational Operators Symbol Definition DescriptionBoolean Operators Monitoring Criteria WildcardsWildcard Definition Example Criteria Example Description Monitoring Criteria ExamplesEvent Monitoring Agent Data Unit Server Programmer’s Guide Priority Description Cause/Recommended Action Chapter AlarmsAlarms Configuration Parameters Chapter ADU Server ConfigurationSystem Considerations ADU Server Alias NameADU Server Configuration Configuration Parameters Sheet 4 Name Description Set them on the Config tab of the ADU Server Editor dialogADU 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.DeleteValues ADU.DeleteSubTreeADU.EventsIn ADU.FindADU.EventsIn Locate an ADU having a key containing ADU.FindByKeyADU.ForceTerminate ADU.FindOrCreateADU.ForwardEvent ADU.FindOrCreateADU.GetOneValue ADU.GetActiveADU.GetSomeValues ADU.GetSubTreeADU.GetSomeValues ADU.GetValueHistory ADU.GetValuesADU.GetValuesHistory ADU.GetValuesHistoryFirst value that was set was truth ADU.IncrValue ADU.MonitorADU.IncrValue ADU.SetAndTerminate ADU.RemoteWatcherADU.SetDefaultHistoryFilter ADU.SetAndTransferADU.SetAndTransfer Hsnostart Hsnochange Hsnotransfer Hsnouser Hsnodelete ADU.SetHistoryFilterADU.SetOneValue ADU.SetOneValueADU.SetValuesExtended ADU.SetValuesADU.Suspend ADU.TerminateADU.Suspend ADU.Touch ADU.TerminateMineADU.Transfer ADU.TransferADU Server Methods Agent Data Unit Server Programmer’s Guide Index SymbolsAduid IndexIssue 1.0 June 2002 Index Index Index Agent Data Unit Server Programmer’s Guide