English dropdown-ico

Avaya DXX-1015-01 manual

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

Go to page of

Similar user manuals

A good user manual

The rules should oblige the seller to give the purchaser an operating instrucion of Avaya DXX-1015-01, along with an item. The lack of an instruction or false information given to customer shall constitute grounds to apply for a complaint because of nonconformity of goods with the contract. In accordance with the law, a customer can receive an instruction in non-paper form; lately graphic and electronic forms of the manuals, as well as instructional videos have been majorly used. A necessary precondition for this is the unmistakable, legible character of an instruction.

What is an instruction?

The term originates from the Latin word „instructio”, which means organizing. Therefore, in an instruction of Avaya DXX-1015-01 one could find a process description. An instruction's purpose is to teach, to ease the start-up and an item's use or performance of certain activities. An instruction is a compilation of information about an item/a service, it is a clue.

Unfortunately, only a few customers devote their time to read an instruction of Avaya DXX-1015-01. A good user manual introduces us to a number of additional functionalities of the purchased item, and also helps us to avoid the formation of most of the defects.

What should a perfect user manual contain?

First and foremost, an user manual of Avaya DXX-1015-01 should contain:
- informations concerning technical data of Avaya DXX-1015-01
- name of the manufacturer and a year of construction of the Avaya DXX-1015-01 item
- rules of operation, control and maintenance of the Avaya DXX-1015-01 item
- safety signs and mark certificates which confirm compatibility with appropriate standards

Why don't we read the manuals?

Usually it results from the lack of time and certainty about functionalities of purchased items. Unfortunately, networking and start-up of Avaya DXX-1015-01 alone are not enough. An instruction contains a number of clues concerning respective functionalities, safety rules, maintenance methods (what means should be used), eventual defects of Avaya DXX-1015-01, and methods of problem resolution. Eventually, when one still can't find the answer to his problems, he will be directed to the Avaya service. Lately animated manuals and instructional videos are quite popular among customers. These kinds of user manuals are effective; they assure that a customer will familiarize himself with the whole material, and won't skip complicated, technical information of Avaya DXX-1015-01.

Why one should read the manuals?

It is mostly in the manuals where we will find the details concerning construction and possibility of the Avaya DXX-1015-01 item, and its use of respective accessory, as well as information concerning all the functions and facilities.

After a successful purchase of an item one should find a moment and get to know with every part of an instruction. Currently the manuals are carefully prearranged and translated, so they could be fully understood by its users. The manuals will serve as an informational aid.

Table of contents for the manual

  • Page 1

    A v aya™ Interaction C enter Rel ease 6.0 Agent D ata U nit Server Progr ammer’s G ui d e D XX - 10 15 -0 1 Issue 1.0 Ju ne 2 002[...]

  • Page 2

     2002, Avaya I nc. All R i ghts Re served Not i ce Eve r y e ffor t w as ma de to ensur e t h at the infor mation in this book w as compl e te and a ccurat e at th e time of pr inti ng. Howev er , in form ation is su bject t o chang e. Preventin g T ol l Fraud “T ol l fr aud” is the u nauth oriz ed use o f your telecom mun i ca tions syste m[...]

  • Page 3

    3 B EF ORE Y OU B EG IN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 1T HE AD U S ERV ER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 S[...]

  • Page 4

    4 A ge n t D a ta U n it S er ve r P rog ra mme r’ s G u i d e Con ten ts Set ti ng E vent Monit oring Cri t eri a . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Monitoring Criteria: Syn ta x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Relational Operator[...]

  • Page 5

    5 B EF OR E Y OU B EG IN T ypographical Conventions This guide uses the following font conventions : Not es, Tips, a nd Cau tions No t e : A note c a lls a ttention to impor ta nt inf ormation. Tip : A tip offe r s add i tional how-to advic e. Cau t ion : A c a uti on points out a c ti ons t ha t may le ad t o da ta loss or othe r s erious problems[...]

  • Page 6

    6 A ge n t D a ta U n it S er ve r P rog ra mme r ’ s Gu ide 3 N ot e the sequence of e vents t ha t led to the problem and the e xac t messages displayed. Ha ve the A vaya doc um ent ation avai l abl e. 4 If you c ontinue to have a problem, conta ct A vaya T e chnical Support by: L ogging in to t he A va ya T echnical Suppor t W e b site ( htt p[...]

  • Page 7

    Educ ational Ser vi c es Issue 1. 0 June 2002 7 P ri nted Doc um e ntati on Y ou can pur c hase pr inted c opies of the s e manua ls s e parately . For de t a ils, s e e on the ba c k of this manu a l’s title pa ge . License to P r i nt t he El ectroni c D ocume nt ati on Online c opies of documentation a r e included on the CD - ROM that accompa[...]

  • Page 8

    8 A ge n t D a ta U n it S er ve r P rog ra mme r ’ s Gu ide[...]

  • Page 9

    9 C HAP T E R 1 T HE AD U S ER VER Overview The Age nt Data Unit (A D U) Server i s responsible for tracking the state of age nts at the contact cen t e r . Agen ts ar e also r eferr ed to a s custom e r s e r vi ce repr ese ntat ives, or CSRs . T he ter m “ ag ent ” is used thr oughout this book to s ignif y a c us tomer s e r vic e repr esent[...]

  • Page 10

    Cha pter 1 The AD U Se r ve r 10 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e Cooperation of ADU Servers W h e n a n e w A DU S e r v e r i s a dd e d t o A v a y a I C , e x i s ti n g ADU S e r v e r s m u s t b e m a d e a w a r e o f t h e n e w s e r v e r t h r ough u s e of t he I C M a n a g e r . R e f e r t o I C A d m i n [...]

  • Page 11

    11 C HAP T E R 2 T HE A GEN T D ATA U NI T Definition of an ADU When a n agent logs in to A vaya IC for the fi rs t time , a rec ord ca lle d an A gen t Data Unit ( AD U ) is create d. T he ADU c ontains informa t ion about t he age nt ’ s a c tiviti e s dur ing the s essio n. A t y p i c a l ADU might conta i n the time the agent logged in , the[...]

  • Page 12

    Cha pter 2 Th e Age n t Dat a Uni t 12 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e Any appl ication that wa nts t o inter a ct wit h an ADU has to r eque s t it b y its uniqu e identi f ier , the AD U I D. U pon reque s t, the A DU Server pa s ses the A DUID out to other proce s s es , thus enabling ap pl ic ations t o r eque s t ac[...]

  • Page 13

    Th e AD UI D Issue 1. 0 June 2002 13 -u user na me to lo g in a s ( ofte n Ad min) -p pa s s wor d of us er No spa ce bet ween - x and t he text that fol lows. E xam ple: li stad u -iB oston ADU -uAdm in -p Daph nie Ther e ar e def aults f or all of thes e , but if a login error oc c ur s, alwa ys specify -u a nd -p. The ADUID W hen a n ADU is crea[...]

  • Page 14

    Cha pter 2 Th e Age n t Dat a Uni t 14 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e N a mes a re r e s tri c ted to non-em pty st rings of les s than 35 c harac te r s . (Container na me s may c ont ain mor e th an 35 ch aract e r s . Ref er to “ Co nt ainer Names a nd Speci a l T okens, ” on pa ge 22 for infor ma tion on contain[...]

  • Page 15

    AD U Co n te nt s Issue 1. 0 June 2002 15 Core AD U Fi e lds T he f ollowi ng ADU f ields are use d by bot h age nts a nd que ues on A vaya IC. Field Name Description Set By adu_id A string that uniquely identifies the A DU. ADU Server createtime The date and time the ADU was c reated in yyyy-mm-dd hh:mm:s s format. ADU Server createtimet The time_[...]

  • Page 16

    Cha pter 2 Th e Age n t Dat a Uni t 16 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e Age nt ADU Fie ld s T he f oll owing ADU fields a r e used by agents on A va ya I C. Field Name Description Set By auxwork.< m> .det ail A code that describes the reason that the agent entered this st ate. Blender Server auxwork.< m> .end [...]

  • Page 17

    AD U Co n te nt s Issue 1. 0 June 2002 17 < media> .cont actsoffered The tot al number of cont acts that arrived since the agent logged into this medi a channel. IC Manager computes ha ndled cont acts by taking the diff erence between < media> .cont actsoffered and < media> .abandoned. Media Connector Server < media> .curren[...]

  • Page 18

    Cha pter 2 Th e Age n t Dat a Uni t 18 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e < media> .< n> .st ate The current media cont act state. Normalized cont act states are: Alerting Active On-Hold Wrap-up Completed Media Connector Server < media> .< n> .st ate.< state> . st arttime The time that the medi[...]

  • Page 19

    AD U Co n te nt s Issue 1. 0 June 2002 19 V o ic e Dat a Containe rs The f ollowing table lis ts t he ca ll c ontaine r s in which e nd point e ve nts a nd attr ibutes a r e s tored. X r epr es ents the un iq ue ident ifi cation num be r for each end p oi nt . Y and Z r epr ese nt se quen ce numbers w ithin e ach end point ’ s ac ti vities. N o t[...]

  • Page 20

    Cha pter 2 Th e Age n t Dat a Uni t 20 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e Queue ADU Fields T he f oll owing ADU fields a r e used by queues on A va ya IC . voice.X.leg_id unique id (UUID) Unique leg_id of the current leg of the call. voice.X.loginid loginid Login id of clie nt at end point X. voice.X.origin phone number Pho[...]

  • Page 21

    C ont ai ners Issue 1. 0 June 2002 21 Cont ainers A c ontainer is a gr ouping of value s under a c ommon name. C ont ainer s ar e t rees of da ta within an AD U. cont actsoffered The total number of contacts received by the queue. The number of handled cont acts is computed by IC Manager by t aking the difference between cont actsoffered and abando[...]

  • Page 22

    Cha pter 2 Th e Age n t Dat a Uni t 22 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e For example, w ithi n e a c h A DU, the T elephony S erver c reates a conta i n er c alled ts, a nd w ithin the ts conta ine r it crea t e s a s ubco nt ainer f or each of the agen t' s logi cal phones (ts.1, t s.2, a nd so on) . Each data item p[...]

  • Page 23

    C ont ai ners Issue 1. 0 June 2002 23 Lim i tat i o ns of Co nt a i n er Syntax The first token in a container nam e ca nnot be a s pec i a l toke n. W hen a * t oken has been us ed, s pe cial toke ns other than * c annot be subseque nt ly us e d. Note that some methods do not pe rm i t s ome tokens. M os t do no t support * an d some ( GetV a lu e[...]

  • Page 24

    Cha pter 2 Th e Age n t Dat a Uni t 24 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e Conta ine r C onfigurati ons The following T S conf iguration parameters were a gr e e d upon with r egards to containers: Fo ll owi ng ar e exa mpl es of the r esu lt s for a call s cenar io wher e a n agent rece i ves a queue c al l, hol d an d retr[...]

  • Page 25

    C ont ai ners Issue 1. 0 June 2002 25 ED U V alu es w ri tten if t scon is se t to t r u e: voice.1.loginid voice.1.leg_id voice.1.agent_key voice.1.destination voice.1.origin voice.1.direction voice.1.connect voice.1.hold time voice.2.loginid voice.2.leg_id voice.2.agent_key voice.2.destination voice.2.origin voice.2.direction voice.2.connect voic[...]

  • Page 26

    Cha pter 2 Th e Age n t Dat a Uni t 26 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e ADU a nd E D U val u es w ri tt en i f co ntai ne rs_ 56_ styl e i s set t o t r ue : ADU a n d ED U V a lues wri t ten i f con tain ers _60 _sty le is se t to t ru e: voice.1.st ate (value= "alerting") voice.1.st ate.alerting.starttime voic[...]

  • Page 27

    27 C HAP T E R 3 E VE N T M ON I TO R IN G ADU Event Monitoring T his ch apter de s cr ibes the ev en t s tha t ar e se nt by t he AD U Ser ver . T his chapt er also ex pl ains how to ass ign a reques t on behalf of a client a nd how to esta bl ish monit ori ng c r iteri a. The ADU Serve r continuous l y monitor s the contents of ADUs for changes, [...]

  • Page 28

    Cha pt er 3 Event Mon itorin g 28 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e W hen a clie nt f irst a ssigns mon itor ing c rit e r ia to the s e r ver: A l l existing ADUs a r e chec ked to see if a ny match th e s pec i ficati on. All subs equently cre a ted A DUs are c hecked f or a mat ch. A ny AD U s tha t do m a tch the crite[...]

  • Page 29

    Setti ng Eve nt Moni tori ng Cri teri a Issue 1. 0 June 2002 29 As signing t o t he ADU S e r ve r and moni tor i ng an AD U do not a dd a c lient's na me to th e int er na l list of A DU-m odifying c lients. ( T he internal l is t of c li ent s i s de s cribed in “ ADU T e r mina tion, ” on pa ge 12 .) As s igning allows the c lient to wa[...]

  • Page 30

    Cha pt er 3 Event Mon itorin g 30 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e Ex ampl e: ADU .Ass ign " login id=J oe & ts.1 .s=wr apup" In the above exam pl e, the client has ass igne d to t he ADU Server , as king it to w atch f or a ny AD U that contains the f ollowing two va l ues: “ Joe ” in t he field logini [...]

  • Page 31

    Setti ng Eve nt Moni tori ng Cri teri a Issue 1. 0 June 2002 31 T hi s a ss ign cr i te ria watches all E DUs in the sys t e m becau s e all E DU I Ds ar e l onger than empty s tr ings . C hange e vents that do not r e f lec t a c hange in t he loginid, a ny matching da ta. * , or any s ubcontaine r of the c all c ont ai ner a re also s uppres s ed[...]

  • Page 32

    Cha pt er 3 Event Mon itorin g 32 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e Boolean O perators B oolean comparisons tha t r e tur n e valua tions of t r ue or f a l se c a n be pe rformed be t w een two values. The t w o boolea n operator s a re des cribed below . Fo r exa mpl e: ts.1 .s=A vaila ble | ts. 1.s=W rapU p s elects a l[...]

  • Page 33

    Setti ng Eve nt Moni tori ng Cri teri a Issue 1. 0 June 2002 33 Monitori ng Crite ri a: E x a mpl e s T he f oll owing exam ples demo ns tra te how to ins tr uc t the server to moni tor ADUs that f ulf ill s pe cific c r iteria. As you c an s e e , there is flexibility in s pec ifying monitori ng c r iteria. Choose the method that best fits the cur[...]

  • Page 34

    Cha pt er 3 Event Mon itorin g 34 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e[...]

  • Page 35

    35 C HAP T E R 4 A LA R M S IC Ma na ge r provides s ys tem a d m inist r ation tools f or monitori ng al a r m eve nts . V isual and some t i me s audi tory al arm s (be eps) are t ri gger ed w henever t he sy stem d etect s pro bl ems th at r equi r e hum an in ter venti on, s uc h as s erv er f ail ure s . Alar ms are categ or ized as Em erg enc[...]

  • Page 36

    Cha pter 4 Al a rms 36 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e FailADUCon High Connection to < uuid> closed; n dropped watchers [reason] A connection to a rem ote server has failed. T he UUID of the remote server is reported, as is the number of clients that were assigned to the server . The reason is of ten ADU.ServerFai [...]

  • Page 37

    37 C HAP T E R 5 AD U S ER V ER C O NF IGUR AT ION System Considerations The M a x Ac tive Adus configur a ti on parameter , descr ibed be low , s hould be set with considerat i on for s ystem c ap ability. The n u m be r of ADUs tha t ca n be ef fecti vely handl ed by the ADU Serve r is proportional to the s yst em's ava ilable memory a nd pr[...]

  • Page 38

    Cha pt er 5 ADU S erver C onf ig uration 38 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e No User Interval (nouserinterval) Minimum nu mber of seconds an ADU may linger in memory when there are no users active for it. Default is 60 seconds. Minimum is 1 s econd, maximum is 90 minutes. Random Kill Interval (randomkillinterval) Maximum [...]

  • Page 39

    C onf ig uration Par am et ers Issue 1. 0 June 2002 39 DUS tore (dustore) Enables the use of the DUS tore Server . Check the check box to enable or uncheck to disable. DUS tore ADU Batch Size (maxkills) The maximum number of ADUs that are sent to the D UStore Server in one set. The minimum is 1 and the default is 60. Poll W ait (pollwait) Sets the [...]

  • Page 40

    Cha pt er 5 ADU S erver C onf ig uration 40 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e DUindex Info2 (duindex.info2) The name of one of the fields used to identify the ADU in the D UStore Server . U sed with the Find method. The default value is media. DUindex Info3 (duindex.info3) The name of one of the fields used to identify the[...]

  • Page 41

    C onf ig uration Par am et ers Issue 1. 0 June 2002 41 T he fol lowi ng conf igura ti on par a meters are not pr es ented on t he ADU tab i n I C M ana ger. Y ou can set them on the Con fi g t ab of the ADU S e r ve r Editor di alog. Name Description filter (filter) Set s the filter for determining which ADU even ts are sent to the HISTMAP server ([...]

  • Page 42

    Cha pt er 5 ADU S erver C onf ig uration 42 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e T he fol l ow i ng s e tt i ngs a re on t he D e bug tab of the ADU Server Editor. N o te : Pr evious versions of A va ya IC included the AD U H is tor y Server . T o s upport exist ing install ation s , s end the e vents to an existing ADU Histo[...]

  • Page 43

    43 C HAP T E R 6 IDL S PE C I FIC ATI ON T he In ter face Def ini tion L a ngua ge (I DL) is defined wit hin C OR BA s tandards. I t is us ed to c r eat e interfaces tha t are c alled by client obj e cts and pr ovided by obj e c t implementa t ions . The f ollowing i s the IDL descript ion of the ADU Server . The vi rtual inter fac e is inhe r ited[...]

  • Page 44

    Cha pt er 6 IDL S peci f i cat i o n 44 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e OR BSta tus S etVal uesE xtend ed( i n st ring vdu_i d, i n Seq Coup le da ta, ou t Se qStri ng ne wnam es ); OR BSta tus D elete Valu es( i n str ing vdu_i d, in Seq Strin g na mes ) ; OR BSta tus D elete OneV alue( in s trin g vdu _id, in s tring n[...]

  • Page 45

    45 C HAP T E R 7 AD U S ER V ER M ETHOD S Method Objectives Clients r equest A vaya IC s ervers to pe r form vari ous functions by is s uing s erver-speci f ic me thod invocations. T he se methods be have in a sim ila r fas hion ac ros s all server s . For e xample, whe n you invoke a ny of the various ADU Server Set me thods , existing value s a r[...]

  • Page 46

    Cha pt er 7 ADU S erver M ethods 46 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e Y ou a r e not a s erver C annot find subc ontaine r f o r that owner Fir st token mus t be norm al here N o ma tch (or ill e ga l usage ) C annot a cces s in vali dated m ember Routing Request s In a n environment with s eve ral A DU Servers, a ny metho[...]

  • Page 47

    M ethod Ov erv iew Issue 1. 0 June 2002 47 ADU.GetUserSessions Returns the sessions of all clients b elieved to have an interest in the ADU. ADU.GetV alues Retrieves all of the values of an ADU. ADU.GetV alueHistory Returns everything that is known about the named field' s values in an ADU. ADU.GetV aluesHistory Returns everything that is know[...]

  • Page 48

    Cha pt er 7 ADU S erver M ethods 48 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e Methods The f ollowing se c t ions de s cribe the AD U Server me t hods. ADU.As sign IDL Syn t ax OR BSta tus A ssign ( in stri ng mo nito rcrit eria ) ; Descr ipt i on C re ate a s es s ion w it h th e AD U Ser ver . Whe n a se ssion i s cr eated, e ven[...]

  • Page 49

    AD U. Dea ssig n Issue 1. 0 June 2002 49 Ou t p ut Pa ram et ers Ret u rns C Pr og ra m E xam ple _I DL_S EQUEN CE_Co uple *seq _coup le; AD U_ID adui d; /* rec eives the id o f the crea ted ADU * / /* Cre ate s pace for value s */ se q_co uple = ves p_co uple_ seq_c reat e(); /* fil l in the f ield for the n ew A DU en try * / ve sp_c ouple _seq_ [...]

  • Page 50

    Cha pt er 7 ADU S erver M ethods 50 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e If us ed w ith a conta iner na m e ( “ a.b ” ), you only delete that one name , a .b. H ow ever , the A DU Server m e t hods a r e not able to address na mes “ below ” that point. Alt hough a. b. c ma y s till exist, the ADU Server c anno t fi nd[...]

  • Page 51

    ADU .E ven t sI n Issue 1. 0 June 2002 51 ADU.E ve ntsIn IDL Syn t ax ON EWAY Even tsIn( in s tring vdu_ id, in Se qEven t ev ents) ; Descr ipt i on T his f unc ti on adds a user - de f ine d ADU event to a n ADU. V alues in the A DU a r e update d to r efl ect the na me s and va lues i n the ev ent. I n p u t P ara me t e rs Ret u rns No retur n v[...]

  • Page 52

    Cha pt er 7 ADU S erver M ethods 52 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e I n p u t P ara me t e rs Ou t p ut Pa ram et ers Ret u rns ADU.Fi ndBy Ke y IDL Syn t ax OR BSta tus F indBy Key( in s tring nam e, in stri ng v alue, out ADU_ ID ad uid ) ; Descr ipt i on T his method finds one ac tive loca l A DU based on a s i ngl e [...]

  • Page 53

    A DU.Fi ndO rCr eate Issue 1. 0 June 2002 53 st atus = Ve sp_Re ques t( "A DU.Fi ndBy Key", call back , 0x2 132, ses sion , "ke y", " 1137 ", &a duid ); ADU.Fi ndOr Cre ate IDL Syn t ax OR BSta tus F indOr Crea te( i n Seq Coup le ma tch, in S eqCou ple, oncr eate, out stri ng vd u_id ) ; Descr ipt i on T his metho[...]

  • Page 54

    Cha pt er 7 ADU S erver M ethods 54 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e Descr ipt i on T his method is res er ve d. ADU S erve r s use thi s m ethod to pass e vents to each ot her . Cli ent ap pl ic ations s hould not c all thi s me t hod . AD U.Ge t Act iv e IDL Syn t ax OR BSta tus G etAct ive( out SeqAD U_ID adus eq ) ; D[...]

  • Page 55

    AD U. G et Som eV alu e s Issue 1. 0 June 2002 55 Ret u rns C Pr og ra m E xam ple Get the va lue of “ myfav ori te ele men t ” f rom t h e A D U na me d by a duid. ch ar * value ; st atus = Ve sp_Re ques t( "A DU.Ge tOne Value ", ca llba ck, 0 x213 2, se ssion , adu id, "myfa vorit eele ment" , &v alue ); A D U .Ge tS o[...]

  • Page 56

    Cha pt er 7 ADU S erver M ethods 56 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e Ou t p ut Pa ram et ers ADU.G et V alue s IDL Syn t ax OR BSta tus G etVal ues( in A DU_ID adu id, o ut Se qCou ple v alue s ) ; Descr ipt i on T his method retri eves all of the values of an ADU. I n p u t P ara me t e rs Ou t p ut Pa ram et ers Ret u r[...]

  • Page 57

    A DU.GetV aluesHi st ory Issue 1. 0 June 2002 57 I n p u t P ara me t e rs Ou t p ut Pa ram et ers Ret u rns AD U. G et V al u e sH is t or y IDL Syn t ax OR BSta tus G etVal uesH istor y( in ADU _ID a duid, in unsig ned long flags , o ut S eqLon g hea ders , out SeqS trin g nam es, o ut S eqSeq SeqSt ring valu es) ; Descr ipt i on Ge tV a lues His[...]

  • Page 58

    Cha pt er 7 ADU S erver M ethods 58 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e Fo r exa mpl e, f ie l d quar k wa s s et twi ce, once a t ADU cr eation ( 1 1:37: 00am, by S c ot t, to “ truth ” ) an d a ga i n at ADU trans f e r (11 :38: 00, by Ja ne, to “ ch a r m ” ) . Spe cif ying f la gs = AD U_GSGETTIM E | ADU_GSGE T V[...]

  • Page 59

    AD U. I n crV alu e Issue 1. 0 June 2002 59 AD U.Incr V a lue IDL Syn t ax OR BSta tus I ncrVa lue( in A DU_ID adu id, i n str ing name, in long incr, o ut s tring newv alue ) ; Descr ipt i on T his method is a us e f ul a lternative to using SetOne V alue a nd Ge tOneV alue to modif y a value when the re is a r is k tha t two applic a t io ns migh[...]

  • Page 60

    Cha pt er 7 ADU S erver M ethods 60 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e I n p u t P ara me t e rs Ret u rns ADU.Re m ote W a tc her IDL Syn t ax OR BSta tus R emote Watc her( in un sign ed lo ng ha ndle is, i n st ring cri) ; Descr ipt i on T his method is res er ved. Client applica tions s hould not ca ll this me thod. W he[...]

  • Page 61

    ADU. SetAn dTr ansf er Issue 1. 0 June 2002 61 ADU.S et AndT r ansfe r IDL Syn t ax OR BSta tus S etAnd Tran sfer( in A DU_I D adu id, i n st ring to, in S eqCou ple v alue s ) ; Descr ipt i on T his method combines S e t V a lues a nd T ra ns fer int o a single ca ll , a s thes e operations often oc cur to geth e r. If t he oper atio n suc ceeds ,[...]

  • Page 62

    Cha pt er 7 ADU S erver M ethods 62 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e Th is method a l lo ws t he c a l l e r to s pecify whic h types of events are saved when ADUs ar e s e nt to the s erv e r named in the ev entsi nk c onfiguratio n pa rame te r. T he fi lte r take s effec t in subs equently crea ted AD Us , not exis tin[...]

  • Page 63

    AD U .Set OneValu e Issue 1. 0 June 2002 63 Ret u rns C Pr og ra m E xam ple Ve sp_R eques t_Syn c( "A DU.S etHis toryF ilte r", /* m etho d ide ntif icati on */ &e v, /* e nvir onmen t po inter */ se ssio n, /* s essi on ob ject */ &r eque st, /* p ntr to pn tr t o req uest stru cture */ ad uid, /* a n AD U id */ HS _NOU SER /* T[...]

  • Page 64

    Cha pt er 7 ADU S erver M ethods 64 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e C Pr og ra m E xam ple /* Set one v alue. */ st atus = Ve sp_Re ques t( "A DU.Se tOne Value ", ca llba ck, 0 x213 2, se ssion , ad uid, "my_ favor ite_ eleme nt", "new valu e" ); ADU.S et V a lue s IDL Syn t ax OR BSta tus S[...]

  • Page 65

    AD U. Su s p end Issue 1. 0 June 2002 65 Thi s method i s us e f ul f or applica ti ons that ne e d to know how name s w ere genera t ed, e s pecially for ap pl ic ations tha t make repea te d use of t he + toke n and need to be ab l e to go b ack a nd f ill in value s in the va r ious subcontainers they h ave cr eated. The following f ields a r e [...]

  • Page 66

    Cha pt er 7 ADU S erver M ethods 66 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e I n p u t P ara me t e rs Ret u rns C Pr og ra m E xam ple st atus = Ve sp_Re ques t( "A DU.Te rmin ate", call back , 0x2 132, sess ion, adu id ) ; ADU.T er m in a teMi ne IDL Syn t ax vo id T ermin ateMi ne( ) ; Descr ipt i on W hen a clien t [...]

  • Page 67

    ADU. Transf er Issue 1. 0 June 2002 67 Ret u rns ADU.Transfe r IDL Syn t ax OR BSta tus T ransf er( in AD U_ID adui d, in stri ng t o ) ; Descr ipt i on T his method ge ner a tes an ADU.T ransfer e vent to any pr ocess monitor ing th e ADU, cha ng es the va l ue of the transfercount element a nd a dds t he new client to the ADU's lis t of int [...]

  • Page 68

    Cha pt er 7 ADU S erver M ethods 68 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e[...]

  • Page 69

    69 Sy mbol s (adudata. alarm. prior ity) 40 (adudata. data. onlyna me) 40 (adudata. event. ifnam e) 40 (adudata. eventname) 40 (adudata. perecnt) 39 (adus) 38 (checkpoint. interval) 37 (database) 38 (duindex. info1) 39 (duindex. info2) 40 (duindex. info3) 40 (duindex. lookup1) 39 (duindex. lookup2) 39 (dustore) 39 (filter) 41 (findcreatestoresea rc[...]

  • Page 70

    70 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e In de x ADU. SetHistoryFilter 62 ADU. SetOneValue 63 ADU. SetValues 64 ADU. SetValuesExtended 64 ADU. Terminate 65 ADU. TerminateMine 66 ADU. Transfer 67 ADU Server, overview 9 ADU. Assign 48 ADU. change 27 ADU. Create 48 ADU. Deassign 49 ADU. delete 27 ADU. DeleteOneValue 49 ADU. Delet[...]

  • Page 71

    Issue 1. 0 June 2002 71 Ind e x D Data Element Names 39 Database 38 database 38 Deassign method 49 Deassign method, to stop monitoring 28 DeleteOneValue method 49 DeleteSubTree method 50 DeleteValues method 50 DUindex Info1 39 DUindex Info2 40 DUindex Info3 40 DUindex Lookup1 39 DUindex Lookup2 39 duindex. info1 39 duindex. info2 40 duindex. info3 [...]

  • Page 72

    72 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e In de x Memory, use of 37 Methods, overview list o f 46 minimumagents 21 modifier 18 Monitor method 59 Multiple database serv ers, use of 42 N Name/value pairs, defined 14 No User Interval 38 NoEventSink 36 NoMeInDS 36 nouserinterval 38 Number of Cached Adu events 39 Number of fields 38[...]

  • Page 73

    Issue 1. 0 June 2002 73 Ind e x V Victims 36 voice. 1. state 26 voice. 1. state. alerting. s tarttime 26 voice. 1. state. disconnected.starttime 26 voice. 1. state. hold. startti me 26 voice. 1. state. incall. star ttime 26 voice. 2. state 26 voice. 2. state. incall. star ttime 26 voice. acdname 19 voice. connector 19 voice. connectorname 19 voice.[...]

  • Page 74

    74 Age n t Dat a Uni t Se rve r Pr ogr a mm e r ’ s G ui d e In de x[...]