Avaya DXX-1015-01 manual Routing Requests, Method Overview, ADU Server Methods

Page 46

Chapter 7 ADU Server Methods

You are not a server

Cannot find subcontainer for that owner

First token must be normal here

No match (or illegal usage)

Cannot access invalidated member

Routing Requests

In an environment with several ADU Servers, any method that accepts an ADUID routes the request to another ADU Server if the ADU named is not local to the first server. ADUIDs contain location data, so a server can identify which system owns each ADU.

Method Overview

The following is a brief description of the methods available for use with the ADU Server.

ADU.Assign

Create a session with the ADU Server.

ADU.Create

Create a new ADU.

ADU.Deassign

Destroy a session with an ADU Server.

ADU.DeleteOneValue

This is equivalent to DeleteValues with a single name.

ADU.DeleteSubTree

DeleteOneValue on the given name and every name in the

 

subcontainer beneath it, cutting a branch from the tree a

 

container represents.

ADU.DeleteValues

Given a list of names, this method removes from the ADU

 

the name and its value history, in effect making the ADU

 

smaller.

ADU.EventsIn

Adds user-defined ADU events to an ADU.

ADU.Find

Returns a list of ADUIDs that match a simple criterion.

ADU.FindByKey

Finds one active local ADU based on a single search

 

criterion.

ADU.FindOrCreate

Searches for a specified ADU and, if not found, creates the

 

ADU.

ADU.ForceTerminate

Forces theADU object to be deleted from memory and

 

from the database both, so it can no longer be used.

ADU.ForwardEvent

Reserved.

ADU.GetActive

Finds all the active ADUs at the time the call is made.

ADU.GetOneValue

Retrieves one value from an ADU.

ADU.GetSomeValues

Returns all names and values matching a container name.

ADU.GetSubTree

Returns all names and values in the subcontainer named

 

by name.

46 Agent Data Unit Server Programmer’s Guide

Image 46
Contents Avaya Interaction Center Acknowledgment Contents Contents Agent Data Unit Server Programmer’s GuideContacting Technical Support Before YOU BeginTypographical Conventions Font Type MeaningReadme File Product DocumentationElectronic Documentation Issue 1.0 June 2002 Educational ServicesEducational Services Printed DocumentationAgent Data Unit Server Programmer’s Guide Chapter ADU Server Start-up ProceduresOverview Cooperation of ADU Servers ADU ServerADU Lifecycle Chapter Agent Data UnitDefinition of an ADU ADU CreationADU Termination Listing Active ADUsAgent Data Unit ADU Data Table Bytes Example Description ContentsAduid AduidADU Contents Core ADU Fields ADU ContentsField Name Description Set By Description Set By Agent ADU FieldsSheet 1 Sheet 2 Sheet 3 Sheet 4 Voice Data ContainersValue Explanation Queue ADU Fields Following ADU fields are used by queues on Avaya ICContainers ContainersContainer Names and Special Tokens Containername .!loginid Limitations of Container SyntaxADU.Update VDU.Update Container ConfigurationsParameter Type Default Description ADU.Create VDU.CreateEDU Values written if tscon is set to true Agent Data Unit ADU Event Monitoring Chapter 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 OperatorsMonitoring Criteria Wildcards Boolean OperatorsWildcard Definition Example Monitoring Criteria Examples Criteria Example DescriptionEvent Monitoring Agent Data Unit Server Programmer’s Guide Chapter Alarms Priority Description Cause/Recommended ActionAlarms System Considerations Chapter ADU Server ConfigurationConfiguration Parameters 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 Method Objectives Chapter ADU Server MethodsException Information Method Overview Routing RequestsADU Server Methods Method Overview ADU.Assign MethodsADU.Create ADU.DeleteOneValue ADU.DeassignADU.Deassign ADU.DeleteSubTree ADU.DeleteValuesADU.Find ADU.EventsInADU.EventsIn ADU.FindByKey Locate an ADU having a key containingADU.ForwardEvent ADU.FindOrCreateADU.ForceTerminate ADU.FindOrCreateADU.GetActive ADU.GetOneValueADU.GetSubTree ADU.GetSomeValuesADU.GetSomeValues ADU.GetValues ADU.GetValueHistoryADU.GetValuesHistory ADU.GetValuesHistoryFirst value that was set was truth ADU.Monitor ADU.IncrValueADU.IncrValue ADU.RemoteWatcher ADU.SetAndTerminateADU.SetAndTransfer ADU.SetDefaultHistoryFilterADU.SetAndTransfer ADU.SetHistoryFilter Hsnostart Hsnochange Hsnotransfer Hsnouser HsnodeleteADU.SetOneValue ADU.SetOneValueADU.SetValues ADU.SetValuesExtendedADU.Terminate ADU.SuspendADU.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