The following is a brief description of the methods available for use with the EDU Server.
VDU.Assign Create a session with the EDU Server.
VDU.Create Create a new EDU.
VDU.CreateExtended Create a new EDU and return the time that the EDU was created.
VDU.Deassign Destroy a session with an EDU Server.
VDU.DeleteOneValue This is equivalent to DeleteValues with a single name. VDU.DeleteSubTree DeleteOneValue on the given name and every name in the
subcontainer beneath it, cutting a branch from the tree a container represents.
VDU.DeleteValues Given a list of names, this method removes from the EDU the name and its value history, in effect making the EDU smaller.
VDU.EventsIn Adds a user-defined EDU event to an EDU.
VDU.Find Returns a list of EDUIDs that match a simple criterion.
VDU.FindByKey Finds one active local EDU based on a single search criterion. VDU.FindExtended Identical to the Find method, but for each EDU found, it returns
an EDUID and values that are indexed by the Object Store. VDU.ForceTerminate Forces the EDU object to be deleted from memory and from the
database both, so it can no longer be used.
VDU.ForwardEvent Reserved.
VDU.GetActive Finds all the active EDUs at the time the call is made.
VDU.GetOneValue Retrieves one value from an EDU.
VDU.GetSomeValues Returns all names and values matching a container name.
VDU.Assign
Issue 1.0 June 2002 51
VDU.Assign
IDL Syntax ORBStatus Assign( in string monitorcriteria ) ;
Description Create a session with the EDU Server. When a session is created, events are sent to the Avaya IC client.
VDU.GetSubTree Returns all names and values in the subcontainer named by name.
VDU.GetUserSessions Returns the sessions of all clients believed to have an interest in the EDU.
VDU.GetValues Retrieves all of the values of an EDU.
VDU.GetValueHistory Returns everything that is known about the named field's values in an EDU.
VDU.GetValuesHistory Returns everything that is known about all values in an EDU. VDU.IncrValue A useful alternative to using SetOneValue and GetOneValue to
modify a value when there is a risk that two applications might conflict.
VDU.Monitor Changes Assign criteria.
VDU.RemoteWatcher Reserved.
VDU.SetAndTerminate Combines a SetValues and a Terminate.
VDU.SetAndTransfer Combines SetValues and Transfer into a single call, as these operations often occur together. (historical)
VDU.SetDefaultHistoryFilter Reserved.
VDU.SetHistoryFilter Allows the caller to specify which types of events are saved when an individual EDU is sent to the IC Repository, overriding the default history filter for one EDU.
VDU.SetOneValue Sets one EDU data element.
VDU.SetValues Sets one or more EDU data elements.
VDU.SetValuesExtended Performs a SetValues, but in addition returns a parallel list of names that it created while resolving container names. VDU.Terminate Removes the client's name from the list of interested parties for
one EDU.
VDU.TerminateMine Removes the client's name from the list of interested parties for all EDUs.
VDU.Touch Touches an EDU when it is called..
VDU.Transfer Historical.
Chapter 8 EDU Server Methods
The Assign() method ignores resurrected EDUs (ones brought back from the Object Store database).
When multiple EDU Servers are in use, Assigns watch all calls in the domain of the EDU Servers and notify the client with events when they occur. This makes Assign a relatively expensive operation. Clients should be designed so they only need to Assign once to specify the EDUs in which they are interested. Assigning to multiple EDU Servers is unnecessary and causes numerous problems. (Refer to “Cooperation of EDU Servers,” on page 12, for additional information.)
Input Parameters
Returns
C Program Example
status = Vesp_Assign_Request( "VDU.Assign", callback, user_data,
event_callback, session, "login=user" );
VDU.Create
IDL Syntax ORBStatus Create( in SeqCouple values, out VDU_ID vduid ) ;
Description This method creates a new EDU. This function is usually performed by the Telephony Server and is hidden from normal application development. The Telephony Server sets the creation timestamp and other information about the call.
Refer to Appendix A for a programming example of an asynchronous create.
Input Parameters
Output Parameters
monitorcriteria Information used to select EDUs for monitoring, consisting of name and value strings. If values contain anything other than letters and numbers (for example, spaces), they should be enclosed in double quotes, and \ or " characters must be quoted by a \ character. Refer to “Event Monitoring,” on page 25 for more information.
VESP_SUCCESS Request was successful
VESP_ERROR Request was unsuccessful
values Initial values of the EDU, not to exceed 1023 values.
VDU.CreateExtended
Issue 1.0 June 2002 53
Returns
C Program Example
_IDL_SEQUENCE_Couple *seq_couple;
VDU_ID vduid; /* receives the id of the created VDU */ /* Create space for values */
seq_couple = vesp_couple_seq_create();
/* fill in the field for the new VDU entry */ vesp_couple_seq_add_couple_values( seq_couple, "name1", "value1" ); vesp_couple_seq_add_couple_values( seq_couple, "name2", "value2" ); vesp_couple_seq_add_couple_values( seq_couple, "name3", "value3" ); /* Create the new VDU */
status = Vesp_Request( "VDU.Create", callback, 0x2132, session, seq_couple, &vduid );
vesp_couple_seq_delete( seq_couple );
VDU.CreateExtended
IDL Syntax ORBStatus CreateExtended( in SeqCouple values, out VDU_ID vduid, out string timet) ;
Description This method creates a new EDU and returns the time that the EDU was created. This function is usually performed by the Telephony Server and is hidden from normal application development. The Telephony Server sets the creation timestamp and other information about the call.
Input Parameters
Output Parameters
Returns
VESP_SUCCESS Request was successful
VESP_ERROR Internal error in EDU Server
values Initial values of the EDU, not to exceed 1023 values.
vduid Electronic Data Unit Identifier.
timet The time that the EDU was created.
VESP_SUCCESS Request was successful
Chapter 8 EDU Server Methods