Avaya DXX-1015-01 manual ADU.FindByKey, Locate an ADU having a key containing

Page 52

Chapter 7 ADU Server Methods

Input Parameters

search_criteria

Criteria to be used for the search, consisting of names and values. If

 

values contain spaces or anything other than letters and numbers, they

 

must be enclosed in double quotes. If the value contains a \ or "

 

character it must be quoted by a \ character.

scope

Can be one of the following. Note that the "no_os" designation is for

 

consistency with the EDU Server.

 

ADU_NO_OS

Check the local ADU Server only.

 

ADU_NET_NO_OS

Check the WAN ADU Servers but

 

 

no Object Stores.

Output Parameters

matches

List of ADUIDs meeting the search criteria. Note that an empty list is

 

considered valid and returns VESP_SUCCESS.

Returns

VESP_SUCCESS Request was successful.

ADU.FindByKey

IDL Syntax ORBStatus FindByKey( in string name, in string value, out ADU_ID aduid ) ;

Description This method finds one active local ADU based on a single search criterion, or key. Each ADU contains at least one unique element, typically the login ID.

FindByKey() searches only the local ADU Server for active ADUs.

Input Parameters

name

Search key to find ADU.

value

Value to match if name is found.

Output Parameters

aduid

Agent Data Unit Identifier.

Returns

VESP_SUCCESS Request was successful.

C Program Example

Locate an ADU having a key containing 1137.

52 Agent Data Unit Server Programmer’s Guide

Image 52
Contents Avaya Interaction Center Acknowledgment Contents Contents Agent Data Unit Server Programmer’s GuideBefore YOU Begin Typographical ConventionsContacting Technical Support Font Type MeaningReadme File Product DocumentationElectronic Documentation Educational Services Educational ServicesIssue 1.0 June 2002 Printed DocumentationAgent Data Unit Server Programmer’s Guide Chapter ADU Server Start-up ProceduresOverview Cooperation of ADU Servers ADU ServerChapter Agent Data Unit Definition of an ADUADU Lifecycle ADU CreationADU Termination Listing Active ADUsAgent Data Unit Bytes Example Description Contents AduidADU Data Table 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 SyntaxContainer Configurations Parameter Type Default DescriptionADU.Update VDU.Update 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 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 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.FindOrCreate ADU.ForceTerminateADU.ForwardEvent 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