Avaya DXX-1015-01 ADU.SetHistoryFilter, Hsnostart Hsnochange Hsnotransfer Hsnouser Hsnodelete

Page 62

Chapter 7 ADU Server Methods

This method allows the caller to specify which types of events are saved when ADUs are sent to the server named in the eventsink configuration parameter. The filter takes effect in subsequently created ADUs, not existing ones. All events generated for all subsequent ADUs are checked against the permissions in the bits set in the mask argument. Events already generated are not affected.

The SetHistoryFilter()method can be used to override the default filter for individual ADUs.

The bits are defined in the file generic.idl as:

HS_NOSTART HS_NOCHANGE HS_NOTRANSFER HS_NOUSER HS_NODELETE

(unsigned short)0x01 Do not record new events (unsigned short)0x02 Do not record change events (unsigned short)0x04 Do not record transfer events (unsigned short)0x08 Do not record user-defined events (unsigned short)0x10 Do not record delete events

End events (ADU.End) cannot be filtered out. They must be included in the stored ADUs. Data elements in the End event can be filtered with the aduhskeepname configuration parameter.

ADU.SetHistoryFilter

IDL Syntax ORBStatus SetHistoryFilter( in ADU_ID aduid, in unsigned long mask ) ;

Description This method allows the caller to specify which types of events are saved when an individual ADU is sent to the server set with the eventsink configuration parameter, overriding the default history filter for one ADU. The filter takes effect immediately. All subsequent events generated are checked against the permissions in the bits set in the mask argument. Events already generated are not affected.

The bits are defined in the file vespidl.idl as:

HS_NOSTART HS_NOCHANGE HS_NOTRANSFER HS_NOUSER HS_NODELETE

(unsigned short)0x01 Do not record new events (unsigned short)0x02 Do not record change events (unsigned short)0x04 Do not record transfer events (unsigned short)0x08 Do not record user-defined events (unsigned short)0x10 Do not record delete events

The end event (ADU.End) cannot be filtered out. It must be included in the stored ADU. Data elements in the End event can be filtered with the aduhskeepname configuration parameter.

Input Parameters

aduid

Agent Data Unit Identifier.

mask

Permission bits to be set.

62 Agent Data Unit Server Programmer’s Guide

Image 62
Contents Avaya Interaction Center Acknowledgment Contents Contents Agent Data Unit Server Programmer’s GuideContacting Technical Support Before YOU BeginTypographical Conventions Font Type MeaningElectronic Documentation Product DocumentationReadme File Issue 1.0 June 2002 Educational ServicesEducational Services Printed DocumentationAgent Data Unit Server Programmer’s Guide Overview Start-up ProceduresChapter ADU Server Cooperation of ADU Servers ADU ServerADU Lifecycle Chapter Agent Data UnitDefinition of an ADU ADU CreationAgent Data Unit Listing Active ADUsADU Termination ADU Data Table Bytes Example Description ContentsAduid AduidADU Contents Field Name Description Set By ADU ContentsCore ADU Fields Sheet 1 Agent ADU FieldsDescription Set By Sheet 2 Sheet 3 Value Explanation Voice Data ContainersSheet 4 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 Description Message Chapter Event MonitoringADU Event Monitoring Starting and Stopping Event Monitoring Event MonitoringMonitoring Criteria Syntax Setting Event Monitoring CriteriaSetting Event Monitoring Criteria Example ADU.Assign loginid=Joe & ts.1.s=wrapup Symbol Definition Description Relational OperatorsWildcard Definition Example Boolean OperatorsMonitoring Criteria Wildcards 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 Exception Information Chapter ADU Server MethodsMethod Objectives ADU Server Methods Routing RequestsMethod Overview Method Overview ADU.Create MethodsADU.Assign ADU.Deassign ADU.DeassignADU.DeleteOneValue ADU.DeleteSubTree ADU.DeleteValuesADU.EventsIn ADU.EventsInADU.Find ADU.FindByKey Locate an ADU having a key containingADU.ForwardEvent ADU.FindOrCreateADU.ForceTerminate ADU.FindOrCreateADU.GetActive ADU.GetOneValueADU.GetSomeValues ADU.GetSomeValuesADU.GetSubTree ADU.GetValues ADU.GetValueHistoryADU.GetValuesHistory ADU.GetValuesHistoryFirst value that was set was truth ADU.IncrValue ADU.IncrValueADU.Monitor ADU.RemoteWatcher ADU.SetAndTerminateADU.SetAndTransfer ADU.SetDefaultHistoryFilterADU.SetAndTransfer ADU.SetHistoryFilter Hsnostart Hsnochange Hsnotransfer Hsnouser HsnodeleteADU.SetOneValue ADU.SetOneValueADU.SetValues ADU.SetValuesExtendedADU.Suspend ADU.SuspendADU.Terminate 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